Skip to content

Commit 5b671f7

Browse files
DOC Clean up build dependencies (scikit-learn#31142)
1 parent bb261bf commit 5b671f7

File tree

1 file changed

+9
-49
lines changed

1 file changed

+9
-49
lines changed

doc/developers/advanced_installation.rst

Lines changed: 9 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,15 @@ feature, code or documentation improvement).
9898
for :ref:`compiler_windows`, :ref:`compiler_macos`, :ref:`compiler_linux`
9999
and :ref:`compiler_freebsd`.
100100

101+
.. note::
102+
103+
If OpenMP is not supported by the compiler, the build will be done with
104+
OpenMP functionalities disabled. This is not recommended since it will force
105+
some estimators to run in sequential mode instead of leveraging thread-based
106+
parallelism. Setting the ``SKLEARN_FAIL_NO_OPENMP`` environment variable
107+
(before cythonization) will force the build to fail if OpenMP is not
108+
supported.
109+
101110
#. Build the project with pip:
102111

103112
.. prompt:: bash $
@@ -130,55 +139,6 @@ feature, code or documentation improvement).
130139
Note that `--config-settings` is only supported in `pip` version 23.1 or
131140
later. To upgrade `pip` to a compatible version, run `pip install -U pip`.
132141

133-
Dependencies
134-
------------
135-
136-
Runtime dependencies
137-
~~~~~~~~~~~~~~~~~~~~
138-
139-
Scikit-learn requires the following dependencies both at build time and at
140-
runtime:
141-
142-
- Python (>= |PythonMinVersion|),
143-
- NumPy (>= |NumpyMinVersion|),
144-
- SciPy (>= |ScipyMinVersion|),
145-
- Joblib (>= |JoblibMinVersion|),
146-
- threadpoolctl (>= |ThreadpoolctlMinVersion|).
147-
148-
Build dependencies
149-
~~~~~~~~~~~~~~~~~~
150-
151-
Building Scikit-learn also requires:
152-
153-
- Cython >= |CythonMinVersion|
154-
- A C/C++ compiler and a matching OpenMP_ runtime library. See the
155-
:ref:`platform system specific instructions
156-
<platform_specific_instructions>` for more details.
157-
158-
.. note::
159-
160-
If OpenMP is not supported by the compiler, the build will be done with
161-
OpenMP functionalities disabled. This is not recommended since it will force
162-
some estimators to run in sequential mode instead of leveraging thread-based
163-
parallelism. Setting the ``SKLEARN_FAIL_NO_OPENMP`` environment variable
164-
(before cythonization) will force the build to fail if OpenMP is not
165-
supported.
166-
167-
Since version 0.21, scikit-learn automatically detects and uses the linear
168-
algebra library used by SciPy **at runtime**. Scikit-learn has therefore no
169-
build dependency on BLAS/LAPACK implementations such as OpenBlas, Atlas, Blis
170-
or MKL.
171-
172-
Test dependencies
173-
~~~~~~~~~~~~~~~~~
174-
175-
Running tests requires:
176-
177-
- pytest >= |PytestMinVersion|
178-
179-
Some tests also require `pandas <https://pandas.pydata.org>`_.
180-
181-
182142
Building a specific version from a tag
183143
--------------------------------------
184144

0 commit comments

Comments
 (0)