Skip to content
This repository was archived by the owner on Sep 18, 2024. It is now read-only.

Commit a9ebcf4

Browse files
authored
Update docs of building from source (#4004)
1 parent 0aea0a5 commit a9ebcf4

File tree

4 files changed

+17
-4
lines changed

4 files changed

+17
-4
lines changed

docs/en_US/Tutorial/InstallationLinux.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Install NNI through source code
2626
2727
git clone -b v2.3 https://github.com/Microsoft/nni.git
2828
cd nni
29-
python3 -m pip install --upgrade pip setuptools
29+
python3 -m pip install -U -r dependencies/setup.txt
30+
python3 -m pip install -r dependencies/develop.txt
3031
python3 setup.py develop
3132
3233
Build wheel package from NNI source code
@@ -40,7 +41,8 @@ If you want to perform a persist install instead, we recommend to build your own
4041
git clone -b v2.3 https://github.com/Microsoft/nni.git
4142
cd nni
4243
export NNI_RELEASE=2.0
43-
python3 -m pip install --upgrade pip setuptools wheel
44+
python3 -m pip install -U -r dependencies/setup.txt
45+
python3 -m pip install -r dependencies/develop.txt
4446
python3 setup.py clean --all
4547
python3 setup.py build_ts
4648
python3 setup.py bdist_wheel -p manylinux1_x86_64

docs/en_US/Tutorial/InstallationWin.rst

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ If you want to contribute to NNI, refer to `setup development environment <Setup
4242
4343
git clone -b v2.3 https://github.com/Microsoft/nni.git
4444
cd nni
45+
python -m pip install -U -r dependencies/setup.txt
46+
python -m pip install -r dependencies/develop.txt
4547
python setup.py develop
4648
4749
Verify installation

docs/en_US/Tutorial/SetupNniDeveloperEnvironment.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Note, if you want to contribute code back, it needs to fork your own NNI repo, a
2020

2121
.. code-block:: bash
2222
23-
python3 -m pip install --upgrade pip setuptools
23+
python3 -m pip install -U -r dependencies/setup.txt
24+
python3 -m pip install -r dependencies/develop.txt
2425
python3 setup.py develop
2526
2627
This installs NNI in `development mode <https://setuptools.readthedocs.io/en/latest/userguide/development_mode.html>`__,

setup.py

+9-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
If release version is not set, default to a development build whose version string will be `999.dev0`.
1010
1111
12+
## Prepare Environment ##
13+
14+
Install development dependencies:
15+
16+
$ pip install -U -r dependencies/setup.txt
17+
$ pip install -r dependencies/develop.txt
18+
19+
1220
## Development ##
1321
1422
Build and install for development:
@@ -23,7 +31,7 @@
2331
2432
$ python setup.py clean [--all]
2533
26-
Build TypeScript modules without install:
34+
Compile TypeScript modules without re-install:
2735
2836
$ python setup.py build_ts
2937

0 commit comments

Comments
 (0)