Skip to content

Commit 28a272d

Browse files
committed
Update install docs (torch, mpi)
1 parent d5bd3ae commit 28a272d

2 files changed

Lines changed: 11 additions & 10 deletions

File tree

docs/source/install/installing_mala.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,16 @@ Prerequisites
77
MALA supports any Python version starting from ``3.10.4``. No upper limit on
88
Python versions are enforced. The most recent *tested* version is ``3.10.12``.
99

10-
MALA requires ``torch`` in order to function. As the installation of torch
11-
depends highly on the architecture you are using, ``torch`` will not
12-
automatically be installed alongside MALA. Please obtain a suitable version
13-
of ``torch`` from the `official website <https://pytorch.org/>`_ before
14-
continuing.
10+
MALA requires ``torch`` (https://pytorch.org). Most install sites will want to
11+
use an already installed ``torch`` or install a specific version before
12+
installing the MALA package itself, for instance
13+
14+
.. code-block:: sh
15+
16+
pip install --index-url https://download.pytorch.org/whl/cu<cuda_version> torch==<torch_version>
17+
18+
If no ``torch`` is found, we install the latest GPU-enabled version via ``pip
19+
install torch`` (see ``requirements.txt``).
1520

1621
Installing the Python library
1722
*****************************
@@ -26,6 +31,7 @@ The following options are available:
2631
the version and thus needed for large code development (developers)
2732
- ``opt``: Installs ``oapackage``, so that the orthogonal array
2833
method may be used for large scale hyperparameter optimization (advanced users)
34+
- ``mpi``: Installs ``mpi4py`` for MPI parallelization (advanced users)
2935
- ``test``: Installs ``pytest`` which allows users to test the code (developers)
3036
- ``doc``: Installs all dependencies for building the documentary locally (developers)
3137

requirements.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# Most install sites will want to use an already installed torch or install a
2-
# specific version before installing mala, e.g. via
3-
#
4-
# pip install --extra-index-url https://download.pytorch.org/whl/cu<cuda_version> torch==<torch_version>
5-
#
61
# The requirement below makes sure we have torch installed, even if that will
72
# pull the latest GPU torch in case the user's environment may be misconfigured
83
# such that a pre-installed torch is not found.

0 commit comments

Comments
 (0)