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

Updated document for "write a trial" related fixes. #351

Merged
merged 45 commits into from
Nov 13, 2018
Merged
Show file tree
Hide file tree
Changes from 43 commits
Commits
Show all changes
45 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
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
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,17 @@ You can use these commands to get more information about the experiment
</table>

## **Documentation**
* [Overview](docs/Overview.md)
* [Get started](docs/GetStarted.md)
* [NNI overview](docs/Overview.md)
* [Quick start](docs/GetStarted.md)

## **How to**
* [Installation](docs/InstallNNI_Ubuntu.md)
* [Install NNI](docs/InstallNNI_Ubuntu.md)
* [Use command line tool nnictl](docs/NNICTLDOC.md)
* [Use NNIBoard](docs/WebUI.md)
* [How to define search space](docs/SearchSpaceSpec.md)
* [How to define a trial](docs/howto_1_WriteTrial.md)
* [Config an experiment](docs/ExperimentConfig.md)
* [Use annotation](docs/AnnotationSpec.md)
* [Debug](docs/HowToDebug.md)
* [How to use annotation](docs/howto_1_WriteTrial.md#nni-python-annotation)
## **Tutorials**
* [Run an experiment on local (with multiple GPUs)?](docs/tutorial_1_CR_exp_local_api.md)
* [Run an experiment on multiple machines?](docs/tutorial_2_RemoteMachineMode.md)
Expand Down
33 changes: 10 additions & 23 deletions docs/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

NNI (Neural Network Intelligence) is a toolkit to help users run automated machine learning experiments. For each experiment, user only need to define a search space and update a few lines of code, and then leverage NNI build-in algorithms and training services to search the best hyper parameters and/or neural architecture.

>Step 1: [Define search space](SearchSpaceSpec.md)

>Step 2: [Update model codes](howto_1_WriteTrial.md)

>Step 3: [Define Experiment](ExperimentConfig.md)


<p align="center">
<img src="./img/3_steps.jpg" alt="drawing"/>
</p>
Expand All @@ -15,11 +22,6 @@ After user submits the experiment through a command line tool [nnictl](../tools/

User can use the nnictl and/or a visualized Web UI nniboard to monitor and debug a given experiment.

<p align="center">
<img src="./img/overview.jpg" alt="drawing"/>
</p>


NNI provides a set of examples in the package to get you familiar with the above process. In the following example [/examples/trials/mnist], we had already set up the configuration and updated the training codes for you. You can directly run the following command to start an experiment.

## Key Concepts
Expand All @@ -35,28 +37,13 @@ NNI provides a set of examples in the package to get you familiar with the above
### **Assessor**
**Assessor** in NNI is an implementation of Assessor API for optimizing the execution of experiment.


## Learn More
* [Get started](GetStarted.md)
### **How to**
* [Installation](InstallNNI_Ubuntu.md)
* [Install NNI](InstallNNI_Ubuntu.md)
* [Use command line tool nnictl](NNICTLDOC.md)
* [Use NNIBoard](WebUI.md)
* [Define search space](InstallNNI_Ubuntu.md)
* [Use NNI sdk] - *coming soon*
* [Config an experiment](SearchSpaceSpec.md)
* [Use annotation](AnnotationSpec.md)
* [Debug](HowToDebug.md)
* [Use annotation](howto_1_WriteTrial.md#nni-python-annotation)
### **Tutorials**
* [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)
* [Try different tuners and assessors] - *coming soon*
* [How to run an experiment on K8S services?] - *coming soon*
* [Implement a customized tuner] - *coming soon*
* [Implement a customized assessor] - *coming soon*
* [Implement a custmoized weight sharing algorithm] - *coming soon*
* [How to integrate NNI with your own custmoized training service] - *coming soon*
### **Best practice**
* [Compare different AutoML algorithms] - *coming soon*
* [Serve NNI as a capability of a ML Platform] - *coming soon*
* [How to run an experiment on OpenPAI?](PAIMode.md)