Skip to content
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.

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

Docs - Update PyMC3 Installation focus via Conda Forge #4401

Merged
merged 5 commits into from
Jan 5, 2021

Conversation

CloudChaoszero
Copy link
Contributor

Description

Closes #4398

  • Update PyMC3 Installation focus via Conda Forge
  • Re-arrange & add hierarchy for Installation Ordering
    • E.g. First PyMC3 Installation mentioned, then Theano & Arviz, respectively.

Example

This preview was on my local machine
Example

@CloudChaoszero
Copy link
Contributor Author

@twiecki I still left the mention of pip install, but it's shown as a second option.

Let me know if you want me to completely remove that mention.

@codecov
Copy link

codecov bot commented Jan 3, 2021

Codecov Report

Merging #4401 (ff9dea8) into master (2824027) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4401   +/-   ##
=======================================
  Coverage   88.17%   88.17%           
=======================================
  Files          88       88           
  Lines       14563    14563           
=======================================
  Hits        12841    12841           
  Misses       1722     1722           

@MarcoGorelli MarcoGorelli self-requested a review January 3, 2021 11:44
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
✏️ Update README.rst

Add note about pip installation

Co-authored-by: Thomas Wiecki <thomas.wiecki@gmail.com>

Update README.rst

Add context to pip installation and dependencies

Co-authored-by: Thomas Wiecki <thomas.wiecki@gmail.com>

Apply suggestions from code review

Co-authored-by: Thomas Wiecki <thomas.wiecki@gmail.com>

✏️ README installation update
@CloudChaoszero
Copy link
Contributor Author

Thanks for the suggestions! Updated the PR w/squash'd commits

README.rst Outdated Show resolved Hide resolved
README.rst Outdated
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.

@CloudChaoszero CloudChaoszero requested a review from twiecki January 5, 2021 05:52
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@twiecki twiecki merged commit aabec02 into pymc-devs:master Jan 5, 2021
@twiecki
Copy link
Member

twiecki commented Jan 5, 2021

Thanks @CloudChaoszero !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update installation instructions to mention conda requirement
2 participants