Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Update release note and version number #4471

Merged
merged 8 commits into from
Jan 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,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.5 is available](https://github.com/microsoft/nni/releases/tag/v2.5) - _released on Nov-04-2021_
* **New release**: [v2.6 is available](https://github.com/microsoft/nni/releases/tag/v2.6) - _released on Jan-19-2022_
* **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)
Expand Down Expand Up @@ -253,7 +253,7 @@ Note:
* Download the examples via clone the source code.

```bash
git clone -b v2.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git
```

* Run the MNIST example.
Expand Down
4 changes: 2 additions & 2 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ NNI 管理自动机器学习 (AutoML) 的 Experiment,**调度运行**由调优

## **最新消息!** &nbsp;[<img width="48" src="docs/img/release_icon.png" />](#nni-released-reminder)

* **最新版本**:[v2.5 已发布](https://github.com/microsoft/nni/releases/tag/v2.5) - *2021年11月04日*
* **最新版本**:[v2.6 已发布](https://github.com/microsoft/nni/releases/tag/v2.6) - *2022年1月19日*
* **最新视频 demo**:[Youtube 入口](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - *上次更新:2021年5月26日*
* **最新网络研讨会**: [介绍Retiarii:NNI 上的深度学习探索性训练框架](https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-Live.html) - *2021年6月24日*
* **最新互动渠道**: [Discussions](https://github.com/microsoft/nni/discussions)
Expand Down Expand Up @@ -249,7 +249,7 @@ Linux 和 macOS 下 NNI 系统需求[参考这里](https://nni.readthedocs.io/zh
* 通过克隆源代码下载示例。

```bash
git clone -b v2.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git
```

* 运行 MNIST 示例。
Expand Down
83 changes: 83 additions & 0 deletions docs/en_US/Release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,89 @@
Change Log
==========

Release 2.6 - 1/19/2022
-----------------------

**NOTE**: NNI v2.6 is the last version that supports Python 3.6. From next release NNI will require Python 3.7+.

Hyper-Parameter Optimization
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Experiment
""""""""""

* The legacy experiment config format is now deprecated. `(doc of new config) <https://nni.readthedocs.io/en/v2.6/reference/experiment_config.html>`__

* If you are still using legacy format, nnictl will show equivalent new config on start. Please save it to replace the old one.

* nnictl now uses ``nni.experiment.Experiment`` `APIs <https://nni.readthedocs.io/en/stable/Tutorial/HowToLaunchFromPython.html>`__ as backend. The output message of create, resume, and view commands have changed.
* Added Kubeflow and Frameworkcontroller support to hybrid mode. `(doc) <https://nni.readthedocs.io/en/v2.6/TrainingService/HybridMode.html>`__
* The hidden tuner manifest file has been updated. This should be transparent to users, but if you encounter issues like failed to find tuner, please try to remove ``~/.config/nni``.

Algorithms
""""""""""

* Random tuner now supports classArgs ``seed``. `(doc) <https://nni.readthedocs.io/en/v2.6/Tuner/RandomTuner.html>`__
* TPE tuner is refactored: `(doc) <https://nni.readthedocs.io/en/v2.6/Tuner/TpeTuner.html>`__

* Support classArgs ``seed``.
* Support classArgs ``tpe_args`` for expert users to customize algorithm behavior.
* Parallel optimization has been turned on by default. To turn it off set ``tpe_args.constant_liar_type`` to ``null`` (or ``None`` in Python).
* ``parallel_optimize`` and ``constant_liar_type`` has been removed. If you are using them please update your config to use ``tpe_args.constant_liar_type`` instead.

* Grid search tuner now supports all search space types, including uniform, normal, and nested choice. `(doc) <https://nni.readthedocs.io/en/v2.6/Tuner/GridsearchTuner.html>`__

Neural Architecture Search
^^^^^^^^^^^^^^^^^^^^^^^^^^

* Enhancement to serialization utilities `(doc) <https://nni.readthedocs.io/en/v2.6/NAS/Serialization.html>`__ and changes to recommended practice of customizing evaluators. `(doc) <https://nni.readthedocs.io/en/v2.6/NAS/QuickStart.html#pick-or-customize-a-model-evaluator>`__
* Support latency constraint on edge device for ProxylessNAS based on nn-Meter. `(doc) <https://nni.readthedocs.io/en/v2.6/NAS/Proxylessnas.html>`__
* Trial parameters are showed more friendly in Retiarii experiments.
* Refactor NAS examples of ProxylessNAS and SPOS.

Model Compression
^^^^^^^^^^^^^^^^^

* New Pruner Supported in Pruning V2

* Auto-Compress Pruner `(doc) <https://nni.readthedocs.io/en/v2.6/Compression/v2_pruning_algo.html#auto-compress-pruner>`__
* AMC Pruner `(doc) <https://nni.readthedocs.io/en/v2.6/Compression/v2_pruning_algo.html#amc-pruner>`__
* Movement Pruning Pruner `(doc) <https://nni.readthedocs.io/en/v2.6/Compression/v2_pruning_algo.html#movement-pruner>`__

* Support ``nni.trace`` wrapped ``Optimizer`` in Pruning V2. In the case of not affecting the user experience as much as possible, trace the input parameters of the optimizer. `(doc) <https://nni.readthedocs.io/en/v2.6/Compression/v2_pruning_algo.html>`__
* Optimize Taylor Pruner, APoZ Activation Pruner, Mean Activation Pruner in V2 memory usage.
* Add more examples for Pruning V2.
* Add document for pruning config list. `(doc) <https://nni.readthedocs.io/en/v2.6/Compression/v2_pruning_config_list.html>`__
* Parameter ``masks_file`` of ``ModelSpeedup`` now accepts `pathlib.Path` object. (Thanks to @dosemeion) `(doc) <https://nni.readthedocs.io/en/v2.6/Compression/ModelSpeedup.html#user-configuration-for-modelspeedup>`__
* Bug Fix

* Fix Slim Pruner in V2 not sparsify the BN weight.
* Fix Simulator Annealing Task Generator generates config ignoring 0 sparsity.

Documentation
^^^^^^^^^^^^^

* Supported GitHub feature "Cite this repository".
* Updated index page of readthedocs.
* Updated Chinese documentation.

* From now on NNI only maintains translation for most import docs and ensures they are up to date.

* Reorganized HPO tuners' doc.

Bugfixes
^^^^^^^^

* Fixed a bug where numpy array is used as a truth value. (Thanks to @khituras)
* Fixed a bug in updating search space.
* Fixed a bug that HPO search space file does not support scientific notation and tab indent.

* For now NNI does not support mixing scientific notation and YAML features. We are waiting for PyYAML to update.

* Fixed a bug that causes DARTS 2nd order to crash.
* Fixed a bug that causes deep copy of mutation primitives (e.g., LayerChoice) to crash.
* Removed blank at bottom in Web UI overview page.

Release 2.5 - 11/2/2021
-----------------------

Expand Down
6 changes: 3 additions & 3 deletions docs/en_US/Tutorial/InstallationLinux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Install NNI through source code

.. code-block:: bash

git clone -b v2.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 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
Expand All @@ -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.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git
cd nni
export NNI_RELEASE=2.0
python3 -m pip install -U -r dependencies/setup.txt
Expand All @@ -61,7 +61,7 @@ Verify installation

.. code-block:: bash

git clone -b v2.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git

*
Run the MNIST example.
Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/Tutorial/InstallationWin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you want to contribute to NNI, refer to `setup development environment <Setup

.. code-block:: bat

git clone -b v2.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 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
Expand All @@ -54,7 +54,7 @@ Verify installation

.. code-block:: bat

git clone -b v2.5 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git

*
Run the MNIST example.
Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/_templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ <h2>What's NEW! </h2>
</div>
<hr class="whatNew"/>
<ul>
<li><b>New release:</b> <a href='https://github.com/microsoft/nni/releases/tag/v2.5'>{{ release }} is available2 <i>- released on Nov-04-2021</i></a></li>
<li><b>New release:</b> <a href='https://github.com/microsoft/nni/releases/tag/v2.6'>{{ release }} is available2 <i>- released on Jan-18-2022</i></a></li>
<li><b>New demo available:</b> <a href="https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw">Youtube entry</a> | <a href="https://space.bilibili.com/1649051673">Bilibili</a> 入口 <i>- last updated on May-26-2021</i></li>
<li><b>New webinar:</b> <a href="https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-On-Demand.html">
Introducing Retiarii: A deep learning exploratory-training framework on NNI
Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = 'v2.5'
release = 'v2.6'

# -- General configuration ---------------------------------------------------

Expand Down
12 changes: 6 additions & 6 deletions docs/zh_CN/Tutorial/InstallationLinux.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. 0f5fee8263b2829f156835c1e895bf2e
.. 1488ec09b21ac2a6c35b41f710c9211e

在 Linux 和 Mac 下安装
======================
Expand Down Expand Up @@ -26,7 +26,7 @@

.. code-block:: bash

git clone -b v2.0 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git
cd nni
python3 -m pip install --upgrade pip setuptools
python3 setup.py develop
Expand All @@ -39,14 +39,14 @@

.. code-block:: bash

git clone -b v2.0 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git
cd nni
export NNI_RELEASE=2.0
export NNI_RELEASE=2.6
python3 -m pip install --upgrade pip setuptools wheel
python3 setup.py clean --all
python3 setup.py build_ts
python3 setup.py bdist_wheel -p manylinux1_x86_64
python3 -m pip install dist/nni-2.0-py3-none-manylinux1_x86_64.whl
python3 -m pip install dist/nni-2.6-py3-none-manylinux1_x86_64.whl

在 Docker 映像中使用 NNI
^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -61,7 +61,7 @@

.. code-block:: bash

git clone -b v2.0 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git

*
运行 MNIST 示例。
Expand Down
6 changes: 3 additions & 3 deletions docs/zh_CN/Tutorial/InstallationWin.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. a6dd4da0aa88f250a7b1146566021ce8
.. acdfab53c8209a53709a5bdca72d29b2

在 Windows 上安装
==================
Expand Down Expand Up @@ -42,7 +42,7 @@

.. code-block:: bat

git clone -b v2.0 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git
cd nni
python setup.py develop

Expand All @@ -54,7 +54,7 @@

.. code-block:: bat

git clone -b v2.0 https://github.com/Microsoft/nni.git
git clone -b v2.6 https://github.com/Microsoft/nni.git

*
运行 MNIST 示例。
Expand Down