diff --git a/README.md b/README.md index e9c56dea09..afc778fddc 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,10 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search + + - + + + + + + + + +
+ - Supported Frameworks + Frameworks & Libraries @@ -42,26 +44,52 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search
+ Built-in + +
  • Supported Frameworks
    • PyTorch
    • -
    • TensorFlow
    • Keras
    • +
    • TensorFlow
    • MXNet
    • Caffe2
    • -
    • CNTK (Python language)
    • -
    • Chainer
    • -
    • Theano
    • + More...
      +
    +
+
    +
  • Supported Libraries
  • +
      +
    • Scikit-learn
    • +
    • XGBoost
    • +
    • LightGBM
    • + More...
      +
    +
+
+ Tuner -
Assessor
@@ -93,11 +126,40 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search
+ References + + + + + + +
+ + ## **Who should consider using NNI** * Those who want to try different AutoML algorithms in their training code (model) at their local machine. @@ -235,60 +297,69 @@ Maybe you want to read: * [NNI overview](docs/en_US/Overview.md) * [Quick start](docs/en_US/Tutorial/QuickStart.md) -* [Contributing](docs/en_US/Tutorial/Contributing.md) -* [Examples](docs/en_US/examples.rst) -* [References](docs/en_US/reference.rst) * [WebUI tutorial](docs/en_US/Tutorial/WebUI.md) +* [Contributing](docs/en_US/Tutorial/Contributing.md) + ## **How to** * [Install NNI](docs/en_US/Tutorial/Installation.md) * [Use command line tool nnictl](docs/en_US/Tutorial/Nnictl.md) -* [Use NNIBoard](docs/en_US/Tutorial/WebUI.md) -* [How to define search space](docs/en_US/Tutorial/SearchSpaceSpec.md) -* [How to define a trial](docs/en_US/TrialExample/Trials.md) -* [How to choose tuner/search-algorithm](docs/en_US/Tuner/BuiltinTuner.md) +* [Define a trial](docs/en_US/TrialExample/Trials.md) * [Config an experiment](docs/en_US/Tutorial/ExperimentConfig.md) -* [How to use annotation](docs/en_US/TrialExample/Trials.md#nni-python-annotation) +* [Define search space](docs/en_US/Tutorial/SearchSpaceSpec.md) +* [choose tuner/search-algorithm](docs/en_US/Tuner/BuiltinTuner.md) +* [Use annotation](docs/en_US/TrialExample/Trials.md#nni-python-annotation) +* [Use NNIBoard](docs/en_US/Tutorial/WebUI.md) + ## **Tutorials** +* [Run an experiment on local (with multiple GPUs)](docs/en_US/TrainingService/LocalMode.md) * [Run an experiment on OpenPAI](docs/en_US/TrainingService/PaiMode.md) * [Run an experiment on Kubeflow](docs/en_US/TrainingService/KubeflowMode.md) -* [Run an experiment on local (with multiple GPUs)](docs/en_US/TrainingService/LocalMode.md) * [Run an experiment on multiple machines](docs/en_US/TrainingService/RemoteMachineMode.md) * [Try different tuners](docs/en_US/Tuner/BuiltinTuner.md) * [Try different assessors](docs/en_US/Assessor/BuiltinAssessor.md) * [Implement a customized tuner](docs/en_US/Tuner/CustomizeTuner.md) * [Implement a customized assessor](docs/en_US/Assessor/CustomizeAssessor.md) +* [Implement TrainingService in NNI](docs/en_US/TrainingService/HowToImplementTrainingService.md) * [Use Genetic Algorithm to find good model architectures for Reading Comprehension task](docs/en_US/TrialExample/SquadEvolutionExamples.md) +* [Advanced Neural Architecture Search](docs/en_US/AdvancedFeature/AdvancedNas.md) + ## **Contribute** This project welcomes contributions and there are many ways in which you can participate in the project, for example: -* Review [source code changes](https://github.com/microsoft/nni/pulls) -* Review the [documentation](https://github.com/microsoft/nni/tree/master/docs) and make pull requests for anything from typos to new content +* Open [bug reports](https://github.com/microsoft/nni/issues/new/choose). +* Request a [new feature](https://github.com/microsoft/nni/issues/new/choose). +* Suggest or ask some questions on the [How to Debug](docs/en_US/Tutorial/HowToDebug.md) guidance document. * Find the issues tagged with ['good first issue'](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or ['help-wanted'](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22), these are simple and easy to start , we recommend new contributors to start with. -Before providing your hacks, there are a few simple guidelines that you need to follow: + +Before providing your hacks, you can review the [Contributing Instruction](docs/en_US/Tutorial/Contributing.md) to get more information. In addition, we also provide you with the following documents: +* [NNI developer environment installation tutorial](docs/en_US/Tutorial/SetupNniDeveloperEnvironment.md) * [How to debug](docs/en_US/Tutorial/HowToDebug.md) -* [Code Styles & Naming Conventions](docs/en_US/Tutorial/Contributing.md) -* How to Set up [NNI developer environment](docs/en_US/Tutorial/SetupNniDeveloperEnvironment.md) -* Review the [Contributing Instruction](docs/en_US/Tutorial/Contributing.md) and get familiar with the NNI Code Contribution Guideline +* [Customize Your Own Advisor](docs/en_US/Tuner/CustomizeAdvisor.md) +* [Customize Your Own Tuner](docs/en_US/Tuner/CustomizeTuner.md) +* [Implement customized TrainingService](docs/en_US/TrainingService/HowToImplementTrainingService.md) + ## **External Repositories** Now we have some external usage examples run in NNI from our contributors. Thanks our lovely contributors. And welcome more and more people to join us! * Run [ENAS](examples/tuners/enas_nni/README.md) in NNI * Run [Neural Network Architecture Search](examples/trials/nas_cifar10/README.md) in NNI +* [Automatic Feature Engineering](examples/trials/auto-feature-engineering/README.md) in NNI ## **Feedback** -* Open [bug reports](https://github.com/microsoft/nni/issues/new/choose).
-* Request a [new feature](https://github.com/microsoft/nni/issues/new/choose). * Discuss on the NNI [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) in NNI -* Ask a question with NNI tags on [Stack Overflow](https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true)or [file an issue](https://github.com/microsoft/nni/issues/new/choose)on GitHub. -* We are in construction of the instruction for [How to Debug](docs/en_US/Tutorial/HowToDebug.md), you are also welcome to contribute questions or suggestions on this area. +* Ask a question with NNI tags on [Stack Overflow](https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true) +* [File an issue](https://github.com/microsoft/nni/issues/new/choose) on GitHub. + + ## **License** The entire codebase is under [MIT license](LICENSE) + diff --git a/README_zh_CN.md b/README_zh_CN.md index cdd5bf7cff..75f1181a37 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -4,7 +4,7 @@ * * * -[![MIT 许可证](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE) [![生成状态](https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/Microsoft.nni)](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=6) [![问题](https://img.shields.io/github/issues-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen) [![Bug](https://img.shields.io/github/issues/Microsoft/nni/bug.svg)](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3Abug) [![拉取请求](https://img.shields.io/github/issues-pr-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/pulls?q=is%3Apr+is%3Aopen) [![版本](https://img.shields.io/github/release/Microsoft/nni.svg)](https://github.com/Microsoft/nni/releases) [![进入 https://gitter.im/Microsoft/nni 聊天室提问](https://badges.gitter.im/Microsoft/nni.svg)](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![文档状态](https://readthedocs.org/projects/nni/badge/?version=latest)](https://nni.readthedocs.io/en/latest/?badge=latest) +[![MIT 许可证](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE) [![生成状态](https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/Microsoft.nni)](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=6) [![问题](https://img.shields.io/github/issues-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen) [![Bug](https://img.shields.io/github/issues/Microsoft/nni/bug.svg)](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3Abug) [![拉取请求](https://img.shields.io/github/issues-pr-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/pulls?q=is%3Apr+is%3Aopen) [![版本](https://img.shields.io/github/release/Microsoft/nni.svg)](https://github.com/Microsoft/nni/releases) [![进入 https://gitter.im/Microsoft/nni 聊天室提问](https://badges.gitter.im/Microsoft/nni.svg)](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![文档状态](https://readthedocs.org/projects/nni/badge/?version=latest)](https://nni.readthedocs.io/zh/latest/?badge=latest) [English](README.md) @@ -47,40 +47,40 @@ NNI (Neural Network Intelligence) 是自动机器学习(AutoML)的工具包 - Tuner(调参器) + Tuner(调参器)
- Assessor(评估器) + Assessor(评估器)