Installation.md 1.2 KB
Newer Older
1
**Installation of NNI**
Scarlett Li's avatar
Scarlett Li committed
2
3
===

4
5
Currently we only support installation on Linux & Mac.

Scarlett Li's avatar
Scarlett Li committed
6
7
8
9
10
11
12
## **Installation**
* __Dependencies__

      python >= 3.5
      git
      wget

13
    python pip should also be correctly installed. You could use "python3 -m pip -v" to check pip version. 
Scarlett Li's avatar
Scarlett Li committed
14
15
16

* __Install NNI through pip__

Gems Guo's avatar
Gems Guo committed
17
      python3 -m pip install --user --upgrade nni
Scarlett Li's avatar
Scarlett Li committed
18
19
20

* __Install NNI through source code__
   
21
      git clone -b v0.4 https://github.com/Microsoft/nni.git
Scarlett Li's avatar
Scarlett Li committed
22
23
24
      cd nni
      source install.sh

25
26
* __Install NNI in docker image__

27
    You can also install NNI in a docker image. Please follow the instructions [here](../deployment/docker/README.md) to build NNI docker image. The NNI docker image can also be retrieved from Docker Hub through the command `docker pull msranni/nni:latest`.
28

Scarlett Li's avatar
Scarlett Li committed
29
30
31
32
33
34
35
36
37
## Further reading
* [Overview](Overview.md)
* [Use command line tool nnictl](NNICTLDOC.md)
* [Use NNIBoard](WebUI.md)
* [Define search space](SearchSpaceSpec.md)
* [Config an experiment](ExperimentConfig.md)
* [How to run an experiment on local (with multiple GPUs)?](tutorial_1_CR_exp_local_api.md)
* [How to run an experiment on multiple machines?](tutorial_2_RemoteMachineMode.md)
* [How to run an experiment on OpenPAI?](PAIMode.md)