Skip to content

Commit 5309887

Browse files
don't suggest mpi4py from intel pip index (#3052)
1 parent 31a814e commit 5309887

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

doc/sources/distributed-mode.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ via the ``impi_rt`` / ``impi-rt`` python/conda package) and the |mpi4py| python
3030
:doc:`installed from sources <building-from-source>`, ensure that the SPMD backend is built.
3131

3232
.. important::
33-
SMPD mode requires the |mpi4py| package used at runtime to be compiled with the same MPI backend as the |sklearnex|, or with an ABI-compatible MPI backend. The PyPI and Conda distributions of |sklearnex| are both built with Intel's MPI as backend, which follows the MPICH ABI and hence require an |mpi4py| also built with either Intel's MPI, or with another MPICH-compatible MPI backend (such as MPICH itself) - versions of |mpi4py| built with Intel's MPI can be installed as follows:
33+
SMPD mode requires the |mpi4py| package used at runtime to be compiled with the same MPI backend as the |sklearnex|, or with an ABI-compatible MPI backend. The PyPI and Conda distributions of |sklearnex| are both built with Intel's MPI as backend, which follows the MPICH ABI and hence require an |mpi4py| also built with either Intel's MPI, or with another MPICH-compatible MPI backend (such as MPICH itself) - versions of |mpi4py| compatible with Intel's MPI can be installed as follows:
3434

3535
.. tabs::
3636
.. tab:: From conda-forge
@@ -45,10 +45,16 @@ via the ``impi_rt`` / ``impi-rt`` python/conda package) and the |mpi4py| python
4545

4646
.. warning:: Packages from the Intel channel are meant to be compatible with dependencies from ``conda-forge``, and might not work correctly in environments that have packages installed from the ``anaconda`` channel.
4747

48-
.. tab:: From Intel's pip Index
48+
.. tab:: From PyPI
4949
::
5050

51-
pip install --index-url https://software.repos.intel.com/python/pypi mpi4py impi-rt
51+
pip install mpi4py impi-rt
52+
53+
.. tip:: If the system has another MPI installation, one might want to set environment variable ``$MPI4PY_LIBMPI`` to point to the desired Intel MPI path to avoid clashes - for example, on Linux*, if using an offline installer with an activation script under ``/opt/intel/oneapi/setvars.sh``, one can set that variable as follows to use the system MPI:
54+
55+
.. code-block:: bash
56+
57+
export MPI4PY_LIBMPI="${I_MPI_ROOT}/lib/libmpi.so"
5258
5359
It also requires the MPI runtime executable (``mpiexec`` / ``mpirun``) to be from the same library that was used to compile |sklearnex| or from a compatible library. Intel's MPI runtime library is offered as a Python package ``impi_rt`` (conda) / ``impi-rt`` (PyPI) and will be installed together with the ``mpi4py`` package if executing the commands above, but otherwise, it can be installed separately from different distribution channels:
5460

doc/sources/distributed_daal4py.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,12 @@ same algorithms to much larger problem sizes.
7373

7474
.. warning:: Packages from the Intel channel are meant to be compatible with dependencies from ``conda-forge``, and might not work correctly in environments that have packages installed from the ``anaconda`` channel.
7575

76-
.. tab:: From Intel's pip Index
76+
.. tab:: PyPI
7777
::
7878

79-
pip install --index-url https://software.repos.intel.com/python/pypi mpi4py impi-rt
79+
pip install mpi4py impi-rt
80+
81+
.. warning:: The command above might not necessarily result in an ``mpi4py`` environment that uses the ``impi-rt`` package from PyPI if there are multiple MPI installations. See :ref:`SPMD mode <distributed>` for more details.
8082

8183

8284
Using distributed mode

0 commit comments

Comments
 (0)