Installation.md 3.97 KB
Newer Older
Yan Ni's avatar
Yan Ni committed
1
# Installation of NNI
Scarlett Li's avatar
Scarlett Li committed
2

3
Currently we support installation on Linux, Mac and Windows(local mode).
4

5
## **Installation on Linux & Mac**
Scarlett Li's avatar
Scarlett Li committed
6
7
8

* __Install NNI through pip__

Yan Ni's avatar
Yan Ni committed
9
  Prerequisite: `python >= 3.5`
Chi Song's avatar
Chi Song committed
10
  ```bash
Yan Ni's avatar
Yan Ni committed
11
  python3 -m pip install --upgrade nni
Chi Song's avatar
Chi Song committed
12
  ```
Scarlett Li's avatar
Scarlett Li committed
13
14

* __Install NNI through source code__
Chi Song's avatar
Chi Song committed
15

16
  Prerequisite: `python >=3.5`, `git`, `wget`
Chi Song's avatar
Chi Song committed
17
  ```bash
18
  git clone -b v0.7 https://github.com/Microsoft/nni.git
Chi Song's avatar
Chi Song committed
19
  cd nni
Yan Ni's avatar
Yan Ni committed
20
  ./install.sh
Chi Song's avatar
Chi Song committed
21
  ```
Scarlett Li's avatar
Scarlett Li committed
22

23
24
* __Install NNI in docker image__

Yan Ni's avatar
Yan Ni committed
25
  You can also install NNI in a docker image. Please follow the instructions [here](https://github.com/Microsoft/nni/tree/master/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`.
26

27
28
29
30
31
32
## **Installation on Windows** 
  When you use powershell to run script for the first time, you need **run powershell as administrator** with this command:
  ```bash
  Set-ExecutionPolicy -ExecutionPolicy Unrestricted
  ```
  Anaconda is highly recommanded.
33
34
* __Install NNI through pip__

35
  Prerequisite: `python(64-bit) >= 3.5`
36
37
38
39
40
41
42
  ```bash
  python -m pip install --upgrade nni
  ```

* __Install NNI through source code__

  Prerequisite: `python >=3.5`, `git`, `powershell`    
43
  you can install nni as administrator or current user as follows:
44
  ```bash
45
  git clone -b v0.7 https://github.com/Microsoft/nni.git
46
47
48
49
  cd nni
  powershell ./install.ps1
  ```

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
## **System requirements**

Below are the minimum system requirements for NNI on Linux. Due to potential programming changes, the minimum system requirements for NNI may change over time.

||Minimum Requirements|Recommended Specifications|
|---|---|---|
|**Operating System**|Ubuntu 16.04 or above|Ubuntu 16.04 or above|
|**CPU**|Intel® Core™ i3 or AMD Phenom™ X3 8650|Intel® Core™ i5 or AMD Phenom™ II X3 or better|
|**GPU**|NVIDIA® GeForce® GTX 460|NVIDIA® GeForce® GTX 660 or better|
|**Memory**|4 GB RAM|6 GB RAM|
|**Storage**|30 GB available hare drive space|
|**Internet**|Boardband internet connection|
|**Resolution**|1024 x 768 minimum display resolution|

Below are the minimum system requirements for NNI on macOS. Due to potential programming changes, the minimum system requirements for NNI may change over time.

||Minimum Requirements|Recommended Specifications|
|---|---|---|
|**Operating System**|macOS 10.14.1 (latest version)|macOS 10.14.1 (latest version)|
|**CPU**|Intel® Core™ i5-760 or better|Intel® Core™ i7-4770 or better|
|**GPU**|NVIDIA® GeForce® GT 750M or AMD Radeon™ R9 M290 or better|AMD Radeon™ R9 M395X or better|
|**Memory**|4 GB RAM|8 GB RAM|
|**Storage**|70GB available space 7200 RPM HDD|70GB available space SSD|
|**Internet**|Boardband internet connection|
|**Resolution**|1024 x 768 minimum display resolution|

76
Below are the minimum system requirements for NNI on Windows, Windows 10.1809 is well tested and recommend. Due to potential programming changes, the minimum system requirements for NNI may change over time.
77
78
79
80
81
82
83
84
85
86
87

||Minimum Requirements|Recommended Specifications|
|---|---|---|
|**Operating System**|Windows 10|Windows 10|
|**CPU**|Intel® Core™ i3 or AMD Phenom™ X3 8650|Intel® Core™ i5 or AMD Phenom™ II X3 or better|
|**GPU**|NVIDIA® GeForce® GTX 460|NVIDIA® GeForce® GTX 660 or better|
|**Memory**|4 GB RAM|6 GB RAM|
|**Storage**|30 GB available hare drive space|
|**Internet**|Boardband internet connection|
|**Resolution**|1024 x 768 minimum display resolution|

Scarlett Li's avatar
Scarlett Li committed
88
## Further reading
Chi Song's avatar
Chi Song committed
89

Scarlett Li's avatar
Scarlett Li committed
90
91
92
93
94
* [Overview](Overview.md)
* [Use command line tool nnictl](NNICTLDOC.md)
* [Use NNIBoard](WebUI.md)
* [Define search space](SearchSpaceSpec.md)
* [Config an experiment](ExperimentConfig.md)
95
* [How to run an experiment on local (with multiple GPUs)?](LocalMode.md)
Yan Ni's avatar
Yan Ni committed
96
* [How to run an experiment on multiple machines?](RemoteMachineMode.md)
Scarlett Li's avatar
Scarlett Li committed
97
* [How to run an experiment on OpenPAI?](PAIMode.md)
Yan Ni's avatar
Yan Ni committed
98
* [How to run an experiment on Kubernetes through Kubeflow?](KubeflowMode.md)
99
* [How to run an experiment on Kubernetes through FrameworkController?](FrameworkControllerMode.md)