Commit 684fc312 authored by Gems Guo's avatar Gems Guo Committed by goooxu
Browse files

Update documents due to new pip installation approach

parent 4a54e11c
...@@ -21,15 +21,26 @@ The tool dispatches and runs trial jobs that generated by tuning algorithms to s ...@@ -21,15 +21,26 @@ The tool dispatches and runs trial jobs that generated by tuning algorithms to s
## **Install & Verify** ## **Install & Verify**
**pip install** **Install through pip**
* 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`.
```
python3 -m pip install --user nni-pkg
```
**Install through source code**
* 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`. * 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`.
``` ```
python3 -m pip install -v --user git+https://github.com/Microsoft/nni.git@v0.2 python3 -m pip install -v --user git+https://github.com/Microsoft/nni.git@v0.3
source ~/.bashrc source ~/.bashrc
``` ```
**verify install** **Verify install**
* The following example is an experiment built on TensorFlow, make sure you have `TensorFlow installed` before running it. * The following example is an experiment built on TensorFlow, make sure you have `TensorFlow installed` before running it.
* And download the examples via clone the source code
```bash
git clone https://github.com/Microsoft/nni.git@v0.3
```
* Then, run the mnist example
```bash ```bash
nnictl create --config ~/nni/examples/trials/mnist/config.yml nnictl create --config ~/nni/examples/trials/mnist/config.yml
``` ```
......
...@@ -64,7 +64,7 @@ RUN wget -qO- http://archive.apache.org/dist/hadoop/common/hadoop-${HADOOP_VERSI ...@@ -64,7 +64,7 @@ RUN wget -qO- http://archive.apache.org/dist/hadoop/common/hadoop-${HADOOP_VERSI
# #
#Install NNI #Install NNI
# #
RUN pip3 install -v --user git+https://github.com/Microsoft/nni.git@v0.2 RUN pip3 install --user nni-pkg
ENV JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 \ ENV JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 \
HADOOP_INSTALL=/usr/local/hadoop \ HADOOP_INSTALL=/usr/local/hadoop \
......
...@@ -14,12 +14,12 @@ ...@@ -14,12 +14,12 @@
* __Install NNI through pip__ * __Install NNI through pip__
python3 -m pip install -v --user git+https://github.com/Microsoft/nni.git@v0.2 python3 -m pip install --user nni-pkg
source ~/.bashrc source ~/.bashrc
* __Install NNI through source code__ * __Install NNI through source code__
git clone -b v0.2 https://github.com/Microsoft/nni.git git clone -b v0.3 https://github.com/Microsoft/nni.git
cd nni cd nni
chmod +x install.sh chmod +x install.sh
source install.sh source install.sh
......
...@@ -15,7 +15,7 @@ For remote machines that are used only to run trials but not the nnictl, you can ...@@ -15,7 +15,7 @@ For remote machines that are used only to run trials but not the nnictl, you can
* __Install python SDK through pip__ * __Install python SDK through pip__
python3 -m pip install --user git+https://github.com/Microsoft/NeuralNetworkIntelligence.git#subdirectory=src/sdk/pynni python3 -m pip install --user nni
* __Install python SDK through source code__ * __Install python SDK through source code__
......
...@@ -15,7 +15,7 @@ For remote machines that are used only to run trials but not the nnictl, you can ...@@ -15,7 +15,7 @@ For remote machines that are used only to run trials but not the nnictl, you can
* __Install python SDK through pip__ * __Install python SDK through pip__
python3 -m pip install --user git+https://github.com/Microsoft/NeuralNetworkIntelligence.git#subdirectory=src/sdk/pynni python3 -m pip install --user nni
* __Install python SDK through source code__ * __Install python SDK through source code__
......
...@@ -56,7 +56,7 @@ if python3 -c 'import nni' > /dev/null 2>&1; then ...@@ -56,7 +56,7 @@ if python3 -c 'import nni' > /dev/null 2>&1; then
return return
else else
# Install nni # Install nni
pip3 install -v --user git+https://github.com/Microsoft/nni.git@v0.2 pip3 install -v --user nnipkg
fi`; fi`;
export const PAI_TRIAL_COMMAND_FORMAT: string = export const PAI_TRIAL_COMMAND_FORMAT: string =
......
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