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

update top README.md #622

Merged
merged 45 commits into from
Jan 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
f3870e9
update
Jan 16, 2019
7264294
update
Jan 16, 2019
bb494f8
update
Jan 16, 2019
0c4b11b
update
Jan 17, 2019
921de49
update
Jan 17, 2019
a2364bc
update
Jan 17, 2019
169fb09
update
Jan 17, 2019
9e30e1b
update
Jan 17, 2019
65c9e2a
update
Jan 17, 2019
dbecca1
update
Jan 17, 2019
16a6632
update
Jan 17, 2019
5bd3aa0
update
Jan 17, 2019
96c8f5c
Update README.md
goooxu Jan 17, 2019
2159154
update
Jan 17, 2019
d3d11d0
Merge branch 'update-doc11' of https://github.com/QuanluZhang/nni int…
Jan 17, 2019
c0789e7
Update README.md
goooxu Jan 17, 2019
756b849
Update README.md
goooxu Jan 17, 2019
409e827
Update README.md
goooxu Jan 17, 2019
6af9490
Update README.md
goooxu Jan 17, 2019
59a7afd
Create demo.svg
goooxu Jan 18, 2019
61b588a
Update demo.svg
goooxu Jan 18, 2019
a9b8ca0
Update demo.svg
goooxu Jan 18, 2019
05105bd
Update demo.svg
goooxu Jan 18, 2019
5803559
Create demo1.svg
goooxu Jan 18, 2019
1694681
Update demo1.svg
goooxu Jan 18, 2019
5ee5aca
Create demo2.svg
goooxu Jan 18, 2019
01924e5
Update demo2.svg
goooxu Jan 18, 2019
b0fcde8
Update demo2.svg
goooxu Jan 18, 2019
b7b1721
Update demo2.svg
goooxu Jan 18, 2019
895d07c
Create demo3.svg
goooxu Jan 18, 2019
e865e85
Update README.md
goooxu Jan 18, 2019
82275df
Delete demo3.svg
goooxu Jan 18, 2019
bbc9595
Delete demo2.svg
goooxu Jan 18, 2019
abaece7
Delete demo1.svg
goooxu Jan 18, 2019
b12aec4
Delete demo.svg
goooxu Jan 18, 2019
e6ca746
Create overview.svg
goooxu Jan 18, 2019
4a0186a
Update README.md
goooxu Jan 18, 2019
bb3b545
Update README.md
goooxu Jan 18, 2019
f12ec9a
Update README.md
goooxu Jan 18, 2019
a497e49
Update README.md
goooxu Jan 18, 2019
ad5935f
Update overview.svg
goooxu Jan 18, 2019
0a01d48
Create good.svg
goooxu Jan 18, 2019
e923faf
Delete good.svg
goooxu Jan 18, 2019
54cf0c7
Update README.md
yangou1988 Jan 18, 2019
98fda57
Merge pull request #3 from yangou1988/patch-1
QuanluZhang Jan 18, 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
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,71 @@
NNI (Neural Network Intelligence) is a toolkit to help users run automated machine learning (AutoML) experiments.
The tool dispatches and runs trial jobs generated by tuning algorithms to search the best neural architecture and/or hyper-parameters in different environments like local machine, remote servers and cloud.

### **NNI [v0.5](https://github.com/Microsoft/nni/releases) has been released!**
<p align="center">
<img src="./docs/img/nni_arch_overview.png" alt="drawing"/>
<a href=#><img src="https://rawgit.com/QuanluZhang/nni/update-doc11/overview.svg" /></a>
</p>
<table>
<tbody>
<tr align="center">
<td>
<b>User Code + SDK( import in )</b>
<img src="https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png"/>
</td>
<td>
<b>Tunning Algorithm Extensions</b>
<img src="https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png"/>
</td>
<td>
<b>Training Service Extensions</b>
<img src="https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png"/>
</td>
</tr>
<tr/>
<tr valign="top">
<td>
<ul>
<li>CNTK</li>
<li>Tensorflow</li>
<li>PyTorch</li>
<li>Keras</li>
<li>...</li>
</ul>
(Python based frameworks)
</td>
<td>
<a href="docs/HowToChooseTuner.md">Tuner</a>
<ul>
<li><a href="docs/HowToChooseTuner.md#TPE">TPE</a></li>
<li><a href="docs/HowToChooseTuner.md#Random">Random Search</a></li>
<li><a href="docs/HowToChooseTuner.md#Anneal">Anneal</a></li>
<li><a href="docs/HowToChooseTuner.md#Evolution">Naive Evolution</a></li>
<li><a href="docs/HowToChooseTuner.md#SMAC">SMAC</a></li>
<li><a href="docs/HowToChooseTuner.md#Batch">Batch</a></li>
<li><a href="docs/HowToChooseTuner.md#Grid">Grid Search</a></li>
<li><a href="docs/HowToChooseTuner.md#Hyperband">Hyperband</a></li>
<li><a href="docs/HowToChooseTuner.md#NetworkMorphism">Network Morphism</a></li>
<li><a href="examples/tuners/enas_nni/README.md">ENAS</a></li>
<li><a href="docs/HowToChooseTuner.md#NetworkMorphism#MetisTuner">Metis Tuner</a></li>
</ul>
<a href="docs/HowToChooseTuner.md#assessor">Assessor</a>
<ul>
<li><a href="docs/HowToChooseTuner.md#Medianstop">Median Stop</a></li>
<li><a href="docs/HowToChooseTuner.md#Curvefitting">Curve Fitting</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="docs/tutorial_1_CR_exp_local_api.md">Local Machine</a></li>
<li><a href="docs/tutorial_2_RemoteMachineMode.md">Remote Servers</a></li>
<li><a href="docs/PAIMode.md">OpenPAI</a></li>
<li><a href="docs/KubeflowMode.md">Kubeflow</a></li>
<li><a href="docs/KubeflowMode.md">FrameworkController on K8S (AKS etc.)</a></li>
</ul>
</td>
</tr>
</tbody>
</table>

## **Who should consider using NNI**
* Those who want to try different AutoML algorithms in their training code (model) at their local machine.
Expand Down
2 changes: 1 addition & 1 deletion docs/HowToChooseTuner.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ _Usage_:
optimize_mode: maximize
```


<a name="assessor"></a>
# How to use Assessor that NNI supports?

For now, NNI has supported the following assessor algorithms.
Expand Down
3 changes: 1 addition & 2 deletions docs/NNICTLDOC.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
nnictl
# nnictl

===

## Introduction

Expand Down
1 change: 1 addition & 0 deletions overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.