Update readme doc link #3482

colorjam · 2021-03-26T07:19:02Z

No description provided.

kvartet

Please change all links of readthedocs to the stable version, because the latest version is synchronized with the master branch, so users may see our unreleased features' docs and feel confused.

QuanluZhang · 2021-03-29T03:26:27Z

README.md

@@ -237,15 +237,15 @@ Windows
 python -m pip install --upgrade nni
 ```

-If you want to try latest code, please [install NNI](https://nni.readthedocs.io/en/latest/installation.html) from source code.
+If you want to try stable code, please [install NNI](https://nni.readthedocs.io/en/stable/installation.html) from source code.


should not be "stable"

i mean the first "stable" in this line

QuanluZhang · 2021-03-29T03:30:21Z

docs/en_US/Compression/Overview.rst

@@ -14,7 +14,8 @@ NNI provides a model compression toolkit to help user compress and speed up thei
 * Provide friendly and easy-to-use compression utilities for users to dive into the compression process and results.
 * Concise interface for users to customize their own compression algorithms.

-*Note that the interface and APIs are unified for both PyTorch and TensorFlow, currently only PyTorch version has been supported, TensorFlow version will be supported in future.*
+*Note that NNI compresses the model through a simulation process. To obtain a truly compact model, users should conduct model speedup. The interface and APIs are unified for both PyTorch and TensorFlow, currently only PyTorch version has been supported, TensorFlow version will be supported in future.*


better to add a link for "conduct model speedup"

"*Note" -> ".. Note:: "

Thanks, fix it.

ultmaster · 2021-03-29T03:46:42Z

docs/en_US/Compression/Tutorial.rst

@@ -23,24 +23,29 @@ There are different keys in a ``dict``. Some of them are common keys supported b

 Some other keys are often specific to a certain algorithm, users can refer to `pruning algorithms <./Pruner.rst>`__ and `quantization algorithms <./Quantizer.rst>`__ for the keys allowed by each algorithm.

-A simple example of configuration is shown below:
+To prune all ``Conv2d`` layers with the sparsity of 0.6, the configuration can be write as:
+.. code-block:: python


Please double-check the rendering results.

Thanks for point out that. Please review the latest version.

kvartet · 2021-03-29T09:10:43Z

README.md

@@ -5,18 +5,18 @@
 -----------

 [![MIT licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)
-[![Build Status](https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/full%20test%20-%20linux?branchName=master)](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=62&branchName=master)
+[![Build Status](https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/full%20test%20-%20linux?branchName=master)](https://msrasrg.visualstudio.com/NNIOpenSource/_build/stable?definitionId=62&branchName=master)


Broken link, only readthedocs links need to be changed.

Thanks, fix it.

linbinskn · 2021-03-29T13:54:37Z

README.md

@@ -297,7 +297,7 @@ You can use these commands to get more information about the experiment
 -----------------------------------------------------------------------
 ```

-* Open the `Web UI url` in your browser, you can view detail information of the experiment and all the submitted trial jobs as shown below. [Here](docs/en_US/Tutorial/WebUI.rst) are more Web UI pages.
+* Open the `Web UI url` in your browser, you can view detail information of the experiment and all the submitted trial jobs as shown below. [Here](https://nni.readthedocs.io/en/stable/Tutorial/WebUI.html) are more Web UI pages.


Recommend using 'detailed information'.

Thanks, fix it.

linbinskn · 2021-03-29T14:09:13Z

docs/en_US/Compression/Overview.rst

@@ -14,7 +14,9 @@ NNI provides a model compression toolkit to help user compress and speed up thei
 * Provide friendly and easy-to-use compression utilities for users to dive into the compression process and results.
 * Concise interface for users to customize their own compression algorithms.

-*Note that the interface and APIs are unified for both PyTorch and TensorFlow, currently only PyTorch version has been supported, TensorFlow version will be supported in future.*
+.. note::
+  NNI compresses the model through a simulation process. To obtain a truly compact model, users should conduct `model speedup <./ModelSpeedup.rst>`__. The interface and APIs are unified for both PyTorch and TensorFlow, currently only PyTorch version has been supported, TensorFlow version will be supported in future.


Since NNI compression algorithms are not meant to compress model while NNI speedup tool can truly compress model and reduce latency . I think 'NNI compression algorithms simulate the the process of pruning and quantization without truly compressing model and reducing latency.' might be more appropriate at the beginning of this paragraph.

Thanks, added.

linbinskn · 2021-03-29T14:14:01Z

docs/en_US/Compression/Tutorial.rst

 * **op_names**\ : This is to specify by name what operations to be compressed. If this field is omitted, operations will not be filtered by it.
 * **exclude**\ : Default is False. If this field is True, it means the operations with specified types and names will be excluded from the compression.

 Some other keys are often specific to a certain algorithm, users can refer to `pruning algorithms <./Pruner.rst>`__ and `quantization algorithms <./Quantizer.rst>`__ for the keys allowed by each algorithm.

-A simple example of configuration is shown below:
+To prune all ``Conv2d`` layers with the sparsity of 0.6, the configuration can be write as:


write -> written

linbinskn · 2021-03-29T14:15:00Z

docs/en_US/Compression/Tutorial.rst

+    'op_types': ['Conv2d']
+   }]
+
+To control the sparsity of specific layers, the configuration can be writed as:


write -> written

colorjam added 3 commits March 26, 2021 07:16

Update readme nnidoc link

ac54b30

Clarify compression doc

3ef10bf

Fix warning

7c3186c

SparkSnail mentioned this pull request Mar 26, 2021

NNI 2021 Mar~Apr Iteration Planning #3445

Closed

78 tasks

SparkSnail requested review from kvartet and linbinskn March 26, 2021 08:51

kvartet reviewed Mar 26, 2021

View reviewed changes

colorjam added 3 commits March 29, 2021 02:09

Update according to comments & fix warning

46b99c0

Add a blank line

f0154be

Fix warning

e8f8e57

QuanluZhang requested review from ultmaster and scarlett2018 March 29, 2021 03:22

QuanluZhang reviewed Mar 29, 2021

View reviewed changes

Update according to comments

d6dcaa5

ultmaster reviewed Mar 29, 2021

View reviewed changes

colorjam added 4 commits March 29, 2021 05:56

Fix minor bugs

a5ee770

Unify config list

ff02c77

Add conduct model speedup link

740b8e2

Fix minor bugs

c4a70dd

kvartet reviewed Mar 29, 2021

View reviewed changes

linbinskn reviewed Mar 29, 2021

View reviewed changes

colorjam added 5 commits March 30, 2021 01:43

Fix dead link

4ec0f5f

Fix typos.

c23c63e

Fix typo

c194bd4

Fix dead links

6c1542c

Update

1c76fe0

ultmaster approved these changes Apr 2, 2021

View reviewed changes

QuanluZhang approved these changes Apr 3, 2021

View reviewed changes

QuanluZhang merged commit 0494cae into microsoft:master Apr 3, 2021

acured pushed a commit to acured/nni that referenced this pull request Apr 7, 2021

Update readme doc link (microsoft#3482)

80f5ad1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme doc link #3482

Update readme doc link #3482

colorjam commented Mar 26, 2021

kvartet left a comment

QuanluZhang Mar 29, 2021

QuanluZhang Mar 29, 2021

QuanluZhang Mar 29, 2021 •

edited

Loading

QuanluZhang Mar 29, 2021

colorjam Mar 29, 2021

ultmaster Mar 29, 2021

colorjam Mar 29, 2021

kvartet Mar 29, 2021

colorjam Mar 30, 2021

linbinskn Mar 29, 2021

colorjam Mar 30, 2021

linbinskn Mar 29, 2021

colorjam Mar 30, 2021

linbinskn Mar 29, 2021

colorjam Mar 30, 2021

linbinskn Mar 29, 2021

colorjam Mar 30, 2021

Update readme doc link #3482

Update readme doc link #3482

Conversation

colorjam commented Mar 26, 2021

kvartet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

QuanluZhang Mar 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

QuanluZhang Mar 29, 2021 •

edited

Loading