Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pull code #31

Merged
merged 136 commits into from
Aug 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
136 commits
Select commit Hold shift + click to select a range
6099fb4
fix link err in docs
suiguoxin May 28, 2019
44cf69c
add spaces
suiguoxin May 28, 2019
3f87626
re-organise links for detailed descriptions of the tuners and accesso…
suiguoxin May 28, 2019
b92c4ab
add in-page link by change .md to .html
suiguoxin May 29, 2019
3be8892
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin May 29, 2019
0717988
delete #section from cross-file links to make links work in both read…
suiguoxin May 29, 2019
db20820
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jun 5, 2019
21725f9
gp_tuner init from fmfn's repo
suiguoxin Jun 20, 2019
e35fa2b
fix params bug by adding float>int transition
suiguoxin Jun 20, 2019
17be796
add optimal choices; support randint&quniform type; add doc
suiguoxin Jun 21, 2019
3906b34
refine doc and code
suiguoxin Jun 21, 2019
b776d7e
change mnist yml comments
suiguoxin Jun 21, 2019
dbac6ed
typo fix
suiguoxin Jun 21, 2019
df3952a
fix val err
suiguoxin Jun 23, 2019
37f4b12
fix minimize mode err
suiguoxin Jun 23, 2019
56a1575
add config test and Hpo result
suiguoxin Jun 23, 2019
ba8dccd
Merge branch 'master' of https://github.com/microsoft/nni
suiguoxin Jun 23, 2019
8cd50e3
support quniform type; update doc; update test config
suiguoxin Jun 24, 2019
942f519
update doc
suiguoxin Jun 24, 2019
ce4906f
un-commit changed in yarn.lock
suiguoxin Jun 24, 2019
a0d6cd1
fix optimize mode bug
suiguoxin Jun 25, 2019
10df680
optimize mode
suiguoxin Jun 25, 2019
c5f3da0
optimize mode
suiguoxin Jun 25, 2019
77c9547
reset pylint, gitignore
suiguoxin Jun 25, 2019
d6febf2
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jun 25, 2019
66ba114
revert .gitignore yarn.lock
suiguoxin Jun 25, 2019
eef6bd3
realise automatic line change in table cell by adding custom css to S…
suiguoxin Jun 25, 2019
99dfd65
fix typo
suiguoxin Jun 25, 2019
8afd8a3
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jun 25, 2019
3c3b729
delete toy
suiguoxin Jun 25, 2019
1b48f91
fix config test file ; update docs & readme
suiguoxin Jun 26, 2019
3d58106
remove changes to another branch
suiguoxin Jun 26, 2019
1c3bf4f
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jun 27, 2019
f20b49e
fix custom css bug
suiguoxin Jun 27, 2019
571817e
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jun 27, 2019
5fd3b08
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jul 5, 2019
d92c69f
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jul 11, 2019
d218dcb
fix issue#1263
Jul 11, 2019
2556064
delete notes
Jul 11, 2019
9fb25cc
Merge pull request #189 from microsoft/master
SparkSnail Jul 17, 2019
4bbffd1
Merge branch 'master' of git://github.com/microsoft/nni
suiguoxin Jul 17, 2019
cb25d66
Merge pull request #190 from microsoft/master
SparkSnail Jul 18, 2019
1bd2012
Merge pull request #191 from microsoft/master
SparkSnail Jul 18, 2019
227a461
Update NNIManager.getTrialJob to contain all hyper parameters (#1288)
chicm-ms Jul 18, 2019
aa8b09e
Add "population_size" param for evolution tuner (#1328)
xuehui1991 Jul 18, 2019
3ff007d
Make population_size optional (#1334)
Jul 18, 2019
e3e203a
Upgrade nni dependencies (#1333)
chicm-ms Jul 19, 2019
7adebd6
issue#1306Fixed broken links of Release.md (#1321)
rabbit008 Jul 20, 2019
7c103cd
Merge branch 'master' of github.com:microsoft/nni
suiguoxin Jul 21, 2019
a7d9947
Update multiphase doc (#1242)
chicm-ms Jul 22, 2019
c329379
fix build
Jul 22, 2019
251a439
Merge pull request #1295 from lvybriage/dev-bug-filter
suiguoxin Jul 22, 2019
8bb3875
[Fix issue#1210]
Jul 23, 2019
87608f3
[fix issue#1332]Double check for trial does not have final result
Jul 23, 2019
a5fa235
Do not copy codeDir when submit trial in Kubeflow and Frameworkcontro…
SparkSnail Jul 23, 2019
d5e9a57
add get_trial_id
suiguoxin Jul 23, 2019
a4d62e9
add get_experiment_id
suiguoxin Jul 23, 2019
9e40371
add doc and test
suiguoxin Jul 23, 2019
14d16cc
fix typo
suiguoxin Jul 23, 2019
c76068f
Merge pull request #192 from microsoft/master
SparkSnail Jul 23, 2019
cb7a1b8
delete the changes of default metric
Jul 24, 2019
382e276
Merge pull request #1353 from suiguoxin/get_id
suiguoxin Jul 24, 2019
a33a21c
test build
Jul 24, 2019
3c78596
Merge pull request #1348 from lvybriage/patch-multiy
suiguoxin Jul 24, 2019
bf8d6dc
update
Jul 24, 2019
803b6e4
Merge pull request #193 from microsoft/master
SparkSnail Jul 24, 2019
fc9036f
Fix hyperband pop issue (#1340)
suiguoxin Jul 25, 2019
8016c71
Fix includeIntermediateResults field in config_schema (#1326)
SparkSnail Jul 25, 2019
1fd61e5
Merge branch 'master' of https://github.com/Microsoft/nni into dev-fi…
Jul 25, 2019
92d75bc
fix detail table succeed trial XXX(FINAL) when have not final result
Jul 25, 2019
8fd3cf0
Merge pull request #1350 from lvybriage/dev-fix-hyper-bug
suiguoxin Jul 25, 2019
a651ecf
fix webui start bug (#1363)
lvybriage Jul 26, 2019
5445bf4
Add test code for `nnictl stop` command (#1349)
Crysple Jul 26, 2019
88b7506
[Fixed issue#1230] Refactor webui nav (#1319)
lvybriage Jul 26, 2019
2691122
[Fix issue#1360] Modify default metric graph
Jul 26, 2019
a2e45f2
fix quniform issue ; change related doc
suiguoxin Jul 27, 2019
79a3ce9
change quniform style in GridSearch to conform with other tuners
suiguoxin Jul 27, 2019
9a00a14
fix qloguniform issue
suiguoxin Jul 28, 2019
9d47087
Merge pull request #1374 from lvybriage/precision
suiguoxin Jul 28, 2019
b63b283
Merge pull request #194 from microsoft/master
SparkSnail Jul 29, 2019
591fa1d
update annotation doc; update smartparam sync
suiguoxin Jul 29, 2019
7748a2d
Let nnictl support stopping by port (#1384)
liuzhe-lz Jul 29, 2019
d4acd49
Merge pull request #195 from microsoft/master
SparkSnail Jul 30, 2019
9a43f0d
fix experiment list
SparkSnail Jul 30, 2019
664a149
Remove outputDir and dataDir in config file (#1361)
SparkSnail Jul 30, 2019
1c29b08
Merge pull request #1388 from SparkSnail/dev-fix-experiment-list
suiguoxin Jul 30, 2019
410ab1c
[Fix issue#1208] Support search parameters (#1382)
lvybriage Jul 31, 2019
5f3c5ff
Merge pull request #196 from microsoft/master
SparkSnail Jul 31, 2019
458fb70
Improve webui document
Jul 31, 2019
988dddd
test
Jul 31, 2019
29cb0ca
update
Jul 31, 2019
c181116
Python wrapper for rest api (#1318)
chicm-ms Jul 31, 2019
4117f1b
update doc
suiguoxin Aug 1, 2019
e442498
Grid Search: delete qloguniform; add randint
suiguoxin Aug 1, 2019
d248881
fix typo
suiguoxin Aug 1, 2019
9e93a78
Auto feature engineering (#1387)
xuehui1991 Aug 1, 2019
d2c6a70
import -> input
Aug 1, 2019
facbd73
update the filter function
Aug 1, 2019
375822b
Update parallel tpe (#1373)
xuehui1991 Aug 1, 2019
35f8496
change step into epoch
Aug 1, 2019
279dbde
Unify nas searchspace (#1393)
Crysple Aug 1, 2019
555334d
Support private registry in PAI, Kubeflow and FrameworkController mod…
SparkSnail Aug 1, 2019
88ef6c0
Merge pull request #197 from microsoft/master
SparkSnail Aug 1, 2019
e3dc24a
update comments
suiguoxin Aug 1, 2019
204b1eb
Set gpuNum as optional (#1389)
SparkSnail Aug 2, 2019
521ca50
Merge pull request #198 from microsoft/master
SparkSnail Aug 2, 2019
1a66309
Add package install error information (#1385)
SparkSnail Aug 2, 2019
5b62d04
Merge pull request #1379 from suiguoxin/quniform-grid
suiguoxin Aug 2, 2019
b56e4a1
fix bug of hyper-parameter graph when search space has loguniform typ…
lvybriage Aug 2, 2019
140dd83
Fix pypi package (#1404)
SparkSnail Aug 2, 2019
f92b3ed
[Fixed issue#1218 V2] Show the best metric curve during search progre…
lvybriage Aug 2, 2019
1dab311
Update yarn.lock (#1405)
liuzhe-lz Aug 2, 2019
caaa99a
Fix broken links in docs and issues of links to English docs appearin…
ultmaster Aug 4, 2019
da01b7d
Update webui document
Aug 4, 2019
f13a922
update
Aug 4, 2019
4feb466
fix hyperopt quniform/qloguniform issue
suiguoxin Aug 4, 2019
e3c8552
change qtype format to conforme with BOHB
suiguoxin Aug 5, 2019
0591342
Merge branch 'master' into quniform-tuners
suiguoxin Aug 5, 2019
afb4e78
update gridsearch quniform to conform with BOHB
suiguoxin Aug 5, 2019
1fda860
add doc for one-shot training modes of NAS (#1254)
QuanluZhang Aug 5, 2019
f23f8a0
Add intermediate count column to show trial progress (#1408)
lvybriage Aug 5, 2019
755ac5f
Merge pull request #199 from microsoft/master
SparkSnail Aug 5, 2019
f179a9b
Update bash completion script (#1400)
liuzhe-lz Aug 5, 2019
ff48298
rollback chinese docs changes
Aug 5, 2019
aa032dd
rename
Aug 5, 2019
907270f
Merge pull request #1378 from suiguoxin/quniform-tuners
suiguoxin Aug 5, 2019
e0beec1
Merge pull request #1394 from lvybriage/patch-webui-doc
suiguoxin Aug 5, 2019
3b942f2
Fix bug of optimization curve when trial sequenceId is not continuously
Aug 5, 2019
22a9982
delete notes
Aug 5, 2019
7eee68f
fix the link showing "Trials.md"
Aug 5, 2019
2226119
Merge pull request #1409 from ultmaster/master
suiguoxin Aug 5, 2019
9b15448
Chinese translation (#1278)
squirrelsc Aug 5, 2019
d68ca0b
fix hdfsOUtputDir
SparkSnail Aug 5, 2019
07bc2ac
Merge pull request #1413 from lvybriage/cai
suiguoxin Aug 5, 2019
875a0da
Update oneshot_mode and add darts mode (first version) (#1369)
Crysple Aug 5, 2019
1fee166
Merge pull request #1415 from SparkSnail/dev-fix-pai-hdfsClient
suiguoxin Aug 6, 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
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ dev-install-python-modules:
#$(_INFO) Installing Python SDK $(_END)
mkdir -p build
ln -sf ../src/sdk/pynni/nni build/nni
ln -sf ../src/sdk/pynni/nnicli build/nnicli
ln -sf ../tools/nni_annotation build/nni_annotation
ln -sf ../tools/nni_cmd build/nni_cmd
ln -sf ../tools/nni_trial_tool build/nni_trial_tool
Expand Down
154 changes: 93 additions & 61 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@

NNI (Neural Network Intelligence) 是自动机器学习(AutoML)的工具包。 它通过多种调优的算法来搜索最好的神经网络结构和(或)超参,并支持单机、本地多机、云等不同的运行环境。

### **NNI [v0.9](https://github.com/Microsoft/nni/releases) 已发布!**
### **NNI [v0.9](https://github.com/Microsoft/nni/releases) 已发布! &nbsp;[<img width="48" src="docs/img/release_icon.png" />](#nni-released-reminder)**

<p align="center">
<a href="#nni-v05-has-been-released"><img src="docs/img/overview.svg" /></a>
<a href="#nni-has-been-released"><img src="docs/img/overview.svg" /></a>
</p>

<table>
Expand All @@ -28,11 +28,11 @@ NNI (Neural Network Intelligence) 是自动机器学习(AutoML)的工具包
<img src="docs/img/bar.png"/>
</td>
<td>
<b>训练服务</b>
<b>训练平台</b>
<img src="docs/img/bar.png"/>
</td>
</tr>
<tr/>
</tr>
<tr valign="top">
<td>
<ul>
Expand All @@ -46,39 +46,45 @@ NNI (Neural Network Intelligence) 是自动机器学习(AutoML)的工具包
<li>Theano</li>
</ul>
</td>
<td>
<a href="docs/zh_CN/BuiltinTuner.md">Tuner(调参器)</a>
<ul>
<li><a href="docs/zh_CN/BuiltinTuner.md#TPE">TPE</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#Random">Random Search(随机搜索)</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#Anneal">Anneal(退火算法)</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#Evolution">Naive Evolution(进化算法)</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#SMAC">SMAC</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#Batch">Batch(批处理)</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#GridSearch">Grid Search(遍历搜索)</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#Hyperband">Hyperband</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#NetworkMorphism">Network Morphism</a></li>
<li><a href="examples/tuners/enas_nni/README_zh_CN.md">ENAS</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#MetisTuner">Metis Tuner</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#BOHB">BOHB</a></li>
<li><a href="docs/zh_CN/BuiltinTuner.md#GPTuner">GP Tuner</a></li>
</ul>
<a href="docs/zh_CN/BuiltinAssessor.md">Assessor(评估器)</a>
<td align="left">
<a href="docs/en_US/Tuner/BuiltinTuner.md">Tuner(调参器)</a>
<br />
<ul>
<li><a href="docs/zh_CN/BuiltinAssessor.md#Medianstop">Median Stop</a></li>
<li><a href="docs/zh_CN/BuiltinAssessor.md#Curvefitting">Curve Fitting</a></li>
</ul>
<b style="margin-left:-20px">通用 Tuner</b>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#Random">Random Search(随机搜索)</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#Evolution">Naïve Evolution(进化算法)</a></li>
<b style="margin-left:-20px">超参 Tuner</b>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#TPE">TPE</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#Anneal">Anneal(退火算法)</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#SMAC">SMAC</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#Batch">Batch(批处理)</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#GridSearch">Grid Search(遍历搜索)</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#Hyperband">Hyperband</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#MetisTuner">Metis Tuner</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#BOHB">BOHB</a></li>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#GPTuner">GP Tuner</a></li>
<b style="margin-left:-20px">网络结构 Tuner</b>
<li><a href="docs/en_US/Tuner/BuiltinTuner.md#NetworkMorphism">Network Morphism</a></li>
<li><a href="examples/tuners/enas_nni/README.md">ENAS</a></li>
</ul>
<a href="docs/en_US/Assessor/BuiltinAssessor.md">Assessor(评估器)</a>
<ul>
<li><a href="docs/en_US/Assessor/BuiltinAssessor.md#Medianstop">Median Stop(中位数终止)</a></li>
<li><a href="docs/en_US/Assessor/BuiltinAssessor.md#Curvefitting">Curve Fitting(曲线拟合)</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="docs/zh_CN/LocalMode.md">本地计算机</a></li>
<li><a href="docs/zh_CN/RemoteMachineMode.md">远程计算机</a></li>
<li><a href="docs/zh_CN/PaiMode.md">OpenPAI</a></li>
<li><a href="docs/zh_CN/KubeflowMode.md">Kubeflow</a></li>
<li><a href="docs/zh_CN/FrameworkControllerMode.md">基于 Kubernetes(AKS 等等)的 FrameworkController</a></li>
<li><a href="docs/en_US/TrainingService/LocalMode.md">本机</a></li>
<li><a href="docs/en_US/TrainingService/RemoteMachineMode.md">远程计算机</a></li>
<li><b>基于 Kubernetes 的平台</b></li>
<ul><li><a href="docs/en_US/TrainingService/PaiMode.md">OpenPAI</a></li>
<li><a href="docs/en_US/TrainingService/KubeflowMode.md">Kubeflow</a></li>
<li><a href="docs/en_US/TrainingService/FrameworkControllerMode.md">基于 Kubernetes(AKS 等)的 FrameworkController</a></li>
</ul>
</ul>
</td>
</tr>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -122,7 +128,7 @@ python -m pip install --upgrade nni

* 如果需要将 NNI 安装到自己的 home 目录中,可使用 `--user`,这样也不需要任何特殊权限。
* 目前,Windows 上的 NNI 支持本机,远程和 OpenPAI 模式。 强烈推荐使用 Anaconda 或 Miniconda 在 Windows 上安装 NNI。
* 如果遇到如`Segmentation fault` 这样的任何错误请参考[常见问题](docs/zh_CN/FAQ.md)。
* 如果遇到如`Segmentation fault` 这样的任何错误请参考[常见问题](docs/zh_CN/Tutorial/FAQ.md)。

**通过源代码安装**

Expand All @@ -133,7 +139,7 @@ Linux 和 macOS
* 在 `python >= 3.5` 的环境中运行命令: `git` 和 `wget`,确保安装了这两个组件。

```bash
git clone -b v0.8 https://github.com/Microsoft/nni.git
git clone -b v0.9 https://github.com/Microsoft/nni.git
cd nni
source install.sh
```
Expand All @@ -143,14 +149,14 @@ Windows
* 在 `python >=3.5` 的环境中运行命令: `git` 和 `PowerShell`,确保安装了这两个组件。

```bash
git clone -b v0.8 https://github.com/Microsoft/nni.git
git clone -b v0.9 https://github.com/Microsoft/nni.git
cd nni
powershell -ExecutionPolicy Bypass -file install.ps1
```

参考[安装 NNI](docs/zh_CN/Installation.md) 了解系统需求。
参考[安装 NNI](docs/zh_CN/Tutorial/Installation.md) 了解系统需求。

Windows 上参考 [Windows 上使用 NNI](docs/zh_CN/NniOnWindows.md)。
Windows 上参考 [Windows 上使用 NNI](docs/zh_CN/Tutorial/NniOnWindows.md)。

**验证安装**

Expand All @@ -159,7 +165,7 @@ Windows 上参考 [Windows 上使用 NNI](docs/zh_CN/NniOnWindows.md)。
* 通过克隆源代码下载示例。

```bash
git clone -b v0.8 https://github.com/Microsoft/nni.git
git clone -b v0.9 https://github.com/Microsoft/nni.git
```

Linux 和 macOS
Expand Down Expand Up @@ -207,7 +213,7 @@ You can use these commands to get more information about the experiment
-----------------------------------------------------------------------
```

* 在浏览器中打开 `Web UI url`,可看到下图的 Experiment 详细信息,以及所有的 Trial 任务。 查看[这里](docs/zh_CN/WebUI.md)的更多页面。
* 在浏览器中打开 `Web UI url`,可看到下图的 Experiment 详细信息,以及所有的 Trial 任务。 查看[这里](docs/zh_CN/Tutorial/WebUI.md)的更多页面。

<table style="border: none">
<th><img src="./docs/img/webui_overview_page.png" alt="drawing" width="395"/></th>
Expand All @@ -216,43 +222,69 @@ You can use these commands to get more information about the experiment

## **文档**

主要文档都可以在[这里](https://nni.readthedocs.io/cn/latest/Overview.html)找到,文档均从本代码库生成。
点击阅读:

* [NNI 概述](docs/zh_CN/Overview.md)
* [快速入门](docs/zh_CN/QuickStart.md)
* [快速入门](docs/en_US/Tutorial/QuickStart.md)
* [贡献](docs/en_US/Tutorial/Contributing.md)
* [示例](docs/en_US/examples.rst)
* [参考](docs/en_US/reference.rst)
* [Web 界面教程](docs/en_US/Tutorial/WebUI.md)

## **入门**

* [安装 NNI](docs/zh_CN/Installation.md)
* [使用命令行工具 nnictl](docs/zh_CN/Nnictl.md)
* [使用 NNIBoard](docs/zh_CN/WebUI.md)
* [如何定义搜索空间](docs/zh_CN/SearchSpaceSpec.md)
* [如何编写 Trial 代码](docs/zh_CN/Trials.md)
* [如何选择 Tuner、搜索算法](docs/zh_CN/BuiltinTuner.md)
* [配置 Experiment](docs/zh_CN/ExperimentConfig.md)
* [如何使用 Annotation](docs/zh_CN/Trials.md#nni-python-annotation)
* [安装 NNI](docs/en_US/Tutorial/Installation.md)
* [使用命令行工具 nnictl](docs/en_US/Tutorial/Nnictl.md)
* [使用 NNIBoard](docs/en_US/Tutorial/WebUI.md)
* [如何定义搜索空间](docs/en_US/Tutorial/SearchSpaceSpec.md)
* [如何实现 Trial 代码](docs/en_US/TrialExample/Trials.md)
* [如何选择 Tuner、搜索算法](docs/en_US/Tuner/BuiltinTuner.md)
* [配置 Experiment](docs/en_US/Tutorial/ExperimentConfig.md)
* [如何使用 Annotation](docs/en_US/TrialExample/Trials.md#nni-python-annotation)

## **教程**

* [在本机运行 Experiment (支持多 GPU 卡)](docs/zh_CN/LocalMode.md)
* [在多机上运行 Experiment](docs/zh_CN/RemoteMachineMode.md)
* [在 OpenPAI 上运行 Experiment](docs/zh_CN/PaiMode.md)
* [在 Kubeflow 上运行 Experiment](docs/zh_CN/KubeflowMode.md)
* [尝试不同的 Tuner](docs/zh_CN/tuners.rst)
* [尝试不同的 Assessor](docs/zh_CN/assessors.rst)
* [实现自定义 Tuner](docs/zh_CN/CustomizeTuner.md)
* [实现自定义 Assessor](docs/zh_CN/CustomizeAssessor.md)
* [使用进化算法为阅读理解任务找到好模型](examples/trials/ga_squad/README_zh_CN.md)
* [在 OpenPAI 上运行 Experiment](docs/en_US/TrainingService/PaiMode.md)
* [在 Kubeflow 上运行 Experiment](docs/en_US/TrainingService/KubeflowMode.md)
* [在本机运行 Experiment (支持多 GPU 卡)](docs/en_US/TrainingService/LocalMode.md)
* [在多机上运行 Experiment](docs/en_US/TrainingService/RemoteMachineMode.md)
* [尝试不同的 Tuner](docs/en_US/Tuner/BuiltinTuner.md)
* [尝试不同的 Assessor](docs/en_US/Assessor/BuiltinAssessor.md)
* [实现自定义 Tuner](docs/en_US/Tuner/CustomizeTuner.md)
* [实现自定义 Assessor](docs/en_US/Assessor/CustomizeAssessor.md)
* [使用进化算法为阅读理解任务找到好模型](docs/en_US/TrialExample/SquadEvolutionExamples.md)

## **贡献**

欢迎贡献代码或提交建议,可在 [GitHub issues](https://github.com/Microsoft/nni/issues) 跟踪需求和 Bug。
非常欢迎通过各种方式参与此项目,例如:

* 审查[源代码改动](https://github.com/microsoft/nni/pulls)
* 审查[文档](https://github.com/microsoft/nni/tree/master/docs)中从拼写错误到新内容的任何内容,并提交拉取请求。
* 找到标有 ['good first issue'](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 或 ['help-wanted'](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) 标签的 Issue。这些都是简单的 Issue,新的贡献者可以从这些问题开始。

在提交代码前,需要遵循以下的简单准则:

* [如何调试](docs/en_US/Tutorial/HowToDebug.md)
* [代码风格和命名约定](docs/en_US/Tutorial/Contributing.md)
* 如何设置 [NNI 开发环境](docs/zh_CN/Tutorial/SetupNniDeveloperEnvironment.md)
* 查看[贡献说明](docs/en_US/Tutorial/Contributing.md)并熟悉 NNI 的代码贡献指南

## **外部代码库**

推荐新贡献者从标有 **good first issue** 的简单需求开始。
下面是一些贡献者为 NNI 提供的使用示例 谢谢可爱的贡献者! 欢迎越来越多的人加入我们!

如要安装 NNI 开发环境,参考:[配置 NNI 开发环境](docs/zh_CN/SetupNniDeveloperEnvironment.md)。
* 在 NNI 中运行 [ENAS](examples/tuners/enas_nni/README_zh_CN.md)
* 在 NNI 中运行 [神经网络架构结构搜索](examples/trials/nas_cifar10/README_zh_CN.md)

在写代码之前,请查看并熟悉 NNI 代码贡献指南:[贡献](docs/zh_CN/Contributing.md)。
## **反馈**

我们正在编写[如何调试](docs/zh_CN/HowToDebug.md) 的页面,欢迎提交建议和问题。
* [报告 Bug](https://github.com/microsoft/nni/issues/new/choose)。

* [请求新功能](https://github.com/microsoft/nni/issues/new/choose).
* 在 [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 中参与讨论
* 在 [Stack Overflow](https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true) 上使用 nni 的标签提问,或[在 Github 上提交 Issue](https://github.com/microsoft/nni/issues/new/choose)。
* 我们正在实现[如何调试](docs/zh_CN/Tutorial/HowToDebug.md)的页面,欢迎提交建议和问题。

## **许可协议**

Expand Down
10 changes: 9 additions & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
displayName: 'Install nni toolkit via source code'
- script: |
python3 -m pip install flake8 --user
IGNORE=./tools/nni_annotation/testcase/*:F821,./examples/trials/mnist-nas/mnist.py:F821
IGNORE=./tools/nni_annotation/testcase/*:F821,./examples/trials/mnist-nas/*/mnist*.py:F821
python3 -m flake8 . --count --per-file-ignores=$IGNORE --select=E9,F63,F72,F82 --show-source --statistics
displayName: 'Run flake8 tests to find Python syntax errors and undefined names'
- script: |
Expand All @@ -34,6 +34,10 @@ jobs:
cd test
PATH=$HOME/.local/bin:$PATH python3 metrics_test.py
displayName: 'Trial job metrics test'
- script: |
cd test
PATH=$HOME/.local/bin:$PATH python3 cli_test.py
displayName: 'nnicli test'

- job: 'basic_test_pr_macOS'
pool:
Expand Down Expand Up @@ -61,3 +65,7 @@ jobs:
cd test
PATH=$HOME/Library/Python/3.7/bin:$PATH python3 tuner_test.py
displayName: 'Built-in tuners / assessors tests'
- script: |
cd test
PATH=$HOME/Library/Python/3.7/bin:$PATH python3 cli_test.py
displayName: 'nnicli test'
12 changes: 12 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
files:
- source: '/**/*.[mM][dD]'
ignore:
- '*_%locale_with_underscore%.md'
- /docs
- /%locale_with_underscore%
- '**/ISSUE_TEMPLATE/**'
translation: /%original_path%/%file_name%_%locale_with_underscore%.md
- source: /docs/en_US/**/*
ignore:
- /docs/%locale_with_underscore%/**/*.*
translation: /docs/%locale_with_underscore%/**/%original_file_name%
1 change: 1 addition & 0 deletions deployment/pypi/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ build:
cd $(CWD)../../src/webui && $(NNI_YARN) && $(NNI_YARN) build
rm -rf $(CWD)nni
cp -r $(CWD)../../src/nni_manager/dist $(CWD)nni
cp -r $(CWD)../../src/nni_manager/config $(CWD)nni
cp -r $(CWD)../../src/webui/build $(CWD)nni/static
cp $(CWD)../../src/nni_manager/package.json $(CWD)nni
sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' $(CWD)nni/package.json
Expand Down
7 changes: 5 additions & 2 deletions deployment/pypi/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,16 @@
long_description_content_type = 'text/markdown',
license = 'MIT',
url = 'https://github.com/Microsoft/nni',
packages = setuptools.find_packages('../../tools') + setuptools.find_packages('../../src/sdk/pynni', exclude=['tests']),
packages = setuptools.find_packages('../../tools') \
+ setuptools.find_packages('../../src/sdk/pynni', exclude=['tests']) \
+ setuptools.find_packages('../../src/sdk/pycli'),
package_dir = {
'nni_annotation': '../../tools/nni_annotation',
'nni_cmd': '../../tools/nni_cmd',
'nni_trial_tool': '../../tools/nni_trial_tool',
'nni_gpu_tool': '../../tools/nni_gpu_tool',
'nni': '../../src/sdk/pynni/nni'
'nni': '../../src/sdk/pynni/nni',
'nnicli': '../../src/sdk/pycli/nnicli'
},
package_data = {'nni': ['**/requirements.txt']},
python_requires = '>=3.5',
Expand Down
Loading