Skip to content

Commit 660b95b

Browse files
Rename references to the PyMC3 master branch to main (#4742)
* Rename references to the PyMC3 master branch to main * Redirect some links in the doc
1 parent 84110de commit 660b95b

File tree

13 files changed

+38
-38
lines changed

13 files changed

+38
-38
lines changed

.github/workflows/arviz_compat.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: arviz-compatibility
33
on:
44
pull_request:
55
push:
6-
branches: [master]
6+
branches: [main]
77

88
jobs:
99
pytest:

.github/workflows/jaxtests.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: jax-sampling
33
on:
44
pull_request:
55
push:
6-
branches: [master]
6+
branches: [main]
77

88
jobs:
99
pytest:

.github/workflows/pre-commit.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: pre-commit
33
on:
44
pull_request:
55
push:
6-
branches: [master]
6+
branches: [main]
77

88
jobs:
99
pre-commit:

.github/workflows/pytest.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: pytest
33
on:
44
pull_request:
55
push:
6-
branches: [master]
6+
branches: [main]
77

88
jobs:
99
pytest:

.github/workflows/windows.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: windows
33
on:
44
pull_request:
55
push:
6-
branches: [master]
6+
branches: [main]
77

88
jobs:
99
pytest:

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The preferred workflow for contributing to PyMC3 is to fork the [GitHub reposito
4343
$ git checkout -b my-feature
4444
```
4545

46-
Always use a ``feature`` branch. It's good practice to never routinely work on the ``master`` branch of any repository.
46+
Always use a ``feature`` branch. It's good practice to never routinely work on the ``main`` branch of any repository.
4747

4848
4. Project requirements are in ``requirements.txt``, and libraries used for development are in ``requirements-dev.txt``. The easiest (and recommended) way to set up a development environment is via [miniconda](https://docs.conda.io/en/latest/miniconda.html):
4949

@@ -73,7 +73,7 @@ The preferred workflow for contributing to PyMC3 is to fork the [GitHub reposito
7373
After committing, it is a good idea to sync with the base repository in case there have been any changes:
7474
```bash
7575
$ git fetch upstream
76-
$ git rebase upstream/master
76+
$ git rebase upstream/main
7777
```
7878

7979
Then push the changes to your GitHub account with:

README.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. image:: https://cdn.rawgit.com/pymc-devs/pymc3/master/docs/logos/svg/PyMC3_banner.svg
1+
.. image:: https://cdn.rawgit.com/pymc-devs/pymc3/main/docs/logos/svg/PyMC3_banner.svg
22
:height: 100px
33
:alt: PyMC3 logo
44
:align: center
@@ -11,7 +11,7 @@ algorithms. Its flexibility and extensibility make it applicable to a
1111
large suite of problems.
1212

1313
Check out the `getting started guide <http://docs.pymc.io/notebooks/getting_started>`__, or
14-
`interact with live examples <https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks>`__
14+
`interact with live examples <https://mybinder.org/v2/gh/pymc-devs/pymc3/main?filepath=%2Fdocs%2Fsource%2Fnotebooks>`__
1515
using Binder!
1616
For questions on PyMC3, head on over to our `PyMC Discourse <https://discourse.pymc.io/>`__ forum.
1717

@@ -100,7 +100,7 @@ License
100100
=======
101101

102102
`Apache License, Version
103-
2.0 <https://github.com/pymc-devs/pymc3/blob/master/LICENSE>`__
103+
2.0 <https://github.com/pymc-devs/pymc3/blob/main/LICENSE>`__
104104

105105

106106
Software using PyMC3
@@ -129,7 +129,7 @@ Contributors
129129
============
130130

131131
See the `GitHub contributor
132-
page <https://github.com/pymc-devs/pymc3/graphs/contributors>`__. Also read our `Code of Conduct <https://github.com/pymc-devs/pymc3/blob/master/CODE_OF_CONDUCT.md>`__ guidelines for a better contributing experience.
132+
page <https://github.com/pymc-devs/pymc3/graphs/contributors>`__. Also read our `Code of Conduct <https://github.com/pymc-devs/pymc3/blob/main/CODE_OF_CONDUCT.md>`__ guidelines for a better contributing experience.
133133

134134
Support
135135
=======
@@ -158,20 +158,20 @@ Sponsors
158158
|ODSC|
159159

160160
.. |Binder| image:: https://mybinder.org/badge_logo.svg
161-
:target: https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks
161+
:target: https://mybinder.org/v2/gh/pymc-devs/pymc3/main?filepath=%2Fdocs%2Fsource%2Fnotebooks
162162
.. |Build Status| image:: https://github.com/pymc-devs/pymc3/workflows/pytest/badge.svg
163163
:target: https://github.com/pymc-devs/pymc3/actions
164-
.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc3/branch/master/graph/badge.svg
164+
.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc3/branch/main/graph/badge.svg
165165
:target: https://codecov.io/gh/pymc-devs/pymc3
166166
.. |Dockerhub| image:: https://img.shields.io/docker/automated/pymc/pymc3.svg
167167
:target: https://hub.docker.com/r/pymc/pymc3
168168
.. |NumFOCUS| image:: https://www.numfocus.org/wp-content/uploads/2017/03/1457562110.png
169169
:target: http://www.numfocus.org/
170-
.. |Quantopian| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/quantopianlogo.jpg
170+
.. |Quantopian| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/main/docs/quantopianlogo.jpg
171171
:target: https://quantopian.com
172172
.. |NumFOCUS_badge| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
173173
:target: http://www.numfocus.org/
174-
.. |ODSC| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/odsc_logo.png
174+
.. |ODSC| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/main/docs/odsc_logo.png
175175
:target: https://odsc.com
176176
.. |tidelift| image:: https://img.shields.io/badge/-lifted!-2dd160.svg?colorA=58595b&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAOCAYAAADJ7fe0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVhJREFUKBV1kj0vBFEUhmd2sdZHh2IlGhKFQuOviEYiNlFodCqtUqPxA%2FwCjUTnDygkGoVERFQaZFlE9nreO%2BdM5u5wkifvuee892Pu3CyEcA0DeIc%2B9IwftJsR6Cko3uCjguZdjuBZhhwmYDjGrOC96WED41UtsgEdGEAPlmAfpuAbFF%2BFZLfoMfRBGzThDtLgePPwBIpdddGzOArhPHUXowbNptE2www6a%2Fm96Y3pHN7oQ1s%2B13pxt1ENaKzBFWyWzaJ%2BRO0C9Jny6VPSoKjLVbMDC5bn5OPuJF%2BBSe95PVEMuugY5AegS9fCh7BedP45hRnj8TC34QQUe9bTZyh2KgvFk2vc8GIlXyTfsvqr6bPpNgv52ynnlomZJNpB70Xhl%2Bf6Sa02p1bApEfnETwxVa%2Faj%2BW%2FFtHltmxS%2FO3krvpTtTnVgu%2F6gvHRFvG78Ef3kOe5PimJXycY74blT5R%2BAAAAAElFTkSuQmCC
177177
:target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise

benchmarks/asv.conf.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
// project being benchmarked
1414
"repo": "..",
1515

16-
// List of branches to benchmark. If not provided, defaults to "master"
16+
// List of branches to benchmark. If not provided, defaults to "main"
1717
// (for git) or "tip" (for mercurial).
18-
"branches": ["master"],
18+
"branches": ["main"],
1919

2020
// The DVCS being used. If not set, it will be automatically
2121
// determined from "repo" by looking at the protocol in the URL

docs/source/about.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Sponsors
189189

190190
|NumFOCUS| |Quantopian| |ODSC|
191191

192-
More details about sponsoring PyMC3 can be found `here <https://github.com/pymc-devs/pymc3/blob/master/GOVERNANCE.md#institutional-partners-and-funding>`_.
192+
More details about sponsoring PyMC3 can be found `here <https://github.com/pymc-devs/pymc3/blob/main/GOVERNANCE.md#institutional-partners-and-funding>`_.
193193
If you are interested in becoming a sponsor, reach out to `[email protected] <[email protected]>`_
194194

195195
**************
@@ -266,9 +266,9 @@ See also
266266
.. |NumFOCUS| image:: https://numfocus.org/wp-content/uploads/2017/07/NumFocus_LRG.png
267267
:target: http://www.numfocus.org/
268268
:height: 120px
269-
.. |Quantopian| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/quantopianlogo.jpg
269+
.. |Quantopian| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/main/docs/quantopianlogo.jpg
270270
:target: https://quantopian.com
271271
:height: 120px
272-
.. |ODSC| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/odsc_logo.png
272+
.. |ODSC| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/main/docs/odsc_logo.png
273273
:target: https://odsc.com
274274
:height: 120px

docs/source/api/bounds.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Caveats
6666

6767
* Bounds cannot be given to variables that are ``observed``. To model
6868
truncated data, use a :func:`~pymc3.model.Potential` in combination with a cumulative
69-
probability function. See `this example notebook <https://github.com/pymc-devs/pymc3/blob/master/docs/source/notebooks/weibull_aft.ipynb>`_.
69+
probability function. See `this example notebook <https://docs.pymc.io/pymc-examples/examples/survival_analysis/weibull_aft.html>`_.
7070

7171
* The automatic transformation applied to continuous distributions results in
7272
an unnormalized probability distribution. This doesn't effect inference

docs/source/developer_guide.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Distribution
2323
A high-level introduction of ``Distribution`` in PyMC3 can be found in
2424
the `documentation <https://docs.pymc.io/Probability_Distributions.html>`__. The source
2525
code of the probability distributions is nested under
26-
`pymc3/distributions <https://github.com/pymc-devs/pymc3/blob/master/pymc3/distributions/>`__,
26+
`pymc3/distributions <https://github.com/pymc-devs/pymc3/blob/main/pymc3/distributions/>`__,
2727
with the ``Distribution`` class defined in `distribution.py
28-
<https://github.com/pymc-devs/pymc3/blob/master/pymc3/distributions/distribution.py#L23-L44>`__.
28+
<https://github.com/pymc-devs/pymc3/blob/main/pymc3/distributions/distribution.py#L23-L44>`__.
2929
A few important points to highlight in the Distribution Class:
3030

3131
.. code:: python
@@ -712,15 +712,15 @@ dictionary with the free\_RVs being sampled now has a new value (if
712712
accepted, see
713713
`here <https://github.com/pymc-devs/pymc3/blob/6d07591962a6c135640a3c31903eba66b34e71d8/pymc3/step_methods/compound.py#L27>`__
714714
and
715-
`here <https://github.com/pymc-devs/pymc3/blob/master/pymc3/step_methods/compound.py#L41>`__).
715+
`here <https://github.com/pymc-devs/pymc3/blob/main/pymc3/step_methods/compound.py>`__).
716716
There are some example in the `CompoundStep
717717
doc <https://docs.pymc.io/notebooks/sampling_compound_step.html#Specify-compound-steps>`__.
718718
719719
Transition kernel
720720
^^^^^^^^^^^^^^^^^
721721
722722
The base class for most MCMC sampler (except SMC) is in
723-
`ArrayStep <https://github.com/pymc-devs/pymc3/blob/master/pymc3/step_methods/arraystep.py>`__.
723+
`ArrayStep <https://github.com/pymc-devs/pymc3/blob/main/pymc3/step_methods/arraystep.py>`__.
724724
You can see that the ``step.step()`` is mapping the ``point`` into an
725725
array, and call ``self.astep()``, which is an array in, array out
726726
function. A pymc3 model compile a conditional logp/dlogp function that
@@ -764,7 +764,7 @@ The design of the VI module takes a different approach than
764764
MCMC - it has a functional design, and everything is done within Aesara
765765
(i.e., Optimization and building the variational objective). The base
766766
class of variational inference is
767-
`pymc3.variational.Inference <https://github.com/pymc-devs/pymc3/blob/master/pymc3/variational/inference.py>`__,
767+
`pymc3.variational.Inference <https://github.com/pymc-devs/pymc3/blob/main/pymc3/variational/inference.py>`__,
768768
where it builds the objective function by calling:
769769
770770
.. code:: python
@@ -789,7 +789,7 @@ Approximation, and Test functions to combine them into single objective
789789
function. Currently we do not care too much about the test function, it
790790
is usually not required (and not implemented). The other primitives are
791791
defined as base classes in `this
792-
file <https://github.com/pymc-devs/pymc3/blob/master/pymc3/variational/opvi.py>`__.
792+
file <https://github.com/pymc-devs/pymc3/blob/main/pymc3/variational/opvi.py>`__.
793793
We use inheritance to easily implement a broad class of VI methods
794794
leaving a lot of flexibility for further extensions.
795795
@@ -824,7 +824,7 @@ allows you to combine approximation into new approximation, but we will
824824
skip this for now and only consider ``SingleGroupApproximation`` like
825825
``MeanField``): The definition of ``datalogp_norm``, ``logq_norm``,
826826
``varlogp_norm`` are in
827-
`variational/opvi <https://github.com/pymc-devs/pymc3/blob/master/pymc3/variational/opvi.py>`__,
827+
`variational/opvi <https://github.com/pymc-devs/pymc3/blob/main/pymc3/variational/opvi.py>`__,
828828
strip away the normalizing term, ``datalogp`` and ``varlogp`` are
829829
expectation of the variational free\_RVs and data logp - we clone the
830830
datalogp and varlogp from the model, replace its input with Aesara
@@ -859,10 +859,10 @@ Some challenges and insights from implementing VI.
859859
on this feature. Internal usages are uncountable:
860860
861861
- we use this to `vectorize the
862-
model <https://github.com/pymc-devs/pymc3/blob/master/pymc3/model.py#L972>`__
862+
model <https://github.com/pymc-devs/pymc3/blob/main/pymc3/model.py#L972>`__
863863
for both MCMC and VI to speed up computations
864864
- we use this to `create sampling
865-
graph <https://github.com/pymc-devs/pymc3/blob/master/pymc3/variational/opvi.py#L1483>`__
865+
graph <https://github.com/pymc-devs/pymc3/blob/main/pymc3/variational/opvi.py#L1483>`__
866866
for VI. This is the case you want posterior predictive as a part
867867
of computational graph.
868868

docs/source/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110

111111
<div class="ui vertical segment">
112112
<h2 class="ui dividing header">License</h2>
113-
<p>PyMC3 is licensed <a href="https://github.com/pymc-devs/pymc3/blob/master/LICENSE">under the Apache License, V2.</a></p>
113+
<p>PyMC3 is licensed <a href="https://github.com/pymc-devs/pymc3/blob/main/LICENSE">under the Apache License, V2.</a></p>
114114
</div>
115115

116116
<div class="ui vertical segment">
@@ -140,12 +140,12 @@
140140
</div>
141141
<div class="column">
142142
<a href="https://quantopian.com">
143-
<img class="ui image" height="120" src="https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/quantopianlogo.jpg"/>
143+
<img class="ui image" height="120" src="https://raw.githubusercontent.com/pymc-devs/pymc3/main/docs/quantopianlogo.jpg"/>
144144
</a>
145145
</div>
146146
<div class="column">
147147
<a href="https://odsc.com/">
148-
<img class="ui image" height="120" src="https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/odsc_logo.png"/>
148+
<img class="ui image" height="120" src="https://raw.githubusercontent.com/pymc-devs/pymc3/main/docs/odsc_logo.png"/>
149149
</a>
150150
</div>
151151
</div>

docs/source/semantic_sphinx/layout.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
<div class="ui container">
5555
<div class="ui large secondary pointing menu">
5656
<a class="item" href="/">
57-
<img class="ui bottom aligned tiny image" src="https://cdn.rawgit.com/pymc-devs/pymc3/master/docs/logos/svg/PyMC3_banner.svg" />
57+
<img class="ui bottom aligned tiny image" src="https://cdn.rawgit.com/pymc-devs/pymc3/main/docs/logos/svg/PyMC3_banner.svg" />
5858
</a>
5959
{% if
6060
theme_navbar_links %} {%- for link in theme_navbar_links %} <a href="{{ pathto(*link[1:]) }}" class="item">{{
@@ -74,7 +74,7 @@
7474
</div>
7575
{% if pagename == 'index' %}
7676
<div class="ui center aligned text container">
77-
<img src="https://cdn.rawgit.com/pymc-devs/pymc3/master/docs/logos/svg/PyMC3_banner.svg" />
77+
<img src="https://cdn.rawgit.com/pymc-devs/pymc3/main/docs/logos/svg/PyMC3_banner.svg" />
7878
<h2>Probabilistic Programming in Python</h2>
7979
<a href="pymc-examples/examples/pymc3_howto/api_quickstart.html">
8080
<div class="ui huge primary button">Quickstart <i class="right arrow icon"></i></div>
@@ -89,14 +89,14 @@ <h2>Probabilistic Programming in Python</h2>
8989
<a class="ui image" href="https://github.com/pymc-devs/pymc3/actions">
9090
<img src="https://github.com/pymc-devs/pymc3/workflows/pytest/badge.svg">
9191
</a>
92-
<a class="ui image" href="https://coveralls.io/github/pymc-devs/pymc3?branch=master">
93-
<img src="https://coveralls.io/repos/github/pymc-devs/pymc3/badge.svg?branch=master">
92+
<a class="ui image" href="https://coveralls.io/github/pymc-devs/pymc3?branch=main">
93+
<img src="https://coveralls.io/repos/github/pymc-devs/pymc3/badge.svg?branch=main">
9494
</a>
9595
<a class="ui image" href="https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise">
9696
<a class="ui image" href="https://www.numfocus.org/">
9797
<img src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
9898
</a>
99-
<a class="ui image" href="https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks">
99+
<a class="ui image" href="https://mybinder.org/v2/gh/pymc-devs/pymc3/main?filepath=%2Fdocs%2Fsource%2Fnotebooks">
100100
<img src="https://mybinder.org/badge_logo.svg">
101101
</a>
102102
<a class="ui image" href="https://hub.docker.com/r/pymc/pymc3">

0 commit comments

Comments
 (0)