release note for v2.4 (#4058)

README.md

@@ -27,7 +27,7 @@ The tool manages automated machine learning (AutoML) experiments, **dispatches a
 
 ## **What's NEW!** &nbsp;<a href="#nni-released-reminder"><img width="48" src="docs/img/release_icon.png"></a>
 
-* **New release**: [v2.3 is available](https://github.com/microsoft/nni/releases) - _released on June-15-2021_
+* **New release**: [v2.4 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)
@@ -251,7 +251,7 @@ Note:
 * Download the examples via clone the source code.
 
   ```bash
-  git clone -b v2.3 https://github.com/Microsoft/nni.git
+  git clone -b v2.4 https://github.com/Microsoft/nni.git
   ```
 
 * Run the MNIST example.

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.3``.
+   Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.4``.
 
 #. 
    Install dependencies via ``pip3 install -r xxx.requirements.txt``. ``xxx`` can be ``nasbench101``\ , ``nasbench201`` or ``nds``.

docs/en_US/Release.rst

@@ -5,6 +5,65 @@
 Change Log
 ==========
 
+Release 2.4 - 8/11/2021
+-----------------------
+
+Major Updates
+^^^^^^^^^^^^^
+
+Neural Architecture Search
+""""""""""""""""""""""""""
+
+* NAS visualization: visualize model graph through Netron (#3878)
+* Support NAS bench 101/201 on Retiarii framework (#3871 #3920)
+* Support hypermodule AutoActivation (#3868)
+* Support PyTorch v1.8/v1.9 (#3937)
+* Support Hardware-aware NAS with nn-Meter (#3938)
+* Enable `fixed_arch` on Retiarii (#3972)
+
+Model Compression
+"""""""""""""""""
+
+* Refactor of ModelSpeedup: auto shape/mask inference (#3462)
+* Added more examples for ModelSpeedup (#3880)
+* Support global sort for Taylor pruning (#3896)
+* Support TransformerHeadPruner (#3884)
+* Support batch normalization folding in QAT quantizer (#3911, thanks the external contributor @chenbohua3)
+* Support post-training observer quantizer (#3915, thanks the external contributor @chenbohua3)
+* Support ModelSpeedup for Slim Pruner (#4008)
+* Support TensorRT 8.0.0 in ModelSpeedup (#3866)
+
+Hyper-parameter Tuning
+""""""""""""""""""""""
+
+* Improve HPO benchmarks (#3925)
+* Improve type validation of user defined search space (#3975)
+
+Training service & nnictl
+"""""""""""""""""""""""""
+
+* Support JupyterLab (#3668 #3954)
+* Support viewing experiment from experiment folder (#3870)
+* Support kubeflow in training service reuse framework (#3919)
+* Support viewing trial log on WebUI for an experiment launched in `view` mode (#3872)
+
+Minor Updates & Bug Fixes
+"""""""""""""""""""""""""
+
+* Fix the failure of the exit of Retiarii experiment (#3899)
+* Fix `exclude` not supported in some `config_list` cases (#3815)
+* Fix bug in remote training service on reuse mode (#3941)
+* Improve IP address detection in modern way (#3860)
+* Fix bug of the search box on WebUI (#3935)
+* Fix bug in url_prefix of WebUI (#4051)
+* Support dict format of intermediate on WebUI (#3895)
+* Fix bug in openpai training service induced by experiment config v2 (#4027 #4057)
+* Improved doc (#3861 #3885 #3966 #4004 #3955)
+* Improved the API `export_model` in model compression (#3968)
+* Supported `UnSqueeze` in ModelSpeedup (#3960)
+* Thanks other external contributors: @Markus92 (#3936), @thomasschmied (#3963), @twmht (#3842)
+
+
 Release 2.3 - 6/15/2021
 -----------------------
 

docs/en_US/TrainingService/AMLMode.rst

@@ -113,7 +113,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.3``.
+Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.4``.
 
 Monitor your code in the cloud by using the studio
 --------------------------------------------------

docs/en_US/Tutorial/InstallationLinux.rst

@@ -24,7 +24,7 @@ Install NNI through source code
 
 .. code-block:: bash
 
-     git clone -b v2.3 https://github.com/Microsoft/nni.git
+     git clone -b v2.4 https://github.com/Microsoft/nni.git
      cd nni
      python3 -m pip install -U -r dependencies/setup.txt
      python3 -m pip install -r dependencies/develop.txt
@@ -38,7 +38,7 @@ If you want to perform a persist install instead, we recommend to build your own
 
 .. code-block:: bash
 
-    git clone -b v2.3 https://github.com/Microsoft/nni.git
+    git clone -b v2.4 https://github.com/Microsoft/nni.git
     cd nni
     export NNI_RELEASE=2.0
     python3 -m pip install -U -r dependencies/setup.txt
@@ -61,7 +61,7 @@ Verify installation
 
   .. code-block:: bash
 
-     git clone -b v2.3 https://github.com/Microsoft/nni.git
+     git clone -b v2.4 https://github.com/Microsoft/nni.git
 
 * 
   Run the MNIST example.

docs/en_US/Tutorial/InstallationWin.rst

@@ -40,7 +40,7 @@ If you want to contribute to NNI, refer to `setup development environment <Setup
 
   .. code-block:: bat
 
-       git clone -b v2.3 https://github.com/Microsoft/nni.git
+       git clone -b v2.4 https://github.com/Microsoft/nni.git
        cd nni
        python -m pip install -U -r dependencies/setup.txt
        python -m pip install -r dependencies/develop.txt
@@ -54,7 +54,7 @@ Verify installation
 
   .. code-block:: bat
 
-       git clone -b v2.3 https://github.com/Microsoft/nni.git
+       git clone -b v2.4 https://github.com/Microsoft/nni.git
 
 * 
   Run the MNIST example.

docs/en_US/conf.py

@@ -27,7 +27,7 @@ author = 'Microsoft'
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = 'v2.3'
+release = 'v2.4'
 
 # -- General configuration ---------------------------------------------------