Skip to content

Docs - Update PyMC3 Installation focus via Conda Forge #4401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 5, 2021
Merged

Docs - Update PyMC3 Installation focus via Conda Forge #4401

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e098482
:pencil2: Update PyMC3 Docs installation by Conda Forge
CloudChaoszero Jan 3, 2021
361e1b0
Update README.rst
twiecki Jan 4, 2021
ff9dea8
:pencil2: Focus on Theano-PyMC3 instead of Theano for installation
CloudChaoszero Jan 4, 2021
3f94ed9
Update README.rst
twiecki Jan 5, 2021
1d6fba2
Update README.rst
twiecki Jan 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 35 additions & 20 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,22 +77,25 @@ and as part of `PyMCon 2020 <https://discourse.pymc.io/c/pymcon/2020talks/15>`__
Installation
============

The latest release of PyMC3 can be installed from PyPI using ``pip``:
PyMC3 Installation
------------------

::
The latest release of PyMC3 can be installed from Conda Forge (conda-forge):

pip install pymc3
::

**Note:** Running ``pip install pymc`` will install PyMC 2.3, not PyMC3,
from PyPI.
conda install -c conda-forge pymc3

Or via conda-forge:
While strongly discouraged due to installation problems you could try to install PyMC3 and its dependencies via PyPI using ``pip``:

::

conda install -c conda-forge pymc3
pip install pymc3

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``.
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.
.. note::

Running ``pip install pymc`` will install PyMC 2.3, not PyMC3, from PyPI.

The current development branch of PyMC3 can be installed from GitHub, also using ``pip``:

Expand All @@ -101,29 +104,41 @@ The current development branch of PyMC3 can be installed from GitHub, also using
pip install git+https://github.com/pymc-devs/pymc3

To ensure the development branch of Theano is installed alongside PyMC3
(recommended), you can install PyMC3 using the ``requirements.txt``
file. This requires cloning the repository to your computer:
(recommended), see the Theano Installation section, below.

Lastly, another option is to clone the repository and install PyMC3 using
``python setup.py install`` or ``python setup.py develop``.

Theano Installation
-------------------

PyMC3 is tested on Python 3.6, 3.7, and 3.8 and depends on `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__,
NumPy, SciPy, and pandas
(see `requirements.txt <https://github.com/pymc-devs/pymc3/blob/master/requirements.txt>`__ for version
information).

That being said, you can install PyMC3 using the ``requirements.txt``
file.

This requires cloning the repository to your computer:

::

git clone https://github.com/pymc-devs/pymc3
cd pymc3
pip install -r requirements.txt

However, if a recent version of Theano has already been installed on
your system, you can install PyMC3 directly from GitHub.
.. note::
If you already have `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__ installed, then re-install the module, as such
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should say that it now requires Theano-PyMC instead of just the old Theano, and that if the old Theano is installed, they just remove that and install Theano-PyMC via conda-forge.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@twiecki Sounds great, I think I made the appropriate changes. Moreover, I changed the sub-bulletin title of the Installation section to be Theano-PyMC Installation.

Let me know what you think.


Another option is to clone the repository and install PyMC3 using
``python setup.py install`` or ``python setup.py develop``.
``conda remove theano-pymc -y``

``conda install -c conda-forge theano-pymc -y``

Dependencies
============
Arviz Installation
------------------

PyMC3 is tested on Python 3.6, 3.7, and 3.8 and depends on `Theano-PyMC <https://github.com/pymc-devs/Theano-PyMC>`__,
NumPy, SciPy, and pandas
(see `requirements.txt <https://github.com/pymc-devs/pymc3/blob/master/requirements.txt>`__ for version
information).
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``.

Optional
--------
Expand Down
7 changes: 0 additions & 7 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,6 @@

conda install -c conda-forge pymc3

.. raw:: html

<h3 class="ui header">Via pypi:</h3>

.. code-block:: bash

pip install pymc3

.. raw:: html

Expand Down