Skip to content

Commit 96e13f1

Browse files
DOC small documentation changes in the advanced installation guide (scikit-learn#26394)
1 parent e3590c8 commit 96e13f1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

doc/developers/advanced_installation.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ feature, code or documentation improvement).
9090

9191
.. prompt:: bash $
9292

93-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
93+
pip install -v --no-use-pep517 --no-build-isolation -e .
9494

9595
#. Check that the installed scikit-learn has a version number ending with
9696
`.dev0`:
@@ -109,7 +109,9 @@ feature, code or documentation improvement).
109109
(ending in `.pyx` or `.pxd`). This can happen when you edit them or when you
110110
use certain git commands such as `git pull`. Use the ``--no-build-isolation`` flag
111111
to avoid compiling the whole project each time, only the files you have
112-
modified.
112+
modified. Include the ``--no-use-pep517`` flag because the ``--no-build-isolation``
113+
option might not work otherwise (this is due to a bug which will be fixed in the
114+
future).
113115

114116
Dependencies
115117
------------
@@ -242,7 +244,7 @@ Finally, build scikit-learn from this command prompt:
242244

243245
.. prompt:: bash $
244246

245-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
247+
pip install -v --no-use-pep517 --no-build-isolation -e .
246248

247249
.. _compiler_macos:
248250

@@ -284,7 +286,7 @@ scikit-learn from source:
284286
joblib threadpoolctl pytest compilers llvm-openmp
285287
conda activate sklearn-dev
286288
make clean
287-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
289+
pip install -v --no-use-pep517 --no-build-isolation -e .
288290

289291
.. note::
290292

@@ -364,7 +366,7 @@ Finally, build scikit-learn in verbose mode (to check for the presence of the
364366
.. prompt:: bash $
365367

366368
make clean
367-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
369+
pip install -v --no-use-pep517 --no-build-isolation -e .
368370

369371
.. _compiler_linux:
370372

@@ -424,7 +426,7 @@ in the user folder using conda:
424426
conda create -n sklearn-dev -c conda-forge python numpy scipy cython \
425427
joblib threadpoolctl pytest compilers
426428
conda activate sklearn-dev
427-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
429+
pip install -v --no-use-pep517 --no-build-isolation -e .
428430

429431
.. _compiler_freebsd:
430432

@@ -453,7 +455,7 @@ Finally, build the package using the standard command:
453455

454456
.. prompt:: bash $
455457

456-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
458+
pip install -v --no-use-pep517 --no-build-isolation -e .
457459

458460
For the upcoming FreeBSD 12.1 and 11.3 versions, OpenMP will be included in
459461
the base system and these steps will not be necessary.
@@ -514,7 +516,7 @@ and environment variable as follows before calling the ``pip install`` or
514516
``python setup.py build_ext`` commands::
515517

516518
export SKLEARN_BUILD_PARALLEL=3
517-
pip install --verbose --no-use-pep517 --no-build-isolation --editable .
519+
pip install -v --no-use-pep517 --no-build-isolation -e .
518520

519521
On a machine with 2 CPU cores, it can be beneficial to use a parallelism level
520522
of 3 to overlap IO bound tasks (reading and writing files on disk) with CPU

0 commit comments

Comments
 (0)