diff --git a/README.md b/README.md index 381458fbeb..e9c56dea09 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,13 @@ 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.9](https://github.com/Microsoft/nni/releases) has been released!  ** +

-
+ @@ -56,28 +58,28 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search Tuner
+ General Tuner +
  • Random Search
    • +
  • Naïve Evolution
    • + Tuner for HPO +
  • TPE
    • +
  • Anneal
    • +
  • SMAC
    • +
  • Batch
    • +
  • Grid Search
    • +
  • Hyperband
    • +
  • Metis Tuner
    • +
  • BOHB
    • +
  • GP Tuner
    • + Tuner for NAS +
  • Network Morphism
    • +
  • ENAS
    • + Assessor - + - - - - - - - - - - +
      @@ -90,53 +92,11 @@ The tool dispatches and runs trial jobs generated by tuning algorithms to search
    - References - - - References - - - References - -
    - - - - - -
    -
    + + ## **Who should consider using NNI** @@ -291,17 +251,18 @@ Maybe you want to read: * [Config an experiment](docs/en_US/Tutorial/ExperimentConfig.md) * [How to use annotation](docs/en_US/TrialExample/Trials.md#nni-python-annotation) + ## **Tutorials** -* [Run an experiment on OpenPAI?](docs/en_US/PaiMode.md) -* [Run an experiment on Kubeflow?](docs/en_US/KubeflowMode.md) -* [Run an experiment on local (with multiple GPUs)?](docs/en_US/LocalMode.md) -* [Run an experiment on multiple machines?](docs/en_US/RemoteMachineMode.md) -* [Try different tuners](docs/en_US/tuners.rst) -* [Try different assessors](docs/en_US/assessors.rst) +* [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/CustomizeAssessor.md) -* [Use Genetic Algorithm to find good model architectures for Reading Comprehension task](examples/trials/ga_squad/README.md) +* [Implement a customized assessor](docs/en_US/Assessor/CustomizeAssessor.md) +* [Use Genetic Algorithm to find good model architectures for Reading Comprehension task](docs/en_US/TrialExample/SquadEvolutionExamples.md) ## **Contribute** This project welcomes contributions and there are many ways in which you can participate in the project, for example: