Skip to content

Commit f20876a

Browse files
authored
improve appearance (#239)
* improve appearance * get tags and categories to show in all pages, not only posts * further improvements * try adding codeautolink * add auto footer with license and citation * fix template * some updates to readme * update citations with DOI * update templates * update requirements * fix citations and hide authors from exerpts * fix typo
1 parent ff2af9f commit f20876a

23 files changed

+341
-116
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Explain the bug, error or mistake, where it is in the notebook, if it happens
1212
only once or multiple times...
1313

1414
*Note that this issue tracker is about the contents in the notebooks, if
15-
the notebook is instead triggering a bug or error in pymc3, please
16-
report to https://github.com/pymc-devs/pymc3/issues instead*
15+
the notebook is instead triggering a bug or error in pymc, please
16+
report to https://github.com/pymc-devs/pymc/issues instead*
1717

1818
## Expected output
1919
If applicable, describe what should happen instead.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ blank_issues_enabled: false
22
contact_links:
33
- name: PyMC Discourse
44
url: https://discourse.pymc.io/
5-
about: Ask usage questions about PyMC3 or doubts about the examples here
6-
- name: PyMC3 bug report
7-
url: https://github.com/pymc-devs/pymc3/issues
8-
about: Please report bugs or propose enhancements of the PyMC3 library here.
5+
about: Ask usage questions about PyMC or doubts about the examples. If not sure where to ask, ask on Discourse.
6+
- name: PyMC bug report
7+
url: https://github.com/pymc-devs/pymc/issues
8+
about: Please report bugs or propose enhancements of the PyMC library here.

.github/ISSUE_TEMPLATE/notebook-proposal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ labels: proposal
99
**Title**: Use this also as issue title
1010

1111
## Why should this notebook be added to pymc-examples?
12-
Explain why this topic is interesting and useful to PyMC3 users.
12+
Explain why this topic is interesting and useful to PyMC users.
1313

1414
## Related notebooks
1515
Cover related notebooks on which this notebook will build,

README.rst

Lines changed: 31 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
.. image:: https://cdn.rawgit.com/pymc-devs/pymc3/master/docs/logos/svg/PyMC3_banner.svg
1+
.. image:: https://cdn.rawgit.com/pymc-devs/pymc/main/docs/logos/svg/PyMC_banner.svg
22
:height: 100px
3-
:alt: PyMC3 logo
3+
:alt: PyMC logo
44
:align: center
55

6-
PyMC3 Examples
6+
PyMC Examples
77
==============
88

9-
Supporting examples and tutorials for PyMC3, the Python package for Bayesian statistical modeling and Probabilistic Machine Learning!
9+
Supporting examples and tutorials for PyMC, the Python package for Bayesian statistical modeling and Probabilistic Machine Learning!
1010

1111
Check out the `getting started guide <http://docs.pymc.io/notebooks/getting_started>`__, or
12-
`interact with live examples <https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks>`__
13-
using Binder!
14-
For questions on PyMC3, head on over to our `PyMC Discourse <https://discourse.pymc.io/>`__ forum.
12+
interact with live examples using Binder! Each notebook in `PyMC examples gallery
13+
<https://pymc-examples.readthedocs.io>`__ has a binder badge.
14+
For questions on PyMC, head on over to our `PyMC Discourse <https://discourse.pymc.io/>`__ forum.
1515

1616
Contributing
1717
============
@@ -26,15 +26,15 @@ Contact
2626

2727
We are using `discourse.pymc.io <https://discourse.pymc.io/>`__ as our main communication channel. You can also follow us on `Twitter @pymc_devs <https://twitter.com/pymc_devs>`__ for updates and other announcements.
2828

29-
To ask a question regarding modeling or usage of PyMC3 we encourage posting to our Discourse forum under the `“Questions” Category <https://discourse.pymc.io/c/questions>`__. You can also suggest feature in the `“Development” Category <https://discourse.pymc.io/c/development>`__.
29+
To ask a question regarding modeling or usage of PyMC we encourage posting to our Discourse forum under the `“Questions” Category <https://discourse.pymc.io/c/questions>`__. You can also suggest feature in the `“Development” Category <https://discourse.pymc.io/c/development>`__.
3030

3131
To report an issue, please use the following:
3232

33-
- `PyMC3 Examples - Issue Tracker <https://github.com/pymc-devs/pymc-examples/issues>`__. For
33+
- `PyMC Examples - Issue Tracker <https://github.com/pymc-devs/pymc-examples/issues>`__. For
3434
issues about the example notebooks, errors in the example codes, outdated information, improvement
3535
suggestions...
36-
- `PyMC3 - Issue Tracker <https://github.com/pymc-devs/pymc3/issues>`__. For issues, bugs or
37-
feature requests related to the PyMC3 library itself.
36+
- `PyMC - Issue Tracker <https://github.com/pymc-devs/pymc/issues>`__. For issues, bugs or
37+
feature requests related to the PyMC library itself.
3838

3939
Finally, if you need to get in touch for non-technical information about the project, `send us an e-mail <[email protected]>`__.
4040

@@ -46,47 +46,52 @@ If you already know about Bayesian statistics:
4646

4747

4848
- `API quickstart guide <http://docs.pymc.io/notebooks/api_quickstart>`__
49-
- The `PyMC3 tutorial <http://docs.pymc.io/notebooks/getting_started>`__
50-
- `PyMC3 examples <https://docs.pymc.io/nb_examples/index.html>`__ and the `API reference <http://docs.pymc.io/api>`__
49+
- The `PyMC tutorial <http://docs.pymc.io/notebooks/getting_started>`__
50+
- `PyMC examples <https://docs.pymc.io/nb_examples/index.html>`__ and the `API reference <http://docs.pymc.io/api>`__
5151

5252

5353

54-
Learn Bayesian statistics with a book together with PyMC3:
54+
Learn Bayesian statistics with a book together with PyMC:
5555
----------------------------------------------------------
5656

5757
- `Probabilistic Programming and Bayesian Methods for Hackers <https://github.com/CamDavidsonPilon/Probabilistic-Programming-and-Bayesian-Methods-for-Hackers>`__ by Cameron Davidson-Pilon: Fantastic book with many applied code examples.
5858
- `Doing Bayesian Data Analysis <https://github.com/aloctavodia/Doing_bayesian_data_analysis>`__ by John Kruschke, as well as the `second edition <https://github.com/JWarmenhoven/DBDA-python>`__: Principled introduction to Bayesian data analysis.
59-
- `Statistical Rethinking: A Bayesian Course with Examples in R and Stan <https://github.com/pymc-devs/resources/tree/master/Rethinking>`__ by Richard McElreath: Comprehensive text on modeling choices and interpretations.
59+
- `Statistical Rethinking: A Bayesian Course with Examples in R and Stan <https://github.com/pymc-devs/resources/tree/master/Rethinking>`__ by Richard McElreath: Comprehensive text on modeling choices and interpretations.
6060
- `Bayesian Cognitive Modeling <https://github.com/pymc-devs/resources/tree/master/BCM>`__ by Michael Lee and EJ Wagenmakers: Focused on using Bayesian statistics in cognitive modeling.
6161
- `Bayesian Analysis with Python <https://www.packtpub.com/big-data-and-business-intelligence/bayesian-analysis-python-second-edition>`__ (second edition) by Osvaldo Martin: Great introductory book. (`code <https://github.com/aloctavodia/BAP>`__ and errata).
6262

63-
PyMC3 talks
63+
PyMC talks
6464
-----------
6565

66-
There are also several talks on PyMC3 which are gathered in this `YouTube playlist <https://www.youtube.com/playlist?list=PL1Ma_1DBbE82OVW8Fz_6Ts1oOeyOAiovy>`__
66+
There are also several talks on PyMC which are gathered in this `YouTube playlist <https://www.youtube.com/playlist?list=PL1Ma_1DBbE82OVW8Fz_6Ts1oOeyOAiovy>`__
6767
and as part of `PyMCon 2020 <https://discourse.pymc.io/c/pymcon/2020talks/15>`__
6868

6969
Installation
7070
------------
7171

72-
To install PyMC3 on your system, see its `installation section here <https://github.com/pymc-devs/pymc3#installation>`__
72+
To install PyMC on your system, see its `installation section here <https://docs.pymc.io/en/stable/>`__
7373

74-
Citing PyMC3
74+
Citing PyMC
7575
============
7676

77-
Salvatier J., Wiecki T.V., Fonnesbeck C. (2016) Probabilistic programming
78-
in Python using PyMC3. PeerJ Computer Science 2:e55
79-
`DOI: 10.7717/peerj-cs.55 <https://doi.org/10.7717/peerj-cs.55>`__.
77+
* To cite the PyMC software, use:
8078

81-
Papers citing PyMC3
79+
Salvatier J., Wiecki T.V., Fonnesbeck C. (2016) Probabilistic programming
80+
in Python using PyMC3. PeerJ Computer Science 2:e55
81+
`DOI: 10.7717/peerj-cs.55 <https://doi.org/10.7717/peerj-cs.55>`__.
82+
83+
* To cite specific guides from this collection, use |zenodo|. You'll find page specific
84+
citation instructions at the bottom of each page.
85+
86+
Papers citing PyMC
8287
-------------------
8388

8489
See `Google Scholar <https://scholar.google.de/scholar?oi=bibs&hl=en&authuser=1&cites=6936955228135731011>`__ for a continuously updated list.
8590

8691
Support
8792
=======
8893

89-
PyMC3 is a non-profit project under NumFOCUS umbrella. If you want to support PyMC3 financially, you can donate `here <https://numfocus.salsalabs.org/donate-to-pymc3/index.html>`__.
94+
PyMC is a non-profit project under NumFOCUS umbrella. If you want to support PyMC financially, you can donate `here <https://numfocus.salsalabs.org/donate-to-pymc3/index.html>`__.
9095

9196
PyMC for enterprise
9297
===================
@@ -107,22 +112,12 @@ Sponsors
107112

108113
|PyMCLabs|
109114

110-
.. |Binder| image:: https://mybinder.org/badge_logo.svg
111-
:target: https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks
112-
.. |Build Status| image:: https://github.com/pymc-devs/pymc3/workflows/pytest/badge.svg
113-
:target: https://github.com/pymc-devs/pymc3/actions
114-
.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc3/branch/master/graph/badge.svg
115-
:target: https://codecov.io/gh/pymc-devs/pymc3
116-
.. |Dockerhub| image:: https://img.shields.io/docker/automated/pymc/pymc3.svg
117-
:target: https://hub.docker.com/r/pymc/pymc3
115+
.. |zenodo| image:: https://zenodo.org/badge/321449673.svg
116+
:target: https://zenodo.org/badge/latestdoi/321449673
118117
.. |NumFOCUS| image:: https://www.numfocus.org/wp-content/uploads/2017/03/1457562110.png
119118
:target: http://www.numfocus.org/
120-
.. |NumFOCUS_badge| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
121-
:target: http://www.numfocus.org/
122119
.. |PyMCLabs| image:: https://github.com/pymc-devs/pymc/blob/main/docs/pymc-labs-logo.png
123120
:target: https://pymc-labs.io
124-
.. |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
125-
:target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise
126121
.. |tidelift_learn| image:: https://img.shields.io/badge/-learn%20more-2dd160.svg?color=orange&labelColor=58595b&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAOCAYAAADJ7fe0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVhJREFUKBV1kj0vBFEUhmd2sdZHh2IlGhKFQuOviEYiNlFodCqtUqPxA%2FwCjUTnDygkGoVERFQaZFlE9nreO%2BdM5u5wkifvuee892Pu3CyEcA0DeIc%2B9IwftJsR6Cko3uCjguZdjuBZhhwmYDjGrOC96WED41UtsgEdGEAPlmAfpuAbFF%2BFZLfoMfRBGzThDtLgePPwBIpdddGzOArhPHUXowbNptE2www6a%2Fm96Y3pHN7oQ1s%2B13pxt1ENaKzBFWyWzaJ%2BRO0C9Jny6VPSoKjLVbMDC5bn5OPuJF%2BBSe95PVEMuugY5AegS9fCh7BedP45hRnj8TC34QQUe9bTZyh2KgvFk2vc8GIlXyTfsvqr6bPpNgv52ynnlomZJNpB70Xhl%2Bf6Sa02p1bApEfnETwxVa%2Faj%2BW%2FFtHltmxS%2FO3krvpTtTnVgu%2F6gvHRFvG78Ef3kOe5PimJXycY74blT5R%2BAAAAAElFTkSuQmCC
127122
:target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise
128123
.. |tidelift_demo| image:: https://img.shields.io/badge/-request%20a%20demo-2dd160.svg?color=orange&labelColor=58595b&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAOCAYAAADJ7fe0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVhJREFUKBV1kj0vBFEUhmd2sdZHh2IlGhKFQuOviEYiNlFodCqtUqPxA%2FwCjUTnDygkGoVERFQaZFlE9nreO%2BdM5u5wkifvuee892Pu3CyEcA0DeIc%2B9IwftJsR6Cko3uCjguZdjuBZhhwmYDjGrOC96WED41UtsgEdGEAPlmAfpuAbFF%2BFZLfoMfRBGzThDtLgePPwBIpdddGzOArhPHUXowbNptE2www6a%2Fm96Y3pHN7oQ1s%2B13pxt1ENaKzBFWyWzaJ%2BRO0C9Jny6VPSoKjLVbMDC5bn5OPuJF%2BBSe95PVEMuugY5AegS9fCh7BedP45hRnj8TC34QQUe9bTZyh2KgvFk2vc8GIlXyTfsvqr6bPpNgv52ynnlomZJNpB70Xhl%2Bf6Sa02p1bApEfnETwxVa%2Faj%2BW%2FFtHltmxS%2FO3krvpTtTnVgu%2F6gvHRFvG78Ef3kOe5PimJXycY74blT5R%2BAAAAAElFTkSuQmCC
File renamed without changes.

_static/PyMC.png

68 KB
Loading

_static/binder.svg

Lines changed: 1 addition & 0 deletions
Loading

_static/colab.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)