Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Update Quickstart and remove autoCompletion in the doc #3861

Merged
merged 8 commits into from
Jul 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 0 additions & 57 deletions docs/en_US/CommunitySharings/AutoCompletion.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/en_US/CommunitySharings/community_sharings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Use Cases and Solutions
Feature Engineering <feature_engineering>
Performance measurement, comparison and analysis <perf_compare>
Use NNI on Google Colab <NNI_colab_support>
Auto Completion for nnictl Commands <AutoCompletion>

External Repositories and References
====================================
Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/NAS/QuickStart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ The complete code of a simple MNIST example can be found :githublink:`here <exam
Visualize the Experiment
------------------------

Users can visualize their experiment in the same way as visualizing a normal hyper-parameter tuning experiment. For example, open ``localhost::8081`` in your browser, 8081 is the port that you set in ``exp.run``. Please refer to `here <../../Tutorial/WebUI.rst>`__ for details.
Users can visualize their experiment in the same way as visualizing a normal hyper-parameter tuning experiment. For example, open ``localhost::8081`` in your browser, 8081 is the port that you set in ``exp.run``. Please refer to `here <../Tutorial/WebUI.rst>`__ for details.

Export Top Models
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/Overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ For each experiment, the user only needs to define a search space and update a f

Step 2: `Update model codes <TrialExample/Trials.rst>`__

Step 3: `Define Experiment <Tutorial/ExperimentConfig.rst>`__
Step 3: `Define Experiment <reference/experiment_config.rst>`__



Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/Tutorial/Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Our documentation is built with :githublink:`sphinx <docs>`.
* Before submitting the documentation change, please **build homepage locally**: ``cd docs/en_US && make html``, then you can see all the built documentation webpage under the folder ``docs/en_US/_build/html``. It's also highly recommended taking care of **every WARNING** during the build, which is very likely the signal of a **deadlink** and other annoying issues.

*
For links, please consider using **relative paths** first. However, if the documentation is written in Markdown format, and:
For links, please consider using **relative paths** first. However, if the documentation is written in reStructuredText format, and:


* 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.3/`` (: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/master/`` (:githublink:`mnist.py <examples/trials/mnist-pytorch/mnist.py>` for example).
Loading