Skip to content

Commit dc64b75

Browse files
correction about impi package names (#2810)
1 parent 7e54493 commit dc64b75

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

doc/sources/distributed-mode.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Several :doc:`GPU-supported algorithms <oneapi-gpu>`
2626
also provide distributed, multi-GPU computing capabilities via integration with |mpi4py|. The prerequisites
2727
match those of GPU computing, along with an MPI backend of your choice (`Intel MPI recommended
2828
<https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html>`_, available
29-
via the ``impi_rt`` python/conda package) and the |mpi4py| python package. If using |sklearnex|
29+
via the ``impi_rt`` / ``impi-rt`` python/conda package) and the |mpi4py| python package. If using |sklearnex|
3030
`installed from sources <https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/INSTALL.md#build-from-sources>`_,
3131
ensure that the spmd_backend is built.
3232

@@ -49,9 +49,9 @@ ensure that the spmd_backend is built.
4949
.. tab:: From Intel's pip Index
5050
::
5151

52-
pip install --index-url https://software.repos.intel.com/python/pypi mpi4py impi_rt
52+
pip install --index-url https://software.repos.intel.com/python/pypi mpi4py impi-rt
5353

54-
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`` 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:
54+
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:
5555

5656
.. tabs::
5757
.. tab:: From conda-forge
@@ -67,12 +67,12 @@ ensure that the spmd_backend is built.
6767
.. tab:: From PyPI
6868
::
6969

70-
pip install impi_rt
70+
pip install impi-rt
7171

7272
.. tab:: From Intel's pip Index
7373
::
7474

75-
pip install --index-url https://software.repos.intel.com/python/pypi impi_rt
75+
pip install --index-url https://software.repos.intel.com/python/pypi impi-rt
7676

7777

7878
Using other MPI backends that are not MPICH-compatible (e.g. OpenMPI) requires building |sklearnex| from source with that backend, and using an |mpi4py| built with that same backend.

doc/sources/distributed_daal4py.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ same algorithms to much larger problem sizes.
4545
the MPI runtime library managing the computations to be the same MPI backend library
4646
with which the |sklearnex| library was compiled, or to be ABI compatible with it.
4747
Distributions of the |sklearnex| in PyPI and conda-forge are both compiled with `Intel's MPI <https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html>`__
48-
as MPI backend (offered as Python package ``impi_rt`` in both PyPI and conda): ::
48+
as MPI backend (offered as Python package ``impi_rt`` in conda, or ``impi-rt`` in PyPI): ::
4949

5050
conda install -c conda-forge impi_rt mpi=*=impi
5151

@@ -77,7 +77,7 @@ same algorithms to much larger problem sizes.
7777
.. tab:: From Intel's pip Index
7878
::
7979

80-
pip install --index-url https://software.repos.intel.com/python/pypi mpi4py impi_rt
80+
pip install --index-url https://software.repos.intel.com/python/pypi mpi4py impi-rt
8181

8282

8383
Using distributed mode

0 commit comments

Comments
 (0)