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

Refactor the README #1174

Merged
merged 68 commits into from
Jun 13, 2019
Merged
Changes from all commits
Commits
Show all changes
68 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
e941d70
merge
scarlett2018 Nov 2, 2018
3b0d00a
Merge branch 'master' of https://github.com/scarlett2018/nni
scarlett2018 Nov 2, 2018
a889587
Update documentation for v0.3
scarlett2018 Nov 2, 2018
d4eb8b6
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 5, 2018
804b3be
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 5, 2018
f232d44
update release note
scarlett2018 Nov 5, 2018
f8877f3
update v0.3.0 release note +1
scarlett2018 Nov 5, 2018
f885c0e
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 5, 2018
3586cfe
update doc for installation tag v0.3.3
scarlett2018 Nov 5, 2018
8886ddb
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 6, 2018
25626d5
fix contributing doc problems
scarlett2018 Nov 7, 2018
d3f71d7
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 7, 2018
7797869
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 12, 2018
800751c
update doc for "write trial"
scarlett2018 Nov 12, 2018
abeea90
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 13, 2018
f9e1a86
fix link
scarlett2018 Nov 13, 2018
b2c29cf
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 13, 2018
03b9a39
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 20, 2018
fba0f05
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 20, 2018
07366d1
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 29, 2018
248d590
issue 414
scarlett2018 Nov 29, 2018
e2371c2
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 4, 2018
e63e760
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 4, 2018
6cf7a82
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 5, 2018
69fbaac
update arch overview diagram in README
scarlett2018 Dec 5, 2018
5692405
update image
scarlett2018 Dec 5, 2018
61ed010
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 5, 2018
759fa29
fix broken link
scarlett2018 Dec 5, 2018
7a6c712
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 7, 2018
03271af
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 7, 2018
b1c8356
correct typo
scarlett2018 Dec 7, 2018
9b94995
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 10, 2018
389a3ef
Merge remote-tracking branch 'upstream/master'
scarlett2018 Dec 25, 2018
94a9b2b
Merge remote-tracking branch 'upstream/master'
scarlett2018 Jan 3, 2019
b9da492
Adding related projects to Readme
scarlett2018 Jan 3, 2019
b5b368d
Merge remote-tracking branch 'upstream/master'
scarlett2018 Jan 4, 2019
96a1b83
Merge remote-tracking branch 'upstream/master'
scarlett2018 Jan 14, 2019
fe31f9a
Merge remote-tracking branch 'upstream/master'
scarlett2018 Jun 12, 2019
894a2aa
refact Readme
scarlett2018 Jun 12, 2019
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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,6 @@ We encourage researchers and students leverage these projects to accelerate the

## **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**

* 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`.
Expand All @@ -124,6 +118,12 @@ python3 -m pip install --upgrade nni

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
python -m pip install --upgrade nni
```
Expand Down