Unverified Commit 30527cf6 authored by Scarlett Li's avatar Scarlett Li Committed by GitHub
Browse files

revert master's installation doc to install v0.2 before v0.3 official release. (#298)

* refactor doc

* update with Mao's suggestions

* Set theme jekyll-theme-dinky

* update doc

* fix links

* fix links

* fix links

* merge

* fix links and doc errors

* merge

* merge

* merge

* merge

* Quick fix nnictl config logic (#289)

* fix nnictl bug

* fix install.sh

* add desc for Dockerfile.build.base

* update document for Dockerfile

* update

* refactor port detect

* update

* refactor NNICTLDOC.md

* add document for pai and nnictl

* add default value for port

* add exception handling in trial_keeper.py

* fix port bug

* fix resume

* fix nnictl resume and fix nnictl stop

* fix document

* update

* refactor nnictl

* update

* update doc

* update

* update nnictl

* fix comment

* revert dockerfile

* update

* update

* update

* fix nnictl error hit

* fix comments

* fix bash-completion

* fix paramiko install

* quick fix resume logic

* update

* quick fix nnictl

* merge

* updated the "Contribute" part (merged Gems' wiki in, updated ReadMe)

* fix link

* revise the installation cmd to v0.2

* revise to install v0.2

* Update nnictl_utils.py

* Update nnictl_utils.py

* Update nnictl_utils.py
parent 5bb544ff
...@@ -22,23 +22,16 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search ...@@ -22,23 +22,16 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search
## **Install & Verify** ## **Install & Verify**
**Install through source code** **pip install**
* We only support Linux (Ubuntu 16.04 or higher) in our current stage. * 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`.
* 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
```
**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 ```bash
nnictl create --config ~/nni/examples/trials/mnist/config.yml 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 ...@@ -51,7 +44,7 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search
Info: Checking web ui... Info: Checking web ui...
Info: Starting web ui... Info: Starting web ui...
Info: Starting web ui success! 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. + Info: Start experiment success! The experiment id is LrNK4hae, and the restful server post is 51188.
``` ```
......
...@@ -12,15 +12,16 @@ ...@@ -12,15 +12,16 @@
* __Install NNI through pip__ * __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__ * __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 cd nni
chmod +x install.sh
source install.sh source install.sh
## Further reading ## Further reading
* [Overview](Overview.md) * [Overview](Overview.md)
* [Use command line tool nnictl](NNICTLDOC.md) * [Use command line tool nnictl](NNICTLDOC.md)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment