From 7111dc8a4dc90675f73e886b8c11ecee345a41aa Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:30:24 +0800 Subject: [PATCH 01/10] Update BuiltinTuner.md --- docs/en_US/Tuner/BuiltinTuner.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/en_US/Tuner/BuiltinTuner.md b/docs/en_US/Tuner/BuiltinTuner.md index 137b822c98..f438239067 100644 --- a/docs/en_US/Tuner/BuiltinTuner.md +++ b/docs/en_US/Tuner/BuiltinTuner.md @@ -1,6 +1,6 @@ -# Built-in Tuners +# Built-in Tuners for Hyperparameter Tuning -NNI provides state-of-the-art tuning algorithm as our built-in tuners and makes them easy to use. Below is the brief summary of NNI currently built-in tuners: +NNI provides state-of-the-art tuning algorithms as our built-in tuners and makes them easy to use. Below is the brief summary of NNI currently built-in tuners: Note: Click the **Tuner's name** to get the Tuner's installation requirements, suggested scenario and using example. The link for a detailed description of the algorithm is at the end of the suggested scenario of each tuner. Here is an [article](../CommunitySharings/HpoComparision.md) about the comparison of different Tuners on several problems. @@ -453,3 +453,9 @@ tuner: classArgs: optimize_mode: maximize ``` +## **Reference and Feedback** +* To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub; +* To [file a feature or improvement request](https://github.com/microsoft/nni/issues/new?template=enhancement.md) for this feature in GitHub; +* To know more about [Feature Engineering with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/FeatureEngineering/Overview.md); +* To know more about [NAS with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/NAS/Overview.md); +* To know more about [Model Compression with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Compressor/Overview.md); From 907a68907cc39b681aa5dec28ab50451f200daa8 Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:33:23 +0800 Subject: [PATCH 02/10] Update Overview.md (#1880) --- docs/en_US/FeatureEngineering/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_US/FeatureEngineering/Overview.md b/docs/en_US/FeatureEngineering/Overview.md index 30b0a51956..3656a42184 100644 --- a/docs/en_US/FeatureEngineering/Overview.md +++ b/docs/en_US/FeatureEngineering/Overview.md @@ -1,4 +1,4 @@ -# FeatureEngineering +# Feature Engineering We are glad to announce the alpha release for Feature Engineering toolkit on top of NNI, it's still in the experiment phase which might evolve based on user feedback. We'd like to invite you to use, feedback and even contribute. From 8475df4d47d22bb19a3c6f8c872c122657622755 Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:34:15 +0800 Subject: [PATCH 03/10] Update Overview.md --- docs/en_US/FeatureEngineering/Overview.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/en_US/FeatureEngineering/Overview.md b/docs/en_US/FeatureEngineering/Overview.md index 3656a42184..c9abcd1a55 100644 --- a/docs/en_US/FeatureEngineering/Overview.md +++ b/docs/en_US/FeatureEngineering/Overview.md @@ -256,3 +256,9 @@ The dataset of benchmark could be download in [here](https://www.csie.ntu.edu.tw ) The code could be refenrence `/examples/feature_engineering/gradient_feature_selector/benchmark_test.py`. + +## **Reference and Feedback** +* To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub; +* To [file a feature or improvement request](https://github.com/microsoft/nni/issues/new?template=enhancement.md) for this feature in GitHub; +* To [know more about implement NAS with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/NAS/Overview.md); +* To [know more about model compression with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Compressor/Overview.md); From 564ca7575e8f5f508c2b352a0f5aecbb59cef7c6 Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:36:15 +0800 Subject: [PATCH 04/10] Update Overview.md --- docs/en_US/FeatureEngineering/Overview.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/en_US/FeatureEngineering/Overview.md b/docs/en_US/FeatureEngineering/Overview.md index c9abcd1a55..cd1263c279 100644 --- a/docs/en_US/FeatureEngineering/Overview.md +++ b/docs/en_US/FeatureEngineering/Overview.md @@ -260,5 +260,6 @@ The code could be refenrence `/examples/feature_engineering/gradient_feature_sel ## **Reference and Feedback** * To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub; * To [file a feature or improvement request](https://github.com/microsoft/nni/issues/new?template=enhancement.md) for this feature in GitHub; -* To [know more about implement NAS with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/NAS/Overview.md); -* To [know more about model compression with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Compressor/Overview.md); +* To know more about [Neural Architecture Search with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/NAS/Overview.md); +* To know more about [Model Compression with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Compressor/Overview.md); +* To know more about [Hyperparameter Tuning with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Tuner/BuiltinTuner.md); From 0066a8b7a946e31075ee3ed595b23d7925d255db Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:38:20 +0800 Subject: [PATCH 05/10] Update Overview.md --- docs/en_US/FeatureEngineering/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_US/FeatureEngineering/Overview.md b/docs/en_US/FeatureEngineering/Overview.md index cd1263c279..478693c399 100644 --- a/docs/en_US/FeatureEngineering/Overview.md +++ b/docs/en_US/FeatureEngineering/Overview.md @@ -1,4 +1,4 @@ -# Feature Engineering +# Feature Engineering with NNI We are glad to announce the alpha release for Feature Engineering toolkit on top of NNI, it's still in the experiment phase which might evolve based on user feedback. We'd like to invite you to use, feedback and even contribute. From 1dfd389c1daf96b0d9bf553861ea22dbfd9b716e Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:44:35 +0800 Subject: [PATCH 06/10] Update Overview.md --- docs/en_US/NAS/Overview.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/en_US/NAS/Overview.md b/docs/en_US/NAS/Overview.md index 3426673669..7544bc5521 100644 --- a/docs/en_US/NAS/Overview.md +++ b/docs/en_US/NAS/Overview.md @@ -111,3 +111,9 @@ NNI proposed API is [here](https://github.com/microsoft/nni/tree/master/src/sdk/ [3]: https://arxiv.org/abs/1806.09055 [4]: https://arxiv.org/abs/1806.10282 [5]: https://arxiv.org/abs/1703.01041 + +## **Reference and Feedback** +* To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub; +* To [file a feature or improvement request](https://github.com/microsoft/nni/issues/new?template=enhancement.md) for this feature in GitHub; +* To know more about [Feature Engineering with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/FeatureEngineering/Overview.md); +* To know more about [Model Compression with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Compressor/Overview.md); From 26c37d0fbe97e780c0074c078916fe61a7acebda Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:45:55 +0800 Subject: [PATCH 07/10] Update Overview.md --- docs/en_US/NAS/Overview.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/en_US/NAS/Overview.md b/docs/en_US/NAS/Overview.md index 7544bc5521..98854f2ecd 100644 --- a/docs/en_US/NAS/Overview.md +++ b/docs/en_US/NAS/Overview.md @@ -117,3 +117,4 @@ NNI proposed API is [here](https://github.com/microsoft/nni/tree/master/src/sdk/ * To [file a feature or improvement request](https://github.com/microsoft/nni/issues/new?template=enhancement.md) for this feature in GitHub; * To know more about [Feature Engineering with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/FeatureEngineering/Overview.md); * To know more about [Model Compression with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Compressor/Overview.md); +* To know more about [Hyperparameter Tuning with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Tuner/BuiltinTuner.md); From 1c8cdaefafbc01b9e7189277703721b0df57a812 Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:48:31 +0800 Subject: [PATCH 08/10] Update Overview.md --- docs/en_US/Compressor/Overview.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/en_US/Compressor/Overview.md b/docs/en_US/Compressor/Overview.md index f277de5c0f..45de3b958f 100644 --- a/docs/en_US/Compressor/Overview.md +++ b/docs/en_US/Compressor/Overview.md @@ -1,4 +1,4 @@ -# Compressor +# Model Compression with NNI We are glad to announce the alpha release for model compression toolkit on top of NNI, it's still in the experiment phase which might evolve based on usage feedback. We'd like to invite you to use, feedback and even contribute. @@ -260,4 +260,11 @@ class YourQuantizer(nni.compression.tensorflow.Quantizer): ### Usage of user customized compression algorithm -__[TODO]__ ... +__[Coming Soon]__ ... + +## **Reference and Feedback** +* To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub; +* To [file a feature or improvement request](https://github.com/microsoft/nni/issues/new?template=enhancement.md) for this feature in GitHub; +* To know more about [Feature Engineering with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/FeatureEngineering/Overview.md); +* To know more about [NAS with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/NAS/Overview.md); +* To know more about [Hyperparameter Tuning with NNI](https://github.com/microsoft/nni/blob/master/docs/en_US/Tuner/BuiltinTuner.md); From 4ce0be9d736814940cf5da34caeb15996719b81e Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:49:19 +0800 Subject: [PATCH 09/10] Update Overview.md --- docs/en_US/Compressor/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_US/Compressor/Overview.md b/docs/en_US/Compressor/Overview.md index 45de3b958f..c3882cfe6b 100644 --- a/docs/en_US/Compressor/Overview.md +++ b/docs/en_US/Compressor/Overview.md @@ -260,7 +260,7 @@ class YourQuantizer(nni.compression.tensorflow.Quantizer): ### Usage of user customized compression algorithm -__[Coming Soon]__ ... +__Coming Soon__ ... ## **Reference and Feedback** * To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub; From 0209ae98c92a7170818ac8ef909c837bb4309028 Mon Sep 17 00:00:00 2001 From: Scarlett Li <39592018+scarlett2018@users.noreply.github.com> Date: Thu, 26 Dec 2019 18:49:35 +0800 Subject: [PATCH 10/10] Update Overview.md --- docs/en_US/Compressor/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_US/Compressor/Overview.md b/docs/en_US/Compressor/Overview.md index c3882cfe6b..f17069ed62 100644 --- a/docs/en_US/Compressor/Overview.md +++ b/docs/en_US/Compressor/Overview.md @@ -260,7 +260,7 @@ class YourQuantizer(nni.compression.tensorflow.Quantizer): ### Usage of user customized compression algorithm -__Coming Soon__ ... +_Coming Soon_ ... ## **Reference and Feedback** * To [report a bug](https://github.com/microsoft/nni/issues/new?template=bug-report.md) for this feature in GitHub;