Setup NNI development environment¶
NNI development environment supports Ubuntu 1604 (or above), and Windows 10 with Python3 64bit.
1. Clone source code¶
git clone https://github.com/Microsoft/nni.git
Note, if you want to contribute code back, it needs to fork your own NNI repo, and clone from there.
2. Install from source code¶
python3 -m pip install --upgrade pip setuptools python3 setup.py develop
This installs NNI in development mode, so you don’t need to reinstall it after edit.
3. Check if the environment is ready¶
Now, you can try to start an experiment to check if your environment is ready. For example, run the command
nnictl create --config examples/trials/mnist-pytorch/config.yml
And open WebUI to check if everything is OK
4. Reload changes¶
Nothing to do, the code is already linked to package folders.
TypeScript (Linux and macOS)¶
ts/nni_manageris changed, run
yarn watchunder this folder. It will watch and build code continually. The
nnictlneed to be restarted to reload NNI manager.
ts/webuiis changed, run
yarn dev, which will run a mock API server and a webpack dev server simultaneously. Use
EXPERIMENTenvironment variable (e.g.,
mnist-tfv1-running) to specify the mock data being used. Built-in mock experiments are listed in
src/webui/mock. An example of the full command is
EXPERIMENT=mnist-tfv1-running yarn dev.
ts/nasuiis changed, run
yarn startunder the corresponding folder. The web UI will refresh automatically if code is changed. There is also a mock API server that is useful when developing. It can be launched via
Currently you must rebuild TypeScript modules with python3 setup.py build_ts after edit.
5. Submit Pull Request¶
All changes are merged to master branch from your forked repo. The description of Pull Request must be meaningful, and useful.
We will review the changes as soon as possible. Once it passes review, we will merge it to master branch.
For more contribution guidelines and coding styles, you can refer to the contributing document.