Commit c1a5b1ee authored by Scarlett Li's avatar Scarlett Li Committed by xuehui
Browse files

Refactor the README (#1174)

* 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

* Update documentation for v0.3

* update release note

* update v0.3.0 release note +1

* update doc for installation tag v0.3.3

* fix contributing doc problems

* update doc for "write trial"

* fix link

* issue 414

* update arch overview diagram in README

* update image

* fix broken link

* correct typo

* Adding related projects to Readme

* refact Readme
parent 7bf221f2
...@@ -106,12 +106,6 @@ We encourage researchers and students leverage these projects to accelerate the ...@@ -106,12 +106,6 @@ We encourage researchers and students leverage these projects to accelerate the
## **Install & Verify** ## **Install & Verify**
If you are using NNI on Windows and use PowerShell to run script for the first time, you need to **run PowerShell as administrator** with this command first:
```bash
Set-ExecutionPolicy -ExecutionPolicy Unrestricted
```
**Install through pip** **Install through pip**
* We support Linux, MacOS and Windows(local, remote and pai mode) in current stage, Ubuntu 16.04 or higher, MacOS 10.14.1 along with Windows 10.1809 are tested and supported. Simply run the following `pip install` in an environment that has `python >= 3.5`. * We support Linux, MacOS and Windows(local, remote and pai mode) in current stage, Ubuntu 16.04 or higher, MacOS 10.14.1 along with Windows 10.1809 are tested and supported. Simply run the following `pip install` in an environment that has `python >= 3.5`.
...@@ -124,6 +118,12 @@ python3 -m pip install --upgrade nni ...@@ -124,6 +118,12 @@ python3 -m pip install --upgrade nni
Windows Windows
**IMPORTANT** Make sure `ExecutionPolicy` has been set to `Unrestricted` before installation. To set the policy, **run PowerShell as administrator** with the following command:
```bash
Set-ExecutionPolicy -ExecutionPolicy Unrestricted
```
Once ExecutionPolicy is unrestricted, run the following command to install NNI:
```bash ```bash
python -m pip install --upgrade nni python -m pip install --upgrade nni
``` ```
......
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