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

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

Merged
merged 29 commits into from
Nov 1, 2018
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
2f43244
refactor doc
scarlett2018 Oct 18, 2018
01dd6e7
update with Mao's suggestions
scarlett2018 Oct 19, 2018
e034529
Set theme jekyll-theme-dinky
scarlett2018 Oct 19, 2018
6447fb1
update doc
scarlett2018 Oct 22, 2018
2bd43e5
fix links
scarlett2018 Oct 22, 2018
6a11b6c
fix links
scarlett2018 Oct 22, 2018
e229100
fix links
scarlett2018 Oct 22, 2018
cba517c
merge
scarlett2018 Oct 25, 2018
781ee75
merge
scarlett2018 Oct 25, 2018
4a4804f
fix links and doc errors
scarlett2018 Oct 25, 2018
091e502
merge
scarlett2018 Oct 25, 2018
c6b3d35
merge
scarlett2018 Oct 25, 2018
b141cff
merge
scarlett2018 Oct 25, 2018
47da3ba
merge
scarlett2018 Oct 25, 2018
0199e6a
Merge remote-tracking branch 'upstream/master'
scarlett2018 Oct 26, 2018
4a8c8a9
Quick fix nnictl config logic (#289)
SparkSnail Oct 31, 2018
ccc3939
merge
scarlett2018 Oct 31, 2018
1ce3310
merge
scarlett2018 Oct 31, 2018
3e8920a
updated the "Contribute" part (merged Gems' wiki in, updated ReadMe)
scarlett2018 Oct 31, 2018
91fd9b6
fix link
scarlett2018 Oct 31, 2018
a2ca6f1
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 1, 2018
fa08220
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 1, 2018
9fdc11e
revise the installation cmd to v0.2
scarlett2018 Nov 1, 2018
d777f13
revise to install v0.2
scarlett2018 Nov 1, 2018
3bc77dc
Merge branch 'v0.3' into master
chicm-ms Nov 1, 2018
233c7ee
Update nnictl_utils.py
scarlett2018 Nov 1, 2018
13fb771
Update nnictl_utils.py
QuanluZhang Nov 1, 2018
e0f31db
Update nnictl_utils.py
QuanluZhang Nov 1, 2018
edb4bc7
Merge branch 'master' into master
scarlett2018 Nov 1, 2018
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
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,15 @@ 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 `pip install` 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
python3 -m pip install -v --user git+https://github.com/Microsoft/nni.git@v0.2
source ~/.bashrc
```
* Run the mnist example.

**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
```
Expand All @@ -51,7 +43,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.
```

Expand Down
7 changes: 4 additions & 3 deletions docs/InstallNNI_Ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down