Update Quickstart and remove autoCompletion in the doc #3861

kvartet · 2021-06-22T11:31:31Z

some improvements:

update the quickstart doc: change the v1 config to the v2 config and make it more user-friendly
remove the nnictl auto-completion part in the doc, which is unsupported now
fix typos in docs and codes: alogrithm, achine, complted
fix the wrong header level

liuzhe-lz · 2021-06-25T02:55:21Z

docs/en_US/Tutorial/QuickStart.rst

@@ -4,7 +4,7 @@ QuickStart
 Installation
 ------------

-We currently support Linux, macOS, and Windows. Ubuntu 16.04 or higher, macOS 10.14.1, and Windows 10.1809 are tested and supported. Simply run the following ``pip install`` in an environment that has ``python >= 3.6``.
+Currently, NNI supports running on Linux, MacOS and Windows. Ubuntu 16.04 or higher, macOS 10.14.1, and Windows 10.1809 are tested and supported. Simply run the following ``pip install`` in an environment that has ``python >= 3.6``.


It's macOS.
https://en.wikipedia.org/wiki/MacOS

Thanks for pointing it out, I will update it.

liuzhe-lz · 2021-06-25T02:57:32Z

docs/en_US/Tutorial/QuickStart.rst

+   experimentName: MNIST               # An optional name to distinguish the experiments
+   searchSpaceFile: search_space.json  # The path to the search space file
+   trialCommand: python3 mnist.py      # NOTE: change "python3" to "python" if you are using Windows
+   trialCodeDirectory: .               # The path to the trial code


As a template, I think it's save to remove this line and ask the user to put config file in trial code's top directory.

okay, will update it

liuzhe-lz · 2021-06-25T03:00:20Z

docs/en_US/Tutorial/QuickStart.rst


-Run the **config_windows.yml** file from your command line to start an MNIST experiment.
+Run the **config_windows.yml** file from your command line to start the experiment.


Ooops, I removed config_windows.yml. I thought it's suggesting NNI behaves differently on Windows and Linux, which is not the case.
If it makes doc or quick start hard or complex, please add it back. Just copy config.yml and change python3 to python.

hahaha, a user asked in the WeChat group why there is no config_windows.yml example for v2.3, so I add it back?

Another choice is to tell the users to update the config. I don't know which is better.

I modified all the config files in quickstart to config_detailed.yml, which including the inline search space and swapped the search space part and the trial code part so that users can config the experiment directly in the YAML file after writing the search space.
I didn't add config_windows.yml instead of asking users to update the trialCommand according to your suggestion.

liuzhe-lz · 2021-06-25T04:30:18Z

docs/en_US/Tutorial/QuickStart.rst


-**Step 1**: Write a ``Search Space`` file in JSON, including the ``name`` and the ``distribution`` (discrete-valued or continuous-valued) of all the hyperparameters you need to search.
+Define a ``Search Space`` in the JSON file, including the ``name`` and the ``distribution`` (discrete-valued or continuous-valued) of all the hyperparameters you want to search.


Maybe we can suggest embedded search space. It's more convenient in most cases.

ok, so do we need to remove the JSON part? or suggest two ways to define the search space in the quickstart?

I think in quick start we can remove JSON part.

ultmaster · 2021-06-25T05:44:15Z

docs/en_US/Tutorial/QuickStart.rst


-**Step 1**: Write a ``Search Space`` file in JSON, including the ``name`` and the ``distribution`` (discrete-valued or continuous-valued) of all the hyperparameters you need to search.
+Define a ``Search Space`` in the JSON file, including the ``name`` and the ``distribution`` (discrete-valued or continuous-valued) of all the hyperparameters you want to search.


ultmaster · 2021-06-25T05:47:18Z

docs/en_US/CommunitySharings/AutoCompletion.rst

@@ -1,57 +0,0 @@
-Auto Completion for nnictl Commands
-===================================
-


Do we have a future plan to support this feature? If yes, we can add a .. warning here that states the feature is broken in current releases and will be fixed in feature.

It seems that @liuzhe-lz is the owner of this feature. - would you mind tell us the future plan?

It is planned, with low priority.

This feature has been deferred since v2.0, and we can't estimate when it will be implemented, so I temporarily removed it...

docs/en_US/Tutorial/QuickStart.rst

khituras · 2021-08-11T08:01:42Z

The autoCompletion is still pointed to at https://nni.readthedocs.io/en/stable/Tutorial/QuickStart.html. It should be removed from there as well, I just searched for it until I found this issue.

QuanluZhang · 2021-08-11T10:21:19Z

@khituras thanks for reporting this issue. would you mind to create a pr to help fix it?

khituras · 2021-08-11T12:29:41Z

Thanks for the response @QuanluZhang.
I gladly would, however it has already been done per this issue. The current file at https://github.com/microsoft/nni/blob/master/docs/en_US/Tutorial/QuickStart.rst does ot mention the auto completion script.
However, the online documentation seems to be old. It needs to be updated from sources, I guess.

QuanluZhang · 2021-08-11T12:38:08Z

Thanks for the response @QuanluZhang.
I gladly would, however it has already been done per this issue. The current file at https://github.com/microsoft/nni/blob/master/docs/en_US/Tutorial/QuickStart.rst does ot mention the auto completion script.
However, the online documentation seems to be old. It needs to be updated from sources, I guess.

oh, yes, sorry for the misleading. this has been fixed in the latest master. you can double check through this line https://nni.readthedocs.io/en/latest/ which is rendered from the latest master

khituras · 2021-08-11T14:55:18Z

I see. I just followed the link from https://github.com/microsoft/nni. Perhaps this link should point to latest then?

kvartet added 7 commits June 17, 2021 20:32

typo

b2f9454

header level

b30e161

rm auto-completion

2ef40a4

quickstart

8d03240

lint

06e5c54

fix typo

5cc4ca9

minor

1bcaa44

QuanluZhang requested review from ultmaster and liuzhe-lz June 23, 2021 02:39

liuzhe-lz reviewed Jun 25, 2021

View reviewed changes

ultmaster reviewed Jun 25, 2021

View reviewed changes

QuanluZhang mentioned this pull request Jun 25, 2021

NNI 2021 June~July Iteration Planning #3724

Closed

comments

4e1d705

kvartet requested review from ultmaster and liuzhe-lz June 29, 2021 07:30

ultmaster approved these changes Jul 2, 2021

View reviewed changes

QuanluZhang requested a review from scarlett2018 July 9, 2021 07:03

scarlett2018 approved these changes Jul 9, 2021

View reviewed changes

QuanluZhang reviewed Jul 11, 2021

View reviewed changes

docs/en_US/Tutorial/QuickStart.rst Show resolved Hide resolved

QuanluZhang approved these changes Jul 12, 2021

View reviewed changes

QuanluZhang merged commit fb3c596 into microsoft:master Jul 12, 2021

kvartet deleted the update-doc branch October 16, 2021 07:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Quickstart and remove autoCompletion in the doc #3861

Update Quickstart and remove autoCompletion in the doc #3861

kvartet commented Jun 22, 2021 •

edited

liuzhe-lz Jun 25, 2021 •

edited

kvartet Jun 25, 2021

liuzhe-lz Jun 25, 2021

kvartet Jun 25, 2021

liuzhe-lz Jun 25, 2021

kvartet Jun 25, 2021

liuzhe-lz Jun 25, 2021

kvartet Jun 29, 2021 •

edited

liuzhe-lz Jun 25, 2021

ultmaster Jun 25, 2021

kvartet Jun 25, 2021

liuzhe-lz Jun 25, 2021

ultmaster Jun 25, 2021

ultmaster Jun 25, 2021

kvartet Jun 25, 2021

liuzhe-lz Jun 25, 2021 •

edited

kvartet Jun 29, 2021 •

edited

khituras commented Aug 11, 2021

QuanluZhang commented Aug 11, 2021

khituras commented Aug 11, 2021

QuanluZhang commented Aug 11, 2021

khituras commented Aug 11, 2021


		Run the config_windows.yml file from your command line to start an MNIST experiment.
		Run the config_windows.yml file from your command line to start the experiment.


		Step 1: Write a ``Search Space`` file in JSON, including the ``name`` and the ``distribution`` (discrete-valued or continuous-valued) of all the hyperparameters you need to search.
		Define a ``Search Space`` in the JSON file, including the ``name`` and the ``distribution`` (discrete-valued or continuous-valued) of all the hyperparameters you want to search.

		@@ -1,57 +0,0 @@
		Auto Completion for nnictl Commands
		===================================

Update Quickstart and remove autoCompletion in the doc #3861

Update Quickstart and remove autoCompletion in the doc #3861

Conversation

kvartet commented Jun 22, 2021 • edited

liuzhe-lz Jun 25, 2021 • edited

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

kvartet Jun 29, 2021 • edited

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

liuzhe-lz Jun 25, 2021 • edited

Choose a reason for hiding this comment

kvartet Jun 29, 2021 • edited

Choose a reason for hiding this comment

khituras commented Aug 11, 2021

QuanluZhang commented Aug 11, 2021

khituras commented Aug 11, 2021

QuanluZhang commented Aug 11, 2021

khituras commented Aug 11, 2021

kvartet commented Jun 22, 2021 •

edited

liuzhe-lz Jun 25, 2021 •

edited

kvartet Jun 29, 2021 •

edited

liuzhe-lz Jun 25, 2021 •

edited

kvartet Jun 29, 2021 •

edited