Skip to content

GitLab

"driver/vscode:/vscode.git/clone" did not exist on "0f52c4c0e4c512c728261c05c5e2a367283bd18f"
Unverified Commit fd0fe924 authored by QuanluZhang's avatar QuanluZhang Committed by GitHub
Browse files

update top README.md (#622) 

* Update README.md
parent 92d32dcf
Show whitespace changes
Inline Side-by-side
Showing with 66 additions and 4 deletions
README.md
View file @ fd0fe924
...@@ -14,9 +14,71 @@ ...@@ -14,9 +14,71 @@
NNI (Neural Network Intelligence) is a toolkit to help users run automated machine learning (AutoML) experiments. 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. 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"> <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> </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** ## **Who should consider using NNI**
* Those who want to try different AutoML algorithms in their training code (model) at their local machine. * Those who want to try different AutoML algorithms in their training code (model) at their local machine.
......
docs/HowToChooseTuner.md
View file @ fd0fe924
...@@ -244,7 +244,7 @@ _Usage_: ...@@ -244,7 +244,7 @@ _Usage_:
optimize_mode: maximize optimize_mode: maximize
``` ```
<a name="assessor"></a>
# How to use Assessor that NNI supports? # How to use Assessor that NNI supports?
For now, NNI has supported the following assessor algorithms. For now, NNI has supported the following assessor algorithms.
......
docs/NNICTLDOC.md
View file @ fd0fe924
nnictl # nnictl
===
## Introduction ## Introduction
......
overview.svg 0 → 100644
View file @ fd0fe924
<svg id="图层_1" data-name="图层 1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 806.55 233.23"><defs><style>.cls-1,.cls-10,.cls-11,.cls-12,.cls-2,.cls-3,.cls-5,.cls-9{fill:none;}.cls-1{clip-rule:evenodd;}.cls-14,.cls-2{fill-rule:evenodd;}.cls-11,.cls-3{stroke:#c1c1c1;}.cls-3{stroke-miterlimit:10;}.cls-14,.cls-4{fill:#fff;}.cls-12,.cls-5{stroke:#000;}.cls-10,.cls-11,.cls-12,.cls-5,.cls-9{stroke-miterlimit:8;stroke-width:1.53px;}.cls-6{font-size:18px;fill:#0071bc;font-family:SegoeUI, Segoe UI;}.cls-7{letter-spacing:-0.1em;}.cls-8{font-family:SegoeUIBlack, Segoe UI;}.cls-10,.cls-9{stroke:#505050;}.cls-10,.cls-11,.cls-12{stroke-linecap:square;}.cls-13{clip-path:url(#clip-path);}</style><clipPath id="clip-path"><polygon class="cls-1" points="643.38 226.46 702.27 226.46 702.27 171.36 643.38 171.36 643.38 226.46 643.38 226.46"/></clipPath></defs><title>overview</title><path class="cls-3" d="M701.49,57.48H104.59"/><path class="cls-3" d="M110.48,198.91H686.9"/><path class="cls-3" d="M104.59,198.91a70.72,70.72,0,0,1,0-141.43"/><path class="cls-3" d="M698.51,57.48a70.72,70.72,0,0,1,0,141.43"/><path class="cls-4" d="M396.26,164a34.61,34.61,0,1,1-34.59,34.6A34.6,34.6,0,0,1,396.26,164"/><path class="cls-4" d="M134.8,154.46a42,42,0,1,1-42,42,42,42,0,0,1,42-42"/><path class="cls-5" d="M377.34,201.92c0-1-.15-2-.15-3a20.37,20.37,0,0,1,20.27-20.48c1,0,1.84.14,2.69.14m-8.36,40.11a24.59,24.59,0,0,0,5.67.71,20.37,20.37,0,0,0,20.27-20.48,12.59,12.59,0,0,0-.15-2.44M397.46,215.1l-5.81,3.43,3.54,5.73m-.71-42.11,5.81-3.44L396.75,173M414,184h-8.36v8.31H414V184ZM383,216.1a5.88,5.88,0,1,0-5.81-5.87A5.9,5.9,0,0,0,383,216.1Z"/><path class="cls-4" d="M672.21,154.46a42,42,0,1,1-42,42,42,42,0,0,1,42-42"/><rect class="cls-4" x="210.1" y="23.41" width="86.5" height="113"/><rect class="cls-4" x="488.78" y="25.62" width="107" height="113"/><text class="cls-6" transform="translate(174.39 103.07)">Command Line <tspan class="cls-7" x="124.94" y="0">T</tspan><tspan x="132.61" y="0">ool</tspan><tspan class="cls-8"><tspan x="45.01" y="23.6">NNICTL</tspan></tspan></text><text class="cls-6" transform="translate(493.22 105.07)">Visualized UI<tspan class="cls-8"><tspan x="3.81" y="23.6">NNI Board</tspan></tspan></text><path class="cls-9" d="M240.73,53.54a12.69,12.69,0,1,1,12.69,12.38,12.55,12.55,0,0,1-12.69-12.38Zm20.42-21.33a23.92,23.92,0,0,0-7.73-1.28c-12.84,0-23.19,10.1-23.19,22.61A22.58,22.58,0,0,0,243.5,74m2.19.85a22.63,22.63,0,0,0,7.73,1.28c12.83,0,23.19-10.1,23.19-22.62a22.48,22.48,0,0,0-1.17-7m-.87-2.42a23.09,23.09,0,0,0-10.79-10.81m-4.09,5.55-1.17,3.27m10.8,5.54L265.23,49m-.14,9.25,4.08,1.56m-8.9,8.82-1.89-3.7m-11.09,3.84,1.61-3.69M238.1,59.8l3.65-1.42M238.1,47.71,241.6,49m7.15-7-1.6-3.12"/><path class="cls-10" d="M567.21,74.12h-46.5V37.28h46.5V74.12m-46.5-27.63h45.74m-27.14,6.15h-12.4V68h12.4V52.64m4.65,0h9.3M544,58.77h9.3M544,64.91h6.2"/><polyline class="cls-3" points="357.3 194.3 361.8 198.62 357.3 202.95"/><polyline class="cls-3" points="625.71 194.3 630.21 198.62 625.71 202.95"/><path class="cls-4" d="M265.88,179.36a20,20,0,1,1-20,20,20,20,0,0,1,20-20"/><path class="cls-4" d="M537.65,179.34a20,20,0,1,1-20,20,20,20,0,0,1,20-20"/><path class="cls-11" d="M265.88,187.49A11.87,11.87,0,1,1,254,199.35a11.86,11.86,0,0,1,11.86-11.86ZM264,205.39l6-6-6-6"/><path class="cls-11" d="M537.65,187.49a11.87,11.87,0,1,1-11.86,11.86,11.86,11.86,0,0,1,11.86-11.86Zm-1.9,17.9,6-6-6-6"/><path class="cls-5" d="M112,177.18v8.74m17.11-8.74v8.74M146,177.18v8.74m-22.51-2.73v-3.28a2.88,2.88,0,0,0-3-2.73h0a2.88,2.88,0,0,0-3,2.73v3.28a3,3,0,0,0,3,2.91h0a3,3,0,0,0,3-2.91Zm16.93,0v-3.28a2.89,2.89,0,0,0-3-2.73h0a2.83,2.83,0,0,0-2.79,2.73v3.28a3,3,0,0,0,2.79,2.91h0a3,3,0,0,0,3-2.91Zm17.11,0v-3.28a3,3,0,0,0-3-2.73h0a2.88,2.88,0,0,0-3,2.73v3.28a3,3,0,0,0,3,2.91h0a3.17,3.17,0,0,0,3-2.91ZM112,206.85v8.92m17.11-8.92v8.92M146,206.85v8.92m-22.51-2.91v-3.1a2.9,2.9,0,0,0-3-2.91h0a2.9,2.9,0,0,0-3,2.91v3.1a2.91,2.91,0,0,0,3,2.91h0a2.91,2.91,0,0,0,3-2.91Zm16.93,0v-3.1a2.91,2.91,0,0,0-3-2.91h0a2.86,2.86,0,0,0-2.79,2.91v3.1a2.87,2.87,0,0,0,2.79,2.91h0a2.92,2.92,0,0,0,3-2.91Zm17.11,0v-3.1a3,3,0,0,0-3-2.91h0a2.9,2.9,0,0,0-3,2.91v3.1a2.91,2.91,0,0,0,3,2.91h0a3,3,0,0,0,3-2.91Zm-34-20.57V201m16.93-8.73V201M118,198.29V195a2.87,2.87,0,0,0-3-2.73h0a2.87,2.87,0,0,0-3,2.73v3.27a3,3,0,0,0,3,2.92h0a3,3,0,0,0,3-2.92Zm16.93,0V195a2.88,2.88,0,0,0-3-2.73h0a2.83,2.83,0,0,0-2.79,2.73v3.27a3,3,0,0,0,2.79,2.92h0a3,3,0,0,0,3-2.92Zm17.11,0V195a3,3,0,0,0-3-2.73h0a2.87,2.87,0,0,0-3,2.73v3.27a3,3,0,0,0,3,2.92h0a3.17,3.17,0,0,0,3-2.92Zm5.58-6V201"/><path class="cls-12" d="M691,208.69v.17H658.49a14.59,14.59,0,0,1-14.34-14.73,14.45,14.45,0,0,1,14.34-14.56,17.76,17.76,0,0,1,3,.17,15.64,15.64,0,0,1,13.34-7.62,15.84,15.84,0,0,1,15.67,14.39h0a11.1,11.1,0,0,1,.5,22.18Z"/><g class="cls-13"><polygon class="cls-14" points="670.15 197.38 699.21 197.38 699.21 226.46 670.15 226.46 670.15 197.38 670.15 197.38"/><g class="cls-13"><path class="cls-5" d="M682,194.24a3,3,0,0,1,6.05,0v1h4v4H678v-4h4v-1Zm-4,1h-4v25.87h22.17V195.24h-4m1,9.95h-8.07m8.07,6h-8.07m8.07,6h-8.07m-7-13.93,2,2,3-3m-5,7,2,2,3-3m-5,7,2,2,3-3"/></g></g></svg>
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