Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs of building from source #4004

Merged
merged 2 commits into from
Aug 3, 2021
Merged

Update docs of building from source #4004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b35b901
update build doc
Aug 2, 2021
72cf81c
.
Aug 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/en_US/Tutorial/InstallationLinux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Install NNI through source code

git clone -b v2.3 https://github.com/Microsoft/nni.git
cd nni
python3 -m pip install --upgrade pip setuptools
python3 -m pip install -U -r dependencies/setup.txt
python3 -m pip install -r dependencies/develop.txt
python3 setup.py develop

Build wheel package from NNI source code
Expand All @@ -40,7 +41,8 @@ If you want to perform a persist install instead, we recommend to build your own
git clone -b v2.3 https://github.com/Microsoft/nni.git
cd nni
export NNI_RELEASE=2.0
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -U -r dependencies/setup.txt
python3 -m pip install -r dependencies/develop.txt
python3 setup.py clean --all
python3 setup.py build_ts
python3 setup.py bdist_wheel -p manylinux1_x86_64
Expand Down
2 changes: 2 additions & 0 deletions docs/en_US/Tutorial/InstallationWin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ If you want to contribute to NNI, refer to `setup development environment <Setup

git clone -b v2.3 https://github.com/Microsoft/nni.git
cd nni
python -m pip install -U -r dependencies/setup.txt
python -m pip install -r dependencies/develop.txt
python setup.py develop

Verify installation
Expand Down
3 changes: 2 additions & 1 deletion docs/en_US/Tutorial/SetupNniDeveloperEnvironment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Note, if you want to contribute code back, it needs to fork your own NNI repo, a

.. code-block:: bash

python3 -m pip install --upgrade pip setuptools
python3 -m pip install -U -r dependencies/setup.txt
python3 -m pip install -r dependencies/develop.txt
python3 setup.py develop

This installs NNI in `development mode <https://setuptools.readthedocs.io/en/latest/userguide/development_mode.html>`__,
Expand Down
10 changes: 9 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
If release version is not set, default to a development build whose version string will be `999.dev0`.


## Prepare Environment ##

Install development dependencies:

$ pip install -U -r dependencies/setup.txt
$ pip install -r dependencies/develop.txt


## Development ##

Build and install for development:
Expand All @@ -23,7 +31,7 @@

$ python setup.py clean [--all]

Build TypeScript modules without install:
Compile TypeScript modules without re-install:

$ python setup.py build_ts

Expand Down