Skip to content

GitLab

Unverified Commit 3601044e authored by Lijiaoa's avatar Lijiaoa Committed by GitHub
Browse files

[doc] Update readthedocs index.html (#4296)

parent e50ca8d3
Hide whitespace changes
Inline Side-by-side
Showing with 514 additions and 165 deletions
docs/en_US/_templates/index.html
View file @ 3601044e
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
{% block document %} {% block document %}
<div> <div class="rowHeight">
<div class="chinese"><a href="https://nni.readthedocs.io/zh/stable/">简体中文</a></div> <div class="chinese"><a href="https://nni.readthedocs.io/zh/stable/">简体中文</a></div>
<b>NNI (Neural Network Intelligence)</b> is a lightweight but powerful toolkit to <b>NNI (Neural Network Intelligence)</b> is a lightweight but powerful toolkit to
help users <b>automate</b> help users <b>automate</b>
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
<a href="{{ pathto('Tuner/BuiltinTuner') }}">Hyperparameter Tuning</a> and <a href="{{ pathto('Tuner/BuiltinTuner') }}">Hyperparameter Tuning</a> and
<a href="{{ pathto('Compression/Overview') }}">Model Compression</a>. <a href="{{ pathto('Compression/Overview') }}">Model Compression</a>.
</div> </div>
<p class="topMargin"> <p class="gap rowHeight">
The tool manages automated machine learning (AutoML) experiments, The tool manages automated machine learning (AutoML) experiments,
<b>dispatches and runs</b> <b>dispatches and runs</b>
experiments' trial jobs generated by tuning algorithms to search the best neural experiments' trial jobs generated by tuning algorithms to search the best neural
...@@ -30,11 +30,11 @@ ...@@ -30,11 +30,11 @@
</p> </p>
<!-- Who should consider using NNI --> <!-- Who should consider using NNI -->
<div> <div>
<h1 class="title">Who should consider using NNI</h1> <h2 class="title">Who should consider using NNI</h2>
<ul> <ul>
<li>Those who want to <b>try different AutoML algorithms</b> in their training code/model.</li> <li>Those who want to <b>try different AutoML algorithms</b> in their training code/model.</li>
<li>Those who want to run AutoML trial jobs <b>in different environments</b> to speed up search.</li> <li>Those who want to run AutoML trial jobs <b>in different environments</b> to speed up search.</li>
<li>Researchers and data scientists who want to easily <b>implement and experiement new AutoML <li class="rowHeight">Researchers and data scientists who want to easily <b>implement and experiement new AutoML
algorithms</b> algorithms</b>
, may it be: hyperparameter tuning algorithm, , may it be: hyperparameter tuning algorithm,
neural architect search algorithm or model compression algorithm. neural architect search algorithm or model compression algorithm.
...@@ -42,21 +42,37 @@ ...@@ -42,21 +42,37 @@
<li>ML Platform owners who want to <b>support AutoML in their platform</b></li> <li>ML Platform owners who want to <b>support AutoML in their platform</b></li>
</ul> </ul>
</div> </div>
<!-- nni release to version --> <!-- what's new -->
<div class="inline"> <div>
<h3><a href="https://github.com/microsoft/nni/releases">NNI {{ release }} has been released!</a></h3> <div class="inline gap">
<img width="48" src="_static/img/release_icon.png"> <h2>What's NEW! </h2>
<img width="48" src="_static/img/release_icon.png">
</div>
<hr class="whatNew"/>
<ul>
<li><b>New release:</b> <a href='https://github.com/microsoft/nni/releases/tag/v2.5'>{{ release }} is available2 <i>- released on Nov-04-2021</i></a></li>
<li><b>New demo available:</b> <a href="https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw">Youtube entry</a> | <a href="https://space.bilibili.com/1649051673">Bilibili</a> 入口 <i>- last updated on May-26-2021</i></li>
<li><b>New webinar:</b> <a href="https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-On-Demand.html">
Introducing Retiarii: A deep learning exploratory-training framework on NNI
</a> <i>- scheduled on June-24-2021</i>
</li>
<li><b>New community channel:</b> <a href="https://github.com/microsoft/nni/discussions">Discussions</a></li>
<li>
<div><b>New emoticons release:</b> <a href="{{ pathto('nnSpider') }}">nnSpider</a></div>
<img class="gap" src="_static/img/home.svg"></img>
</li>
</ul>
</div> </div>
<!-- NNI capabilities in a glance --> <!-- NNI capabilities in a glance -->
<div> <div class="gap">
<h1 class="title">NNI capabilities in a glance</h1> <h2 class="title">NNI capabilities in a glance</h2>
<p> <p class="rowHeight">
NNI provides CommandLine Tool as well as an user friendly WebUI to manage training experiements. NNI provides CommandLine Tool as well as an user friendly WebUI to manage training experiements.
With the extensible API, you can customize your own AutoML algorithms and training services. With the extensible API, you can customize your own AutoML algorithms and training services.
To make it easy for new users, NNI also provides a set of build-in stat-of-the-art To make it easy for new users, NNI also provides a set of build-in stat-of-the-art
AutoML algorithms and out of box support for popular training platforms. AutoML algorithms and out of box support for popular training platforms.
</p> </p>
<p> <p class="rowHeight">
Within the following table, we summarized the current NNI capabilities, Within the following table, we summarized the current NNI capabilities,
we are gradually adding new capabilities and we'd love to have your contribution. we are gradually adding new capabilities and we'd love to have your contribution.
</p> </p>
...@@ -237,30 +253,30 @@ ...@@ -237,30 +253,30 @@
</table> </table>
<!-- Installation --> <!-- Installation -->
<div> <div class="gap">
<h1 class="title">Installation</h1> <h2 class="title">Installation</h2>
<div> <div>
<h2 class="second-title">Install</h2> <h3 class="second-title">Install</h3>
<p> <div class="gap2">
NNI supports and is tested on Ubuntu >= 16.04, macOS >= 10.14.1, NNI supports and is tested on Ubuntu >= 16.04, macOS >= 10.14.1,
and Windows 10 >= 1809. Simply run the following <code>pip install</code> and Windows 10 >= 1809. Simply run the following <code>pip install</code>
in an environment that has <code>python 64-bit >= 3.6</code>. in an environment that has <code>python 64-bit >= 3.6</code>.
</p> </div>
<div class="command-intro">Linux or macOS</div> <div class="command-intro">Linux or macOS</div>
<div class="command">python3 -m pip install --upgrade nni</div> <div class="command">python3 -m pip install --upgrade nni</div>
<div class="command-intro">Windows</div> <div class="command-intro">Windows</div>
<div class="command">python -m pip install --upgrade nni</div> <div class="command">python -m pip install --upgrade nni</div>
<p class="topMargin">If you want to try latest code, please <a href="{{ pathto('installation') }}">install <div class="command-intro">If you want to try latest code, please <a href="{{ pathto('installation') }}">install
NNI</a> from source code. NNI</a> from source code.
</p> </div>
<p>For detail system requirements of NNI, please refer to <a href="{{ pathto('Tutorial/InstallationLinux') }}">here</a> <div class="chinese">For detail system requirements of NNI, please refer to <a href="{{ pathto('Tutorial/InstallationLinux') }}">here</a>
for Linux & macOS, and <a href="{{ pathto('Tutorial/InstallationWin') }}">here</a> for Windows.</p> for Linux & macOS, and <a href="{{ pathto('Tutorial/InstallationWin') }}">here</a> for Windows.</div>
</div> </div>
<div> <div>
<p>Note:</p> <p>Note:</p>
<ul> <ul>
<li>If there is any privilege issue, add --user to install NNI in the user directory.</li> <li>If there is any privilege issue, add --user to install NNI in the user directory.</li>
<li>Currently NNI on Windows supports local, remote and pai mode. Anaconda or Miniconda is highly <li class="rowHeight">Currently NNI on Windows supports local, remote and pai mode. Anaconda or Miniconda is highly
recommended to install <a href="{{ pathto('Tutorial/InstallationWin') }}">NNI on Windows</a>.</li> recommended to install <a href="{{ pathto('Tutorial/InstallationWin') }}">NNI on Windows</a>.</li>
<li>If there is any error like Segmentation fault, please refer to <a <li>If there is any error like Segmentation fault, please refer to <a
href="{{ pathto('installation') }}">FAQ</a>. For FAQ on Windows, please refer href="{{ pathto('installation') }}">FAQ</a>. For FAQ on Windows, please refer
...@@ -268,29 +284,29 @@ ...@@ -268,29 +284,29 @@
</ul> </ul>
</div> </div>
<div> <div>
<h2 class="second-title">Verify installation</h2> <h3 class="second-title gap">Verify installation</h3>
<p> <div>
The following example is built on TensorFlow 1.x. Make sure <b>TensorFlow 1.x is used</b> when running The following example is built on TensorFlow 1.x. Make sure <b>TensorFlow 1.x is used</b> when running
it. it.
</p> </div>
<ul> <ul>
<li> <li>
<p>Download the examples via clone the source code.</p> <div class="command-intro">Download the examples via clone the source code.</div>
<div class="command">git clone -b {{ release }} https://github.com/Microsoft/nni.git</div> <div class="command">git clone -b {{ release }} https://github.com/Microsoft/nni.git</div>
</li> </li>
<li> <li>
<p>Run the MNIST example.</p> <div>Run the MNIST example.</div>
<div class="command-intro">Linux or macOS</div> <div class="command-intro">Linux or macOS</div>
<div class="command">nnictl create --config nni/examples/trials/mnist-pytorch/config.yml</div> <div class="command">nnictl create --config nni/examples/trials/mnist-pytorch/config.yml</div>
<div class="command-intro">Windows</div> <div class="command-intro">Windows</div>
<div class="command">nnictl create --config nni\examples\trials\mnist-pytorch\config_windows.yml</div> <div class="command">nnictl create --config nni\examples\trials\mnist-pytorch\config_windows.yml</div>
</li> </li>
<li> <li>
<p> <div class="rowHeight">
Wait for the message INFO: Successfully started experiment! in the command line. Wait for the message INFO: Successfully started experiment! in the command line.
This message indicates that your experiment has been successfully started. This message indicates that your experiment has been successfully started.
You can explore the experiment using the Web UI url. You can explore the experiment using the Web UI url.
</p> </div>
<!-- Indentation affects style！ --> <!-- Indentation affects style！ -->
<pre class="code"> <pre class="code">
INFO: Starting restful server... INFO: Starting restful server...
...@@ -318,138 +334,41 @@ You can use these commands to get more information about the experiment ...@@ -318,138 +334,41 @@ You can use these commands to get more information about the experiment
----------------------------------------------------------------------- -----------------------------------------------------------------------
</pre> </pre>
</li> </li>
<li> <li class="rowHeight">
Open the Web UI url in your browser, you can view detail information of the experiment and Open the Web UI url in your browser, you can view detail information of the experiment and
all the submitted trial jobs as shown below. <a href="{{ pathto('Tutorial/WebUI') }}">Here</a> are more Web UI all the submitted trial jobs as shown below. <a href="{{ pathto('Tutorial/WebUI') }}">Here</a> are more Web UI
pages. pages.
<img src="_static/img/webui.gif" width="100%"/> <img class="gap" src="_static/img/webui.gif" width="100%"/>
</div> </div>
</li> </li>
</ul> </ul>
</div> </div>
<!-- Documentation --> <!-- Releases and Contributing -->
<div> <div class="gap">
<h1 class="title">Documentation</h1> <h2 class="title">Releases and Contributing</h2>
<ul> <div>NNI has a monthly release cycle (major releases). Please let us know if you encounter a bug by filling an issue.</div>
<li>To learn about what's NNI, read the <a href="{{ pathto('Overview') }}">NNI Overview</a>.</li> <br/>
<li>To get yourself familiar with how to use NNI, read the <a href="{{ pathto('index') }}">documentation</a>.</li> <div>We appreciate all contributions. If you are planning to contribute any bug-fixes, please do so without further discussions.</div>
<li>To get started and install NNI on your system, please refer to <a href="{{ pathto('installation') }}">Install NNI</a>.</li> <br/>
</ul> <div class="rowHeight">If you plan to contribute new features, new tuners, new training services, etc. please first open an issue or reuse an exisiting issue, and discuss the feature with us. We will discuss with you on the issue timely or set up conference calls if needed.</div>
</div> <br/>
<div>To learn more about making a contribution to NNI, please refer to our <a href="{{ pathto('contribution') }}"">How-to contribution page</a>.</div>
<!-- Contributing --> <br/>
<div> <div>We appreciate all contributions and thank all the contributors!</div>
<h1 class="title">Contributing</h1> <img class="gap" src="_static/img/contributors.png"></img>
<p>
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor
License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your
contribution.
For details, visit <a href="https://cla.microsoft.com">https://cla.microsoft.com</a>.
</p>
<p>
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and
decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You
will only need to do this once across all repos using our CLA.
</p>
<p>
This project has adopted the <a href="https://opensource.microsoft.com/codeofconduct/">Microsoft Open Source Code of
Conduct</a>. For more information see the Code of
<a href="https://opensource.microsoft.com/codeofconduct/faq/">Conduct FAQ</a> or contact <a
href="mailto:opencode@microsoft.com">opencode@microsoft.com</a> with any additional questions or comments.
</p>
<p>
After getting familiar with contribution agreements, you are ready to create your first PR =), follow the NNI
developer tutorials to get start:
</p>
<ul>
<li>We recommend new contributors to start with simple issues: '<a
href="https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">good first
issue</a>' or '<a
href="https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22">help-wanted</a>'.
</li>
<li><a href="{{ pathto('Tutorial/SetupNniDeveloperEnvironment') }}">NNI developer environment installation
tutorial</a></li>
<li><a href="{{ pathto('Tutorial/HowToDebug') }}">How to debug</a></li>
<li>
If you have any questions on usage, review <a href="{{ pathto('Tutorial/FAQ') }}">FAQ</a> first, if there are no
relevant issues and answers to your
question, try contact NNI dev team and users in
<a
href="https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">Gitter</a>
or
<a href="https://github.com/microsoft/nni/issues/new/choose">File an issue</a> on GitHub.
</li>
<li><a href="{{ pathto('Tuner/CustomizeTuner') }}">Customize your own Tuner</a></li>
<li><a href="{{ pathto('TrainingService/HowToImplementTrainingService') }}">Implement customized TrainingService</a>
</li>
<li><a href="{{ pathto('NAS/Advanced') }}">Implement a new NAS trainer on NNI</a></li>
<li><a href="{{ pathto('Tuner/CustomizeAdvisor') }}">Customize your own Advisor</a></li>
</ul>
</div>
<!-- External Repositories and References -->
<div>
<h1 class="title">External Repositories and References</h1>
<p>With authors' permission, we listed a set of NNI usage examples and relevant articles.</p>
<ul>
<h2>External Repositories</h2>
<li>Run <a href="{{ pathto('NAS/ENAS') }}">ENAS</a> with NNI</li>
<li>
<a
href="https://github.com/microsoft/nni/blob/master/examples/feature_engineering/auto-feature-engineering/README.md">Automatic
Feature Engineering</a> with NNI
</li>
<li><a
href="https://github.com/microsoft/recommenders/blob/master/examples/04_model_select_and_optimize/nni_surprise_svd.ipynb">Hyperparameter
Tuning for Matrix Factorization</a> with NNI</li>
<li><a href="https://github.com/ksachdeva/scikit-nni">scikit-nni</a> Hyper-parameter search for scikit-learn
pipelines using NNI</li>
</ul>
<!-- Relevant Articles -->
<ul>
<h2>Relevant Articles</h2>
<li><a href="{{ pathto('CommunitySharings/HpoComparison') }}">Hyper Parameter Optimization Comparison</a></li>
<li><a href="{{ pathto('CommunitySharings/NasComparison') }}">Neural Architecture Search Comparison</a></li>
<li><a href="{{ pathto('CommunitySharings/ParallelizingTpeSearch') }}">Parallelizing a Sequential Algorithm TPE</a>
</li>
<li><a href="{{ pathto('CommunitySharings/RecommendersSvd') }}">Automatically tuning SVD with NNI</a></li>
<li><a href="{{ pathto('CommunitySharings/SptagAutoTune') }}">Automatically tuning SPTAG with NNI</a></li>
<li><a
href="https://towardsdatascience.com/find-thy-hyper-parameters-for-scikit-learn-pipelines-using-microsoft-nni-f1015b1224c1">
Find thy hyper-parameters for scikit-learn pipelines using Microsoft NNI
</a></li>
<li>
Blog (in Chinese) -
<a
href="http://gaocegege.com/Blog/%E6%9C%BA%E5%99%A8%E5%AD%A6%E4%B9%A0/katib-new#%E6%80%BB%E7%BB%93%E4%B8%8E%E5%88%86%E6%9E%90">
AutoML tools (Advisor, NNI and Google Vizier) comparison
</a>
by @gaocegege - 总结与分析 section of design and implementation of kubeflow/katib
</li>
<li>
Blog (in Chinese) -
<a href="https://mp.weixin.qq.com/s/7_KRT-rRojQbNuJzkjFMuA">A summary of NNI new capabilities in 2019</a> by @squirrelsc
</li>
</ul>
</div> </div>
<!-- feedback --> <!-- feedback -->
<div> <div class="gap">
<h1 class="title">Feedback</h1> <h2 class="title">Feedback</h2>
<ul> <ul>
<li><a href="https://github.com/microsoft/nni/issues/new/choose">File an issue</a> on GitHub.</li> <li><a href="https://github.com/microsoft/nni/issues/new/choose">File an issue</a> on GitHub.</li>
<li>Ask a question with NNI tags on <a <li>Open or participate in a <a href="https://github.com/microsoft/nni/discussions">discussion</a>.</li>
href="https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true">Stack Overflow</a>. <li>Discuss on the <a href="https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">NNI Gitter</a> in NNI.</li>
</li>
<li>Discuss on the NNI <a
href="https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">Gitter</a>
in NNI.</li>
</ul> </ul>
<div> <div>
<div>Join IM discussion groups:</div> <div class="rowHeight">Join IM discussion groups:</div>
<table border=1 style="border-collapse: collapse;"> <table class="gap" border=1 style="border-collapse: collapse;">
<tbody> <tbody>
<tr style="line-height: 30px;"> <tr style="line-height: 30px;">
<th>Gitter</th> <th>Gitter</th>
...@@ -469,45 +388,153 @@ You can use these commands to get more information about the experiment ...@@ -469,45 +388,153 @@ You can use these commands to get more information about the experiment
</table> </table>
</div> </div>
</div> </div>
<!-- Test status -->
<div class="gap">
<h2 class="title">Test status</h2>
<h3>Essentials</h3>
<table class="pipeline">
<tr>
<th>Type</th>
<th>Status</th>
</tr>
<tr>
<td>Fast test</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=54&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/fast%20test?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Full linux</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=62&repoName=microsoft%2Fnni&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/full%20test%20-%20linux?repoName=microsoft%2Fnni&branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Full windows</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=63&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/full%20test%20-%20windows?branchName=master"/>
</a>
</td>
</tr>
</table>
<h3 class="gap">Training services</h3>
<table class="pipeline">
<tr>
<th>Type</th>
<th>Status</th>
</th>
<tr>
<td>Remote - linux to linux</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=64&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20remote%20-%20linux%20to%20linux?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Remote - linux to windows</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=67&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20remote%20-%20linux%20to%20windows?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Remote - windows to linux</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=68&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20remote%20-%20windows%20to%20linux?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>OpenPAI</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=65&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20openpai%20-%20linux?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Frameworkcontroller</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=70&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20frameworkcontroller?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Kubeflow</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=69&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20kubeflow?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>Hybrid</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=79&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20hybrid?branchName=master"/>
</a>
</td>
</tr>
<tr>
<td>AzureML</td>
<td>
<a href="https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=78&branchName=master">
<img src="https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/integration%20test%20-%20aml?branchName=master"/>
</a>
</td>
</tr>
</table>
</div>
<!-- Related Projects --> <!-- Related Projects -->
<div> <div class="gap">
<h1 class="title">Related Projects</h1> <h2 class="title">Related Projects</h2>
<p> <p class="rowHeight">
Targeting at openness and advancing state-of-art technology, Targeting at openness and advancing state-of-art technology,
<a href="https://www.microsoft.com/en-us/research/group/systems-and-networking-research-group-asia/">Microsoft Research (MSR)</a> <a href="https://www.microsoft.com/en-us/research/group/systems-and-networking-research-group-asia/">Microsoft Research (MSR)</a>
had also released few had also released few
other open source projects.</p> other open source projects.</p>
<ul id="relatedProject"> <ul id="relatedProject">
<li> <li class="rowHeight">
<a href="https://github.com/Microsoft/pai">OpenPAI</a> : an open source platform that provides complete AI model <a href="https://github.com/Microsoft/pai">OpenPAI</a> : an open source platform that provides complete AI model
training and resource management training and resource management
capabilities, it is easy to extend and supports on-premise, capabilities, it is easy to extend and supports on-premise,
cloud and hybrid environments in various scale. cloud and hybrid environments in various scale.
</li> </li>
<li> <li class="rowHeight">
<a href="https://github.com/Microsoft/frameworkcontroller">FrameworkController</a> : an open source <a href="https://github.com/Microsoft/frameworkcontroller">FrameworkController</a> : an open source
general-purpose Kubernetes Pod Controller that orchestrate general-purpose Kubernetes Pod Controller that orchestrate
all kinds of applications on Kubernetes by a single controller. all kinds of applications on Kubernetes by a single controller.
</li> </li>
<li> <li class="rowHeight">
<a href="https://github.com/Microsoft/MMdnn">MMdnn</a> : A comprehensive, cross-framework solution to convert, <a href="https://github.com/Microsoft/MMdnn">MMdnn</a> : A comprehensive, cross-framework solution to convert,
visualize and diagnose deep neural network visualize and diagnose deep neural network
models. The "MM" in MMdnn stands for model management models. The "MM" in MMdnn stands for model management
and "dnn" is an acronym for deep neural network. and "dnn" is an acronym for deep neural network.
</li> </li>
<li> <li class="rowHeight">
<a href="https://github.com/Microsoft/SPTAG">SPTAG</a> : Space Partition Tree And Graph (SPTAG) is an open <a href="https://github.com/Microsoft/SPTAG">SPTAG</a> : Space Partition Tree And Graph (SPTAG) is an open
source library source library
for large scale vector approximate nearest neighbor search scenario. for large scale vector approximate nearest neighbor search scenario.
</li> </li>
<li class="rowHeight">
<a href="https://github.com/Microsoft/SPTAG">nn-Meter</a> : An accurate inference latency predictor for DNN models on diverse edge devices.
</li>
</ul> </ul>
<p>We encourage researchers and students leverage these projects to accelerate the AI development and research.</p> <p>We encourage researchers and students leverage these projects to accelerate the AI development and research.</p>
</div> </div>
<!-- License --> <!-- License -->
<div> <div>
<h1 class="title">License</h1> <h2 class="title">License</h2>
<p>The entire codebase is under <a href="https://github.com/microsoft/nni/blob/master/LICENSE">MIT license</a></p> <p>The entire codebase is under <a href="https://github.com/microsoft/nni/blob/master/LICENSE">MIT license</a></p>
</div> </div>
</div> </div>
......
docs/en_US/_templates/nnSpider.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2 class="center">nnSpider emoticons</h2>
<ul class="emotion">
<li class="first">
<div>
<a href="{{ pathto('nnSpider/nobug') }}">
<img src="_static/img/NoBug.png" alt="NoBug" />
</a>
</div>
<p class="center">NoBug</p>
</li>
<li class="first">
<div>
<a href="{{ pathto('nnSpider/holiday') }}">
<img src="_static/img/Holiday.png" alt="Holiday" />
</a>
</div>
<p class="center">Holiday</p>
</li>
<li class="first">
<div>
<a href="{{ pathto('nnSpider/errorEmotion') }}">
<img src="_static/img/Error.png" alt="Error" />
</a>
</div>
<p class="center">Error</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/working') }}">
<img class="working" src="_static/img/Working.png" alt="Working" />
</a>
</div>
<p class="center">Working</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/sign') }}">
<img class="sign" src="_static/img/Sign.png" alt="Sign" />
</a>
</div>
<p class="center">Sign</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/crying') }}">
<img class="crying" src="_static/img/Crying.png" alt="Crying" />
</a>
</div>
<p class="center">Crying</p>
</li>
<li class="three">
<div>
<a href="{{ pathto('nnSpider/cut') }}">
<img src="_static/img/Cut.png" alt="Crying" />
</a>
</div>
<p class="center">Cut</p>
</li>
<li class="three">
<div>
<a href="{{ pathto('nnSpider/weaving') }}">
<img class="weaving" src="_static/img/Weaving.png" alt="Weaving" />
</a>
</div>
<p class="center">weaving</p>
</li>
<li class="three">
<div class="comfort">
<a href="{{ pathto('nnSpider/comfort') }}">
<img src="_static/img/Comfort.png" alt="Weaving" />
</a>
</div>
<p class="center">comfort</p>
</li>
<li class="four">
<div>
<a href="{{ pathto('nnSpider/sweat') }}">
<img src="_static/img/Sweat.png" alt="Sweat" />
</a>
</div>
<p class="center">Sweat</p>
</li>
<div class="clear"></div>
</ul>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/comfort.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Comfort</h2>
<div class="details-container">
<img src="../_static/img/Comfort.png" alt="Comfort" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/crying.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Crying</h2>
<div class="details-container">
<img src="../_static/img/Crying.png" alt="Crying" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/cut.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Cut</h2>
<div class="details-container">
<img src="../_static/img/Cut.png" alt="Cut" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/errorEmotion.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Error</h2>
<div class="details-container">
<img src="../_static/img/Error.png" alt="Error" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/holiday.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Holiday</h2>
<div class="details-container">
<img src="../_static/img/Holiday.png" alt="NoBug" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/nobug.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>NoBug</h2>
<div class="details-container">
<img src="../_static/img/NoBug.png" alt="NoBug" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/sign.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Sign</h2>
<div class="details-container">
<img src="../_static/img/Sign.png" alt="Sign" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/sweat.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Sweat</h2>
<div class="details-container">
<img src="../_static/img/Sweat.png" alt="Sweat" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/weaving.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Weaving</h2>
<div class="details-container">
<img src="../_static/img/Weaving.png" alt="Weaving" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/working.html 0 → 100644
View file @ 3601044e
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Working</h2>
<div class="details-container">
<img src="../_static/img/Working.png" alt="Working" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/conf.py
View file @ 3601044e
...@@ -81,6 +81,18 @@ pygments_style = None ...@@ -81,6 +81,18 @@ pygments_style = None
html_additional_pages = { html_additional_pages = {
'index': 'index.html', 'index': 'index.html',
'nnSpider': 'nnSpider.html',
'nnSpider/nobug': 'nnSpider/nobug.html',
'nnSpider/holiday': 'nnSpider/holiday.html',
'nnSpider/errorEmotion': 'nnSpider/errorEmotion.html',
'nnSpider/working': 'nnSpider/working.html',
'nnSpider/sign': 'nnSpider/sign.html',
'nnSpider/crying': 'nnSpider/crying.html',
'nnSpider/cut': 'nnSpider/cut.html',
'nnSpider/weaving': 'nnSpider/weaving.html',
'nnSpider/comfort': 'nnSpider/comfort.html',
'nnSpider/sweat': 'nnSpider/sweat.html'
} }
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
......
docs/static/css/custom.css
View file @ 3601044e
...@@ -2,13 +2,25 @@ ...@@ -2,13 +2,25 @@
white-space:normal white-space:normal
} }
.gap{
margin-top: 24px;
}
.gap2{
margin-top: 12px;
}
.rowHeight{
line-height: 24px;
}
.title { .title {
padding-bottom: 6px; padding-bottom: 6px;
border-bottom: 1px solid #ccc; border-bottom: 1px solid #ccc;
} }
.second-title{ .second-title{
margin-top: 14px; margin-top: 24px;
} }
/* command style */ /* command style */
.command { .command {
...@@ -21,7 +33,7 @@ ...@@ -21,7 +33,7 @@
} }
.command-intro { .command-intro {
line-height: 40px; line-height: 48px;
} }
.code{ .code{
...@@ -29,11 +41,6 @@ ...@@ -29,11 +41,6 @@
padding: 15px 20px; padding: 15px 20px;
} }
/* p margin-top: 24 */
.topMargin{
margin-top: 24px;
}
/* document body width */ /* document body width */
.wy-nav-content{ .wy-nav-content{
max-width: 100% !important; max-width: 100% !important;
...@@ -86,10 +93,19 @@ td.framework{ ...@@ -86,10 +93,19 @@ td.framework{
text-align: center; text-align: center;
} }
.inline img, .inline h3{ .inline img, .inline h2{
display: inline-block; display: inline-block;
margin-bottom: 0px;
}
inline hr{
margin-top: 0px;
} }
.inline img {
margin-top: -20px;
}
.ui-img img{ .ui-img img{
height: 350px; height: 350px;
} }
...@@ -118,3 +134,85 @@ td.framework{ ...@@ -118,3 +134,85 @@ td.framework{
.wy-plain-list-disc li, .rst-content .section ul li, .rst-content .toctree-wrapper ul li, article ul li { .wy-plain-list-disc li, .rst-content .section ul li, .rst-content .toctree-wrapper ul li, article ul li {
margin-bottom: 0px; margin-bottom: 0px;
} }
.wy-nav-content .emotion li {
width: 300px;
height: 300px;
float: left;
margin-left: 15px;
margin-bottom: 60px;
background: #f5f5f5;
box-sizing: border-box;
list-style: none;
}
.emotion li div{
transition: 0.2s;
text-align: center;
vertical-align: middle;
}
.emotion li div:hover{
transform: translate(1.1);
box-shadow: 0 15px 30px rgb(0 0 0 / 10%);
}
.center{
line-height: 54px;
text-align: center;
}
.emotion img{
width: 250px;
}
.emotion .first img {
margin: 50px 24px;
}
.emotion .second .working{
margin: 67px 24px;
}
.emotion .second .sign{
margin: 77px 24px;
}
.emotion .second .crying{
margin: 80px 24px;
}
.emotion .three img{
margin: 66px 24px;
}
.emotion .three .weaving{
margin: 75px 24px;
}
.three .comfort img{
margin: 92px 24px;
}
.emotion .four img{
margin: 81px 24px;
}
.details-container{
text-align: center;
}
.clear{
clear: both;
}
.whatNew{
margin-top: 6px;
}
.pipeline tr, .pipeline td, .pipeline th{
width: 248px;
line-height: 26px;
text-align: center;
border: 1px solid #ccc;
}
\ No newline at end of file
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