[WIP] Add ArviZ installation guide [docs] #1551
Conversation
There was a problem hiding this comment.
This is great, thank you for the contribution. I have added several comments, to try and start some discussion and back and forth feedback, they are not must do changes.
I also wanted to note a couple extra points. First is that I would place the document inside the getting started folder, and for the file to actually be shown in docs, it has to be added at the toctree in https://github.com/arviz-devs/arviz/blob/main/doc/source/getting_started/index.md (I would put it in the first place).
Second extra comment is that I think that one can install all optional dependencies with pip install arviz[all] thanks to https://github.com/arviz-devs/arviz/blob/main/setup.py#L57, can you check and if it works add that to the guide? Not sure if in pip section or if in dependencies section though
I have also added [docs] to the PR title to have Azure generate the docs so we have a preview. They can be download from Azure as artifacts.
OriolAbril
changed the title
arungrace88
force-pushed
the
my-feature
branch
from
93b9576
to
51db3d5
Compare
Codecov Report
@@ Coverage Diff @@
## main #1551 +/- ##
=======================================
Coverage 90.05% 90.05%
=======================================
Files 108 108
Lines 11584 11584
=======================================
Hits 10432 10432
Misses 1152 1152 Continue to review full report at Codecov.
|
|
@OriolAbril, |
There was a problem hiding this comment.
Thanks! It looks great
Before merging, I would add a link to this page in the home page. It currently has pip, conda and dev installation instrucctions, I think it would be great to leave pip and conda and change the dev install with something like "See the installation guide for more details"
| functionality is available with the basic requirements, but ArviZ also has optional | ||
| dependencies to further enhance the library. This guide will cover both basic and fully-fledged ArviZ installs and several installation methods. | ||
|
|
||
| ArviZ can be installed either using pip or conda-forge |
There was a problem hiding this comment.
I would put this line a couple lines later, inside the stable section
| ArviZ's functions work with NumPy arrays, dictionaries of arrays, xarray datasets, and has built-in support for `PyMC3 <https://docs.pymc.io/>`_, | ||
| `PyStan <https://pystan.readthedocs.io/en/latest/>`_, `CmdStanPy <https://github.com/stan-dev/cmdstanpy>`_, | ||
| `Pyro <http://pyro.ai/>`_, `NumPyro <http://num.pyro.ai/>`_, | ||
| `emcee <https://emcee.readthedocs.io/en/stable/>`_, and | ||
| `TensorFlow Probability <https://www.tensorflow.org/probability>`_ objects. Support for PyMC4, Edward2, and Edward are on the roadmap. | ||
|
|
||
| A Julia wrapper, `ArviZ.jl <https://arviz-devs.github.io/ArviZ.jl/stable/>`_ is | ||
| also available. It provides built-in support for | ||
| `Turing.jl <https://turing.ml/dev/>`_, `CmdStan.jl | ||
| <https://github.com/StanJulia/CmdStan.jl>`_, `StanSample.jl | ||
| <https://github.com/StanJulia/StanSample.jl>`_ and `Stan.jl <https://github.com/StanJulia/Stan.jl>`_. |
|
|
||
| - UltraJSON | ||
|
|
||
| If available, ArviZ makes use of faster ujson when ``arviz.from_json(filename)`` is |
There was a problem hiding this comment.
| If available, ArviZ makes use of faster ujson when ``arviz.from_json(filename)`` is | |
| If available, ArviZ makes use of faster ujson when :func:`arviz.from_json` is |
Writing the function like this will add a hyperlink to the corresponding page in the api reference
There was a problem hiding this comment.
Awesome. Thanks for letting me know.
| @@ -0,0 +1,100 @@ | |||
| ############ | |||
| Installation | |||
There was a problem hiding this comment.
| Installation | |
| Installation guide |
arungrace88
force-pushed
the
my-feature
branch
from
89a2cbf
to
5afefe1
Compare
|
Hi @OriolAbril, Added changes to index and installation file. Kindly have a look. Thanks. |
|
This looks great, thanks @arungrace88 ! I will merge it once it is added to the changelog. |
|
I took the liberty of updating the changelog myself and merged, thanks for the PR @arungrace88 |
* ArviZ installation page for review * Updated Installation.rst and index.md file in Getting Started documentation page * Deleted the previous installation.rst file in the source folder * Add link to Installation guide from home page. Update to Installation guide. * update changelog Co-authored-by: Oriol (ZBook) <[email protected]>
Description
This is an interim update on issue 'Write installation guide #1487' for your perusal. The .rst file contains the guide to install ArviZ using either pip or conda forge. The required and optional dependencies are also discussed in the guide. Kindly have a look and let me know the feedback. Thanks.