From 1bea5c6df62fa6f9b2d0d9f292ad5e292ce48bbe Mon Sep 17 00:00:00 2001 From: CloudChaoszero Date: Sat, 20 Mar 2021 22:57:06 -0700 Subject: [PATCH 1/3] :see_no_evil: Ignore VS Code settings.json changes --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 69435bb8b..ad5c5fa25 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.pyc .ipynb_checkpoints +.vscode/* From cae4e2eb6e25968dcc852c206196adb0fa0d2113 Mon Sep 17 00:00:00 2001 From: CloudChaoszero Date: Sat, 20 Mar 2021 22:57:28 -0700 Subject: [PATCH 2/3] :tada: Initialize Readme for PyMC3 examples --- README.md | 2 - README.rst | 126 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 126 insertions(+), 2 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 5e50e5db5..000000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# pymc-examples -Examples of PyMC3 models, including a library of Jupyter notebooks. diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..cc7644a8c --- /dev/null +++ b/README.rst @@ -0,0 +1,126 @@ +.. image:: https://cdn.rawgit.com/pymc-devs/pymc3/master/docs/logos/svg/PyMC3_banner.svg + :height: 100px + :alt: PyMC3 logo + :align: center + +PyMC3 Examples +============== + +Supporting examples and tutorials for PyMC3, the Python package for Bayesian statistical modeling and Probabilistic Machine Learning! + +Check out the `getting started guide `__, or +`interact with live examples `__ +using Binder! +For questions on PyMC3, head on over to our `PyMC Discourse `__ forum. + +Getting started +=============== + +If you already know about Bayesian statistics: +---------------------------------------------- + + +- `API quickstart guide `__ +- The `PyMC3 tutorial `__ +- `PyMC3 examples `__ and the `API reference `__ + + + +Learn Bayesian statistics with a book together with PyMC3: +---------------------------------------------------------- + +- `Probabilistic Programming and Bayesian Methods for Hackers `__: Fantastic book with many applied code examples. +- `PyMC3 port of the book "Doing Bayesian Data Analysis" by John Kruschke `__ as well as the `second edition `__: Principled introduction to Bayesian data analysis. +- `PyMC3 port of the book "Statistical Rethinking A Bayesian Course with Examples in R and Stan" by Richard McElreath `__ +- `PyMC3 port of the book "Bayesian Cognitive Modeling" by Michael Lee and EJ Wagenmakers `__: Focused on using Bayesian statistics in cognitive modeling. +- `Bayesian Analysis with Python `__ (second edition) by Osvaldo Martin: Great introductory book. (`code `__ and errata). + +PyMC3 talks +----------- + +There are also several talks on PyMC3 which are gathered in this `YouTube playlist `__ +and as part of `PyMCon 2020 `__ + +Installation +------------ + +To install PyMC3 on your system, see its `installation section here `__ + +Citing PyMC3 +============ + +Salvatier J., Wiecki T.V., Fonnesbeck C. (2016) Probabilistic programming +in Python using PyMC3. PeerJ Computer Science 2:e55 +`DOI: 10.7717/peerj-cs.55 `__. + +Papers citing PyMC3 +------------------- + +See `Google Scholar `__ for a continuously updated list. + +Contributors +============ + +See the `GitHub contributor +page `__. Also read our `Code of Conduct `__ guidelines for a better contributing experience. + + +Contact +======= + +We are using `discourse.pymc.io `__ as our main communication channel. You can also follow us on `Twitter @pymc_devs `__ for updates and other announcements. + +To ask a question regarding modeling or usage of PyMC3 we encourage posting to our Discourse forum under the `“Questions” Category `__. You can also suggest feature in the `“Development” Category `__. + +To report an issue with PyMC3 please use the `issue tracker `__. + +Finally, if you need to get in touch for non-technical information about the project, `send us an e-mail `__. + +Support +======= + +PyMC3 is a non-profit project under NumFOCUS umbrella. If you want to support PyMC3 financially, you can donate `here `__. + +PyMC for enterprise +=================== +`PyMC is now available as part of the Tidelift Subscription!` + +Tidelift is working with PyMC and the maintainers of thousands of other open source +projects to deliver commercial support and maintenance for the open source dependencies +you use to build your applications. Save time, reduce risk, and improve code health, +while contributing financially to PyMC -- making it even more robust, reliable and, +let's face it, amazing! + +|tidelift_learn| |tidelift_demo| + +Sponsors +======== + +|NumFOCUS| + +|Quantopian| + +|ODSC| + +.. |Binder| image:: https://mybinder.org/badge_logo.svg + :target: https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks +.. |Build Status| image:: https://github.com/pymc-devs/pymc3/workflows/pytest/badge.svg + :target: https://github.com/pymc-devs/pymc3/actions +.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc3/branch/master/graph/badge.svg + :target: https://codecov.io/gh/pymc-devs/pymc3 +.. |Dockerhub| image:: https://img.shields.io/docker/automated/pymc/pymc3.svg + :target: https://hub.docker.com/r/pymc/pymc3 +.. |NumFOCUS| image:: https://www.numfocus.org/wp-content/uploads/2017/03/1457562110.png + :target: http://www.numfocus.org/ +.. |Quantopian| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/quantopianlogo.jpg + :target: https://quantopian.com +.. |NumFOCUS_badge| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A + :target: http://www.numfocus.org/ +.. |ODSC| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/odsc_logo.png + :target: https://odsc.com +.. |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 + :target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise +.. |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 + :target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise +.. |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 + :target: https://tidelift.com/subscription/request-a-demo?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise \ No newline at end of file From 87f864cd7f07f16565d027b678725b3e5f25bbd2 Mon Sep 17 00:00:00 2001 From: CloudChaoszero Date: Sun, 21 Mar 2021 01:43:15 -0700 Subject: [PATCH 3/3] Add specified issue tracker and contrib links --- README.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index cc7644a8c..0886ed240 100644 --- a/README.rst +++ b/README.rst @@ -62,7 +62,7 @@ Contributors ============ See the `GitHub contributor -page `__. Also read our `Code of Conduct `__ guidelines for a better contributing experience. +page `__. Also read our `Code of Conduct `__ guidelines for a better contributing experience. Contact @@ -72,7 +72,10 @@ We are using `discourse.pymc.io `__ as our main comm To ask a question regarding modeling or usage of PyMC3 we encourage posting to our Discourse forum under the `“Questions” Category `__. You can also suggest feature in the `“Development” Category `__. -To report an issue with PyMC3 please use the `issue tracker `__. +To report an issue, please use the following: + +- `PyMC3 Examples - Issue Tracker `__. +- `PyMC3 - Issue Tracker `__. Finally, if you need to get in touch for non-technical information about the project, `send us an e-mail `__.