diff --git a/README.md b/README.md index 286befc728..f871a81330 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,11 @@ The tool manages automated machine learning (AutoML) experiments, **dispatches a * ML Platform owners who want to **support AutoML in their platform**. ## **What's NEW!**   -* **New release**: [v2.2 is available](https://github.com/microsoft/nni/releases) - _released on April-26-2021_ -* **New demo available**: [Youtube entry](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - _last updated on May-26-2021_ -* **New use case sharing**: [Cost-effective Hyper-parameter Tuning using AdaptDL with NNI](https://medium.com/casl-project/cost-effective-hyper-parameter-tuning-using-adaptdl-with-nni-e55642888761) - _posted on Feb-23-2021_ +* **New release**: [v2.3 is available](https://github.com/microsoft/nni/releases) - _released on June-15-2021_ +* **New demo available**: [Youtube entry](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - _last updated on May-26-2021_ +* **New webinar**: [Introducing Retiarii: A deep learning exploratory-training framework on NNI](https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-Live.html) - _scheduled on June-24-2021_ +* **New community channel**: [Discussions](https://github.com/microsoft/nni/discussions) ## **NNI capabilities in a glance** @@ -252,7 +253,7 @@ Note: * Download the examples via clone the source code. ```bash - git clone -b v2.2 https://github.com/Microsoft/nni.git + git clone -b v2.3 https://github.com/Microsoft/nni.git ``` * Run the MNIST example. @@ -317,6 +318,7 @@ We appreciate all contributions and thank all the contributors! ## **Feedback** * [File an issue](https://github.com/microsoft/nni/issues/new/choose) on GitHub. +* Open or participate in a [discussion](https://github.com/microsoft/nni/discussions). * 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. Join IM discussion groups: diff --git a/docs/en_US/CommunitySharings/AutoCompletion.rst b/docs/en_US/CommunitySharings/AutoCompletion.rst index 8664aa733f..f9b97a1efb 100644 --- a/docs/en_US/CommunitySharings/AutoCompletion.rst +++ b/docs/en_US/CommunitySharings/AutoCompletion.rst @@ -25,7 +25,7 @@ Step 1. Download ``bash-completion`` cd ~ wget https://raw.githubusercontent.com/microsoft/nni/{nni-version}/tools/bash-completion -Here, {nni-version} should by replaced by the version of NNI, e.g., ``master``, ``v2.2``. You can also check the latest ``bash-completion`` script :githublink:`here `. +Here, {nni-version} should by replaced by the version of NNI, e.g., ``master``, ``v2.3``. You can also check the latest ``bash-completion`` script :githublink:`here `. .. cannot find :githublink:`here `. diff --git a/docs/en_US/NAS/Benchmarks.rst b/docs/en_US/NAS/Benchmarks.rst index b0dd04c8d6..79df006db6 100644 --- a/docs/en_US/NAS/Benchmarks.rst +++ b/docs/en_US/NAS/Benchmarks.rst @@ -32,7 +32,7 @@ To avoid storage and legality issues, we do not provide any prepared databases. git clone -b ${NNI_VERSION} https://github.com/microsoft/nni cd nni/examples/nas/benchmarks - Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.2``. + Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.3``. #. Install dependencies via ``pip3 install -r xxx.requirements.txt``. ``xxx`` can be ``nasbench101``\ , ``nasbench201`` or ``nds``. diff --git a/docs/en_US/Release.rst b/docs/en_US/Release.rst index 506ff84007..edbc045a35 100644 --- a/docs/en_US/Release.rst +++ b/docs/en_US/Release.rst @@ -5,6 +5,94 @@ Change Log ========== +Release 2.3 - 6/15/2021 +----------------------- + +Major Updates +^^^^^^^^^^^^^ + +Neural Architecture Search +"""""""""""""""""""""""""" + +* Retiarii Framework (NNI NAS 2.0) Beta Release with new features: + + * Support new high-level APIs: ``Repeat`` and ``Cell`` (#3481) + * Support pure-python execution engine (#3605) + * Support policy-based RL strategy (#3650) + * Support nested ModuleList (#3652) + * Improve documentation (#3785) + + **Note**: there are more exciting features of Retiarii planned in the future releases, please refer to `Retiarii Roadmap `__ for more information. + +* Add new NAS algorithm: Blockwise DNAS FBNet (#3532, thanks the external contributor @alibaba-yiwuyao) + +Model Compression +""""""""""""""""" + +* Support Auto Compression Framework (#3631) +* Support slim pruner in Tensorflow (#3614) +* Support LSQ quantizer (#3503, thanks the external contributor @chenbohua3) +* Improve APIs for iterative pruners (#3507 #3688) + +Training service & Rest +""""""""""""""""""""""" + +* Support 3rd-party training service (#3662 #3726) +* Support setting prefix URL (#3625 #3674 #3672 #3643) +* Improve NNI manager logging (#3624) +* Remove outdated TensorBoard code on nnictl (#3613) + +Hyper-Parameter Optimization +"""""""""""""""""""""""""""" + +* Add new tuner: DNGO (#3479 #3707) +* Add benchmark for tuners (#3644 #3720 #3689) + +WebUI +""""" + +* Improve search parameters on trial detail page (#3651 #3723 #3715) +* Make selected trials consistent after auto-refresh in detail table (#3597) +* Add trial stdout button on local mode (#3653 #3690) + +Examples & Documentation +"""""""""""""""""""""""" + +* Convert all trial examples' from config v1 to config v2 (#3721 #3733 #3711 #3600) +* Add new jupyter notebook examples (#3599 #3700) + +Dev Excellent +""""""""""""" + +* Upgrade dependencies in Dockerfile (#3713 #3722) +* Substitute PyYAML for ``ruamel.yaml`` (#3702) +* Add pipelines for AML and hybrid training service and experiment config V2 (#3477 #3648) +* Add pipeline badge in README (#3589) +* Update issue bug report template (#3501) + + +Bug Fixes & Minor Updates +^^^^^^^^^^^^^^^^^^^^^^^^^ + +* Fix syntax error on Windows (#3634) +* Fix a logging related bug (#3705) +* Fix a bug in GPU indices (#3721) +* Fix a bug in FrameworkController (#3730) +* Fix a bug in ``export_data_url format`` (#3665) +* Report version check failure as a warning (#3654) +* Fix bugs and lints in nnictl (#3712) +* Fix bug of ``optimize_mode`` on WebUI (#3731) +* Fix bug of ``useActiveGpu`` in AML v2 config (#3655) +* Fix bug of ``experiment_working_directory`` in Retiarii config (#3607) +* Fix a bug in mask conflict (#3629, thanks the external contributor @Davidxswang) +* Fix a bug in model speedup shape inference (#3588, thanks the external contributor @Davidxswang) +* Fix a bug in multithread on Windows (#3604, thanks the external contributor @Ivanfangsc) +* Delete redundant code in training service (#3526, thanks the external contributor @maxsuren) +* Fix typo in DoReFa compression doc (#3693, thanks the external contributor @Erfandarzi) +* Update docstring in model compression (#3647, thanks the external contributor @ichejun) +* Fix a bug when using Kubernetes container (#3719, thanks the external contributor @rmfan) + + Release 2.2 - 4/26/2021 ----------------------- diff --git a/docs/en_US/TrainingService/AMLMode.rst b/docs/en_US/TrainingService/AMLMode.rst index aa6452917e..1f799a682d 100644 --- a/docs/en_US/TrainingService/AMLMode.rst +++ b/docs/en_US/TrainingService/AMLMode.rst @@ -124,7 +124,7 @@ Run the following commands to start the example experiment: nnictl create --config config_aml.yml -Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.2``. +Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.3``. Monitor your code in the cloud by using the studio -------------------------------------------------- diff --git a/docs/en_US/TrialExample/SquadEvolutionExamples.rst b/docs/en_US/TrialExample/SquadEvolutionExamples.rst index c9dd77e260..869ade893e 100644 --- a/docs/en_US/TrialExample/SquadEvolutionExamples.rst +++ b/docs/en_US/TrialExample/SquadEvolutionExamples.rst @@ -120,7 +120,7 @@ Modify ``nni/examples/trials/ga_squad/config_pai.yml``\ , here is the default co #Your nni_manager ip nniManagerIp: 10.10.10.10 tuner: - codeDir: https://github.com/Microsoft/nni/tree/v2.2/examples/tuners/ga_customer_tuner + codeDir: https://github.com/Microsoft/nni/tree/v2.3/examples/tuners/ga_customer_tuner classFileName: customer_tuner.py className: CustomerTuner classArgs: diff --git a/docs/en_US/Tutorial/Contributing.rst b/docs/en_US/Tutorial/Contributing.rst index bf8cc0a31f..43486a2be9 100644 --- a/docs/en_US/Tutorial/Contributing.rst +++ b/docs/en_US/Tutorial/Contributing.rst @@ -71,4 +71,4 @@ Our documentation is built with :githublink:`sphinx `. * It's an image link which needs to be formatted with embedded html grammar, please use global URL like ``https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png``, which can be automatically generated by dragging picture onto `Github Issue `__ Box. - * It cannot be re-formatted by sphinx, such as source code, please use its global URL. For source code that links to our github repo, please use URLs rooted at ``https://github.com/Microsoft/nni/tree/v2.2/`` (:githublink:`mnist.py ` for example). + * It cannot be re-formatted by sphinx, such as source code, please use its global URL. For source code that links to our github repo, please use URLs rooted at ``https://github.com/Microsoft/nni/tree/v2.3/`` (:githublink:`mnist.py ` for example). diff --git a/docs/en_US/Tutorial/InstallationLinux.rst b/docs/en_US/Tutorial/InstallationLinux.rst index 9db4b731bf..74e186e218 100644 --- a/docs/en_US/Tutorial/InstallationLinux.rst +++ b/docs/en_US/Tutorial/InstallationLinux.rst @@ -24,7 +24,7 @@ Install NNI through source code .. code-block:: bash - git clone -b v2.2 https://github.com/Microsoft/nni.git + git clone -b v2.3 https://github.com/Microsoft/nni.git cd nni python3 -m pip install --upgrade pip setuptools python3 setup.py develop @@ -37,7 +37,7 @@ If you want to perform a persist install instead, we recommend to build your own .. code-block:: bash - git clone -b v2.2 https://github.com/Microsoft/nni.git + git clone -b v2.3 https://github.com/Microsoft/nni.git cd nni export NNI_RELEASE=2.0 python3 -m pip install --upgrade pip setuptools wheel @@ -59,7 +59,7 @@ Verify installation .. code-block:: bash - git clone -b v2.2 https://github.com/Microsoft/nni.git + git clone -b v2.3 https://github.com/Microsoft/nni.git * Run the MNIST example. diff --git a/docs/en_US/Tutorial/InstallationWin.rst b/docs/en_US/Tutorial/InstallationWin.rst index c2fb9bd763..189d9fc5db 100644 --- a/docs/en_US/Tutorial/InstallationWin.rst +++ b/docs/en_US/Tutorial/InstallationWin.rst @@ -40,7 +40,7 @@ If you want to contribute to NNI, refer to `setup development environment