Skip to content

Commit d8e8fd4

Browse files
committed
DOC More restructuring of readme.
1 parent f64d995 commit d8e8fd4

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

README.rst

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Check out the `getting started
1313
guide <http://pymc-devs.github.io/pymc3/notebooks/getting_started.html>`__!
1414

1515
Features
16-
--------
16+
========
1717

1818
- Intuitive model specification syntax, for example, ``x ~ N(0,1)``
1919
translates to ``x = Normal('x',0,1)``
@@ -32,27 +32,32 @@ Features
3232
- Transparent support for missing value imputation
3333

3434
Getting started
35-
---------------
35+
===============
3636

3737
If you already know about Bayesian statistics:
38+
----------------------------------------------
3839

3940
- `API quickstart guide <http://pymc-devs.github.io/pymc3/notebooks/api_quickstart.html>`__
4041
- The `PyMC3 tutorial <http://pymc-devs.github.io/pymc3/notebooks/getting_started.html>`__
4142
- `PyMC3 examples <http://pymc-devs.github.io/pymc3/examples.html>`__
4243
and the `API reference <http://pymc-devs.github.io/pymc3/api.html>`__
4344

44-
If you want to learn Bayesian statistics with a book together with PyMC3:
45+
Learn Bayesian statistics with a book together with PyMC3:
46+
----------------------------------------------------------
4547

4648
- `Probabilistic Programming and Bayesian Methods for Hackers <https://github.com/CamDavidsonPilon/Probabilistic-Programming-and-Bayesian-Methods-for-Hackers>`__: Fantastic book with many applied code examples.
4749
- `PyMC3 port of the book "Doing Bayesian Data Analysis" by John Kruschke <https://github.com/aloctavodia/Doing_bayesian_data_analysis>`__ as well as the `second edition <https://github.com/JWarmenhoven/DBDA-python>`__: Principled introduction to Bayesian data analysis.
4850
- `PyMC3 port of the book "Statistical Rethinking A Bayesian Course with Examples in R and Stan" by Richard McElreath <https://github.com/aloctavodia/Statistical-Rethinking-with-Python-and-PyMC3>`__
4951
- `PyMC3 port of the book "Bayesian Cognitive Modeling" by Michael Lee and EJ Wagenmakers <https://github.com/junpenglao/Bayesian-Cognitive-Modeling-in-Pymc3>`__: Focused on using Bayesian statistics in cognitive modeling.
5052
- `Bayesian Analysis with Python by Osvaldo Martin <https://www.packtpub.com/big-data-and-business-intelligence/bayesian-analysis-python>`__ (and `errata <https://github.com/aloctavodia/BAP>`__): Great introductory book.
5153

54+
PyMC3 talks
55+
-----------
56+
5257
There are also several talks on PyMC3 which are gathered in this `YouTube playlist <https://www.youtube.com/playlist?list=PL1Ma_1DBbE82OVW8Fz_6Ts1oOeyOAiovy>`__
5358

5459
Installation
55-
------------
60+
============
5661

5762
The latest release of PyMC3 can be installed from PyPI using ``pip``:
5863

@@ -93,14 +98,14 @@ Another option is to clone the repository and install PyMC3 using
9398

9499

95100
Dependencies
96-
------------
101+
============
97102

98103
PyMC3 is tested on Python 2.7 and 3.6 and depends on Theano, NumPy,
99104
SciPy, Pandas, and Matplotlib (see ``requirements.txt`` for version
100105
information).
101106

102107
Optional
103-
~~~~~~~~
108+
--------
104109

105110
In addtion to the above dependencies, the GLM submodule relies on
106111
`Patsy <http://patsy.readthedocs.io/en/latest/>`__.
@@ -109,14 +114,14 @@ In addtion to the above dependencies, the GLM submodule relies on
109114
enables sparse scaling matrices which are useful for large problems.
110115

111116
Citing PyMC3
112-
------------
117+
============
113118

114119
Salvatier J, Wiecki TV, Fonnesbeck C. (2016) Probabilistic programming
115120
in Python using PyMC3. PeerJ Computer Science 2:e55
116121
https://doi.org/10.7717/peerj-cs.55
117122

118123
Contact
119-
-------
124+
=======
120125

121126
To report an issue with PyMC3 or to suggest a feature please use the `issue tracker <https://github.com/pymc-devs/pymc3/issues>`__.
122127

@@ -127,36 +132,41 @@ To interact with PyMC3 developers, visit the `pymc Gitter channel <https://gitte
127132
Finally, if you need to get in touch for non-technical information about the project, `send us an e-mail <[email protected]>`__.
128133

129134
License
130-
-------
135+
=======
131136

132137
`Apache License, Version
133138
2.0 <https://github.com/pymc-devs/pymc3/blob/master/LICENSE>`__
134139

135140

136141
Software using PyMC3
137-
--------------------
142+
====================
138143

139144
- `Bambi <https://github.com/bambinos/bambi>`__: BAyesian Model-Building Interface (BAMBI) in Python.
140-
- `NiPyMC <https://github.com/PsychoinformaticsLab/nipymc>`__: Bayesian mixed-effects modeling of fMRI data in Python.
141145
- `gelato <https://github.com/ferrine/gelato>`__: Bayesian Neural Networks with PyMC3 and Lasagne.
146+
- `NiPyMC <https://github.com/PsychoinformaticsLab/nipymc>`__: Bayesian mixed-effects modeling of fMRI data in Python.
142147
- `beat <https://github.com/hvasbath/beat>`__: Bayesian Earthquake Analysis Tool.
143148
- `Edward <https://github.com/blei-lab/edward>`__: A library for probabilistic modeling, inference, and criticism.
144149

145150
Please contact us if your software is not listed here.
146151

147152
Papers citing PyMC3
148-
-------------------
153+
===================
149154

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

152157
Contributors
153-
------------
158+
============
154159

155160
See the `GitHub contributor
156161
page <https://github.com/pymc-devs/pymc3/graphs/contributors>`__
157162

163+
Support
164+
=======
165+
166+
PyMC3 is a non-profit project under NumFOCUS umbrella. If you want to support PyMC3 financially, you can donate `here <https://www.flipcause.com/widget/widget_home/MTE4OTc=>`__.
167+
158168
Sponsors
159-
--------
169+
========
160170

161171
|NumFOCUS|
162172

@@ -168,7 +178,7 @@ Sponsors
168178
:target: https://travis-ci.org/pymc-devs/pymc3
169179
.. |Coverage| image:: https://coveralls.io/repos/github/pymc-devs/pymc3/badge.svg?branch=master
170180
:target: https://coveralls.io/github/pymc-devs/pymc3?branch=master
171-
.. |NumFOCUS| image:: http://www.numfocus.org/uploads/6/0/6/9/60696727/1457562110.png
181+
.. |NumFOCUS| image:: https://www.numfocus.org/wp-content/uploads/2017/03/1457562110.png
172182
:target: http://www.numfocus.org/
173183
.. |Quantopian| image:: https://raw.githubusercontent.com/pymc-devs/pymc3/master/docs/quantopianlogo.jpg
174184
:target: https://quantopian.com

0 commit comments

Comments
 (0)