Skip to content

Commit

Permalink
Merge pull request #598 from mrava87/doc-jax
Browse files Browse the repository at this point in the history
doc: added jax to installation.rst
  • Loading branch information
mrava87 authored Aug 9, 2024
2 parents 21e590b + 628f60b commit b199b3a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -540,4 +540,14 @@ CuPy
for GPU-accelerated computations. Since many different versions of CuPy exist (based on the
CUDA drivers of the GPU), users must install CuPy prior to installing
PyLops. To do so, follow their
`installation instructions <https://docs.cupy.dev/en/stable/install.html>`__.
`installation instructions <https://docs.cupy.dev/en/stable/install.html>`__.


JAX
---
`JAX <http://JAX.readthedocs.io>`_ is another library that can be used as a drop-in replacement
to NumPy and some parts of SciPy. It provides seamless support for multiple accelerators (e.g., GPUs, TPUs),
Just-In-Time (JIT) compilation via Open XLA, and Automatic Differentiation. Similar to CuPy, since many
different versions of JAX exist (based on the CUDA drivers of the GPU), users must install JAX prior
to installing PyLops. To do so, follow their
`installation instructions <https://jax.readthedocs.io/en/latest/installation.html#install-cpu>`__.
2 changes: 2 additions & 0 deletions requirements-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# since the dtcwt and spgl1 are not yet compatible with numpy=2.0.0
numpy>=1.21.0,<2.0.0
scipy>=1.11.0
jax
--extra-index-url https://download.pytorch.org/whl/cpu
torch>=1.2.0
numba
Expand All @@ -21,6 +22,7 @@ docutils<0.18
Sphinx
pydata-sphinx-theme
sphinx-gallery
sphinxemoji
numpydoc
nbsphinx
image
Expand Down

0 comments on commit b199b3a

Please sign in to comment.