[Dev] Doc Review

[J-shang]

Doc Related PR:

• Use sphinx-argparse to generate nnictl reference #4561
  Reviewer:
• Contribution guide #4557
  Reviewer:
• [Doc] Training service: Remote #4560
  Reviewer:
• Add webportal.rst and webportal_zh.rst in experiment folder #4570
  Reviewer:
• NAS tutorials #4573
  Reviewer:
• [Doc] Compression #4574
  Reviewer:
• [WIP] add doc for evolution #4575
  Reviewer:
• [doc ] refactor of experiment content index #4577
  Reviewer:
• HPO doc #4579
  Reviewer:
• [Doc] NAS #4584
  Reviewer:
• [Doc] AML and OpenPAI training service #4587
  Reviewer:
• [Doc] Tuners: DNGO, PBT, PPO #4589
  Reviewer:
• (draft) HPO quick start #4591
  Reviewer:

[ultmaster]

https://nni.readthedocs.io/en/doc-refactor/experiment/webui.html webui -> webportal
https://nni.readthedocs.io/en/doc-refactor/experiment/exp_management.html exp_management -> experiment_management or exp_manage

table width is weird. Maybe 25%-75% is better than 50%-50%.
Suggest add link to each training service in this table.

[Lijiaoa]

https://nni.readthedocs.io/en/doc-refactor/experiment/webui.html webui -> webportal had done in PR #4570

[Lijiaoa]

https://nni.readthedocs.io/en/doc-refactor/experiment/webui.html webui -> webportal had done in PR #4570

[J-shang]

Compression:

• Scheduled Pruner or Iterative Pruner: Use scheduled pruner because the pruning process in these pruners is scheduled and iteratively, but some other pruners also have some kind of iterative (sparsifying)...

[KeLiChloe]

Pull request of review on model compression【overview】part：#4611

[ultmaster]

HPO:

This looks like "cite". Might be caused by extra indent.

WebUI -> Web portal

Suggest including tuner reference under HPO toc.

[matluster]

HPO Overview:

• The three points correspond to three key features. Suggest adding jumping links:

https://nni.readthedocs.io/en/latest/tutorials/hpo_quickstart_pytorch/main.html

• Seems that "Step 1", "Step 2", ... are not needed.
• Suggest including all the tutorials (PyTorch / tensorflow / ...) in the TOC.
• Are there any tutorial on launching an experiment with nnictl?

https://nni.readthedocs.io/en/latest/hpo/search_space.html

• Suggest adding a warning on the top to clarify that not each type is supported by every tuner.
• Maybe rewrite the types so that each type can be found in the right sidebar.
• Last sentence missing period.

https://nni.readthedocs.io/en/latest/hpo/tuners.html

• If the table in overview is to be deleted, suggest to put the "category" here.

https://nni.readthedocs.io/en/latest/hpo/tensorboard.html

• This page is the same as tensor board page in experiment.

https://nni.readthedocs.io/en/latest/hpo/hpo_benchmark.html

• I think some of the navigation bar items might not work.
• Some of the pages are not included in TOC. Is this intended?

https://nni.readthedocs.io/en/latest/hpo/custom_algorithm.html#customize-assessor

• Customize assessor is in the same page with customize tuner. This looks weird.
• Where is the document to customize advisor?

https://nni.readthedocs.io/en/latest/hpo/custom_algorithm_installation.html

• .. contents is not needed.
• Links are broken: https://nni.readthedocs.io/en/latest/hpo/custom_algorithm_installation.html#create-a-customized-tuner-assessor-advisor
• Unintended "cite":

• SharedStorageConfig:
  • Broken link.
  • NfsConfig and AzureBlobConfig. Why are they not capitalized?

https://nni.readthedocs.io/en/latest/reference/hpo.html

• No separate index in TOC for each tuner.

[matluster]

https://nni.readthedocs.io/en/latest/sharings/community_sharings.html

• There is only one document in each of Compression / Feature Engineering. Suggest flattening it.
• Suggest adding Last updated version / Last updated date, as many of the use cases are out-of-date.

https://nni.readthedocs.io/en/latest/notes/build_from_source.html

• We should ask users to install dependencies/develop.txt before running setup.py develop. Installing dependencies/required.txt is also recommended to avoid automatically installing over-aggressive versions (e.g., rc version). We should also explain the usage of recommended.txt.
• Try avoiding mentioning a specific version number (e.g., 2.7) in commands, as this requires updating every release.
• It's not accurate that Apple Silicon is not supported on Azure pipeline.

[matluster]

https://nni.readthedocs.io/en/latest/reference/others.html

• List is not complete.
• Page title is inconsistent with TOC title.

[matluster]

Quickstart:

• Suggest naming those QuickStarts with a uniformed title format.

[matluster]

HPO Overview:

• The three points correspond to three key features. Suggest adding jumping links:

• Are there any tutorial on launching an experiment with nnictl?

[scarlett2018]

@J-shang - shall we close this issue? are we still working on any of these items?

[J-shang]

@J-shang - shall we close this issue? are we still working on any of these items?

yes, this can be closed