Unverified Commit a0ae02e6 authored by J-shang's avatar J-shang Committed by GitHub
Browse files

change v2.0 to v2.1 (#3443)

parent a272da9e
...@@ -26,7 +26,7 @@ The tool manages automated machine learning (AutoML) experiments, **dispatches a ...@@ -26,7 +26,7 @@ The tool manages automated machine learning (AutoML) experiments, **dispatches a
* ML Platform owners who want to **support AutoML in their platform**. * ML Platform owners who want to **support AutoML in their platform**.
## **What's NEW!** &nbsp;<a href="#nni-released-reminder"><img width="48" src="docs/img/release_icon.png"></a> ## **What's NEW!** &nbsp;<a href="#nni-released-reminder"><img width="48" src="docs/img/release_icon.png"></a>
* **New release**: [v2.0 is available](https://github.com/microsoft/nni/releases) - _released on Jan-14-2021_ * **New release**: [v2.1 is available](https://github.com/microsoft/nni/releases) - _released on Mar-10-2021_
* **New demo available**: [Youtube entry](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - _last updated on Feb-19-2021_ * **New demo available**: [Youtube entry](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - _last updated on Feb-19-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 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_
...@@ -252,7 +252,7 @@ Note: ...@@ -252,7 +252,7 @@ Note:
* Download the examples via clone the source code. * Download the examples via clone the source code.
```bash ```bash
git clone -b v2.0 https://github.com/Microsoft/nni.git git clone -b v2.1 https://github.com/Microsoft/nni.git
``` ```
* Run the MNIST example. * Run the MNIST example.
......
...@@ -25,7 +25,7 @@ Step 1. Download ``bash-completion`` ...@@ -25,7 +25,7 @@ Step 1. Download ``bash-completion``
cd ~ cd ~
wget https://raw.githubusercontent.com/microsoft/nni/{nni-version}/tools/bash-completion 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.0``. You can also check the latest ``bash-completion`` script :githublink:`here <tools/bash-completion>`. Here, {nni-version} should by replaced by the version of NNI, e.g., ``master``, ``v2.1``. You can also check the latest ``bash-completion`` script :githublink:`here <tools/bash-completion>`.
.. cannot find :githublink:`here <tools/bash-completion>`. .. cannot find :githublink:`here <tools/bash-completion>`.
......
...@@ -32,7 +32,7 @@ To avoid storage and legality issues, we do not provide any prepared databases. ...@@ -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 git clone -b ${NNI_VERSION} https://github.com/microsoft/nni
cd nni/examples/nas/benchmarks cd nni/examples/nas/benchmarks
Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.0``. Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.1``.
#. #.
Install dependencies via ``pip3 install -r xxx.requirements.txt``. ``xxx`` can be ``nasbench101``\ , ``nasbench201`` or ``nds``. Install dependencies via ``pip3 install -r xxx.requirements.txt``. ``xxx`` can be ``nasbench101``\ , ``nasbench201`` or ``nds``.
......
...@@ -124,7 +124,7 @@ Run the following commands to start the example experiment: ...@@ -124,7 +124,7 @@ Run the following commands to start the example experiment:
nnictl create --config config_aml.yml nnictl create --config config_aml.yml
Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.0``. Replace ``${NNI_VERSION}`` with a released version name or branch name, e.g., ``v2.1``.
Monitor your code in the cloud by using the studio Monitor your code in the cloud by using the studio
-------------------------------------------------- --------------------------------------------------
......
...@@ -120,7 +120,7 @@ Modify ``nni/examples/trials/ga_squad/config_pai.yml``\ , here is the default co ...@@ -120,7 +120,7 @@ Modify ``nni/examples/trials/ga_squad/config_pai.yml``\ , here is the default co
#Your nni_manager ip #Your nni_manager ip
nniManagerIp: 10.10.10.10 nniManagerIp: 10.10.10.10
tuner: tuner:
codeDir: https://github.com/Microsoft/nni/tree/v2.0/examples/tuners/ga_customer_tuner codeDir: https://github.com/Microsoft/nni/tree/v2.1/examples/tuners/ga_customer_tuner
classFileName: customer_tuner.py classFileName: customer_tuner.py
className: CustomerTuner className: CustomerTuner
classArgs: classArgs:
......
...@@ -71,4 +71,4 @@ Our documentation is built with :githublink:`sphinx <docs>`. ...@@ -71,4 +71,4 @@ Our documentation is built with :githublink:`sphinx <docs>`.
* 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 <https://github.com/Microsoft/nni/issues/new>`__ Box. * 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 <https://github.com/Microsoft/nni/issues/new>`__ 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.0/`` (:githublink:`mnist.py <examples/trials/mnist-pytorch/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.1/`` (:githublink:`mnist.py <examples/trials/mnist-pytorch/mnist.py>` for example).
...@@ -24,7 +24,7 @@ Install NNI through source code ...@@ -24,7 +24,7 @@ Install NNI through source code
.. code-block:: bash .. code-block:: bash
git clone -b v2.0 https://github.com/Microsoft/nni.git git clone -b v2.1 https://github.com/Microsoft/nni.git
cd nni cd nni
python3 -m pip install --upgrade pip setuptools python3 -m pip install --upgrade pip setuptools
python3 setup.py develop python3 setup.py develop
...@@ -37,7 +37,7 @@ If you want to perform a persist install instead, we recommend to build your own ...@@ -37,7 +37,7 @@ If you want to perform a persist install instead, we recommend to build your own
.. code-block:: bash .. code-block:: bash
git clone -b v2.0 https://github.com/Microsoft/nni.git git clone -b v2.1 https://github.com/Microsoft/nni.git
cd nni cd nni
export NNI_RELEASE=2.0 export NNI_RELEASE=2.0
python3 -m pip install --upgrade pip setuptools wheel python3 -m pip install --upgrade pip setuptools wheel
...@@ -59,7 +59,7 @@ Verify installation ...@@ -59,7 +59,7 @@ Verify installation
.. code-block:: bash .. code-block:: bash
git clone -b v2.0 https://github.com/Microsoft/nni.git git clone -b v2.1 https://github.com/Microsoft/nni.git
* *
Run the MNIST example. Run the MNIST example.
......
...@@ -40,7 +40,7 @@ If you want to contribute to NNI, refer to `setup development environment <Setup ...@@ -40,7 +40,7 @@ If you want to contribute to NNI, refer to `setup development environment <Setup
.. code-block:: bat .. code-block:: bat
git clone -b v2.0 https://github.com/Microsoft/nni.git git clone -b v2.1 https://github.com/Microsoft/nni.git
cd nni cd nni
python setup.py develop python setup.py develop
...@@ -52,7 +52,7 @@ Verify installation ...@@ -52,7 +52,7 @@ Verify installation
.. code-block:: bat .. code-block:: bat
git clone -b v2.0 https://github.com/Microsoft/nni.git git clone -b v2.1 https://github.com/Microsoft/nni.git
* *
Run the MNIST example. Run the MNIST example.
......
...@@ -27,7 +27,7 @@ author = 'Microsoft' ...@@ -27,7 +27,7 @@ author = 'Microsoft'
# The short X.Y version # The short X.Y version
version = '' version = ''
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = 'v2.0' release = 'v2.1'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment