diff --git a/README.md b/README.md index a416e9c85c..a85ddddfb2 100644 --- a/README.md +++ b/README.md @@ -22,23 +22,16 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search ## **Install & Verify** -**Install through source code** -* We only support Linux (Ubuntu 16.04 or higher) in our current stage. -* Run the following commands in an environment that has `python >= 3.5`, `git` and `wget`. -```bash - git clone -b v0.3 https://github.com/Microsoft/nni.git - cd nni - source install.sh -``` +**pip install** +* We only support Linux in current stage, Ubuntu 16.04 or higher are tested and supported. Simply run the following `pip install` in an environment that has `python >= 3.5`, `git` and `wget`. -**Verify install** -* The following example is an experiment built on TensorFlow. Make sure you have `TensorFlow installed` before running it. -* Download the examples via clone the source code. -```bash - cd ~ - git clone -b v0.3 https://github.com/Microsoft/nni.git ``` -* Run the mnist example. +python3 -m pip install -v --user git+https://github.com/Microsoft/nni.git@v0.2 +source ~/.bashrc +``` + +**verify install** +* The following example is an experiment built on TensorFlow, make sure you have `TensorFlow installed` before running it. ```bash nnictl create --config ~/nni/examples/trials/mnist/config.yml ``` @@ -51,7 +44,7 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search Info: Checking web ui... Info: Starting web ui... Info: Starting web ui success! -+ Info: Web UI url: http://127.0.0.1:8080 http://10.172.141.6:8080 ++ Info: Web UI url: http://yourlocalhost:8080 http://youripaddress:8080 + Info: Start experiment success! The experiment id is LrNK4hae, and the restful server post is 51188. ``` diff --git a/docs/InstallNNI_Ubuntu.md b/docs/InstallNNI_Ubuntu.md index 12f6335ef8..fc3f64f798 100644 --- a/docs/InstallNNI_Ubuntu.md +++ b/docs/InstallNNI_Ubuntu.md @@ -12,15 +12,16 @@ * __Install NNI through pip__ - python3 -m pip install --user nni-pkg + pip3 install -v --user git+https://github.com/Microsoft/nni.git@v0.2 + source ~/.bashrc * __Install NNI through source code__ - git clone -b v0.3 https://github.com/Microsoft/nni.git + git clone -b v0.2 https://github.com/Microsoft/nni.git cd nni + chmod +x install.sh source install.sh - ## Further reading * [Overview](Overview.md) * [Use command line tool nnictl](NNICTLDOC.md)