You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+42-21
Original file line number
Diff line number
Diff line change
@@ -77,53 +77,74 @@ and as part of `PyMCon 2020 <https://discourse.pymc.io/c/pymcon/2020talks/15>`__
77
77
Installation
78
78
============
79
79
80
-
The latest release of PyMC3 can be installed from PyPI using ``pip``:
80
+
PyMC3 Installation
81
+
------------------
81
82
82
-
::
83
+
The latest release of PyMC3 can be installed from Conda Forge (conda-forge):
83
84
84
-
pip install pymc3
85
+
::
85
86
86
-
**Note:** Running ``pip install pymc`` will install PyMC 2.3, not PyMC3,
87
-
from PyPI.
87
+
conda install -c conda-forge pymc3
88
88
89
-
Or via conda-forge:
89
+
While strongly discouraged due to installation problems you could try to install PyMC3 and its dependencies via PyPI using ``pip``:
90
90
91
91
::
92
92
93
-
conda install -c conda-forge pymc3
93
+
pip install pymc3
94
94
95
-
Plotting is done using `ArviZ <https://arviz-devs.github.io/arviz/>`__ - if you follow the installation instructions above, then it will be installed alongside ``PyMC3``.
95
+
The reason installation via PyPI is difficult, especially on Windows and OSX, is that ``Theano`` requires compilation against MKL, which is difficult to set up, while Conda comes with its own compilers and MKL installation.
96
+
.. note::
97
+
98
+
Running ``pip install pymc`` will install PyMC 2.3, not PyMC3, from PyPI.
96
99
97
100
The current development branch of PyMC3 can be installed from GitHub, also using ``pip``:
To ensure the development branch of Theano is installed alongside PyMC3
104
-
(recommended), you can install PyMC3 using the ``requirements.txt``
105
-
file. This requires cloning the repository to your computer:
106
+
Make sure to install the `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ version that is pegged in ``PyMC3``'s ``requirements.txt``.
107
+
For more information, see the `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ Installation section, below.
108
+
109
+
Lastly, another option is to clone the repository and install PyMC3 using
110
+
``python setup.py install`` or ``python setup.py develop``.
111
+
112
+
Theano-PyMC Installation
113
+
------------------------
114
+
115
+
PyMC3 is tested on Python 3.6, 3.7, and 3.8 and depends on NumPy, SciPy, and pandas
116
+
(see `requirements.txt <https://github.com/pymc-devs/pymc3/blob/master/requirements.txt>`__ for version
117
+
information).
118
+
119
+
Moreover, as of Late 2020, PyMC3 now requires `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ instead of `Theano <https://github.com/Theano/Theano>`__.
120
+
121
+
That being said, you can install PyMC3 using the ``requirements.txt``
122
+
file.
123
+
124
+
This requires cloning the repository to your computer:
106
125
107
126
::
108
127
109
128
git clone https://github.com/pymc-devs/pymc3
110
129
cd pymc3
111
130
pip install -r requirements.txt
112
131
113
-
However, if a recent version of Theano has already been installed on
114
-
your system, you can install PyMC3 directly from GitHub.
132
+
.. note::
115
133
116
-
Another option is to clone the repository and install PyMC3 using
117
-
``python setup.py install`` or ``python setup.py develop``.
134
+
* If you have Theano installed, please remove it and install Theano-PyMC via Conda Forge, seen below:
118
135
136
+
``conda remove theano``
119
137
120
-
Dependencies
121
-
============
138
+
* If you have an outdated version of Theano-PyMC, then re-install the module via Conda Forge:
122
139
123
-
PyMC3 is tested on Python 3.6, 3.7, and 3.8 and depends on `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__,
124
-
NumPy, SciPy, and pandas
125
-
(see `requirements.txt <https://github.com/pymc-devs/pymc3/blob/master/requirements.txt>`__ for version
126
-
information).
140
+
``conda remove theano-pymc -y``
141
+
142
+
``conda install -c conda-forge theano-pymc -y``
143
+
144
+
Arviz Installation
145
+
------------------
146
+
147
+
Plotting is done using `ArviZ <https://arviz-devs.github.io/arviz/>`__ - if you follow the installation instructions above, then it will be installed alongside ``PyMC3``.
0 commit comments