This repository has been archived by the owner on Sep 18, 2024. It is now read-only.
Port markdown docs to rst and introduce "githublink" #3107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Let's do an investigation of Chinese docs through PR #3154 first. |
liuzhe-lz
reviewed
Dec 9, 2020
| **y** (array-like, require) - The target values (class labels in classification, real numbers in regression) which shape = [n_samples]. | ||
|
|
||
| * | ||
| **lgb_params** (dict, require) - The parameters for lightgbm model. The detail you could reference `here <https://lightgbm.readthedocs.io/en/latest/Parameters.html>`__ |
There was a problem hiding this comment.
Use only one underscore will produce warnings. I don't fully understand this though.
liuzhe-lz
reviewed
Dec 9, 2020
|
|
||
| pruner.export_model(model_path='model.pth') | ||
|
|
||
| ``mask_dict`` and pruned model in ``onnx`` format(\ ``input_shape`` need to be specified) can also be exported like this: |
There was a problem hiding this comment.
Blackslash is for whitespace. It's converted from markdown. Maybe we can get rid of this later.
kvartet
reviewed
Dec 9, 2020
docs/en_US/Tuner/BuiltinTuner.rst
Outdated
|
|
||
| * - Tuner | ||
| - Brief Introduction of Algorithm | ||
| * - `**TPE** <#TPE>`__ |
There was a problem hiding this comment.
There's something wrong with the bold font.
kvartet
reviewed
Dec 9, 2020
| Currently, we support the following algorithms: | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 |
There was a problem hiding this comment.
Maybe we could add :widths: auto
kvartet
reviewed
Dec 9, 2020
docs/en_US/TrialExample/Trials.rst
Outdated
|
|
||
| In the YAML configure file, you need to set *useAnnotation* to true to enable NNI annotation: | ||
|
|
||
| .. code-block:::: bash |
kvartet
reviewed
Dec 9, 2020
docs/en_US/Tuner/BuiltinTuner.rst
Outdated
| Usage of Built-in Tuners | ||
| ------------------------ | ||
|
|
||
| Using a built-in tuner provided by the NNI SDK requires one to declare the **builtinTunerName** and** classArgs** in the ``config.yml`` file. In this part, we will introduce each tuner along with information about usage and suggested scenarios, classArg requirements, and an example configuration. |
kvartet
reviewed
Dec 9, 2020
docs/en_US/Tuner/BuiltinTuner.rst
Outdated
| classArgs: | ||
| optimize_mode: maximize | ||
|
|
||
| Note that, to use this tuner, your trial code should be modified accordingly, please refer to `the document of PBTTuner <./PBTTuner>`__ for details. |
kvartet
reviewed
Dec 9, 2020
docs/en_US/Tuner/BuiltinTuner.rst
Outdated
| Built-in Tuner Name: **PPOTuner** | ||
|
|
||
|
|
||
| Note that the only acceptable types within the search space are ``layer_choice`` and ``input_choice``. For ``input_choice``\ , ``n_chosen`` can only be 0, 1, or [0, 1]. Note, the search space file for NAS is usually automatically generated through the command `\ ``nnictl ss_gen`` <../Tutorial/Nnictl>`__. |
There was a problem hiding this comment.
the command \ ``nnictl ss_gen`` <../Tutorial/Nnictl> does not display properly.
QuanluZhang
approved these changes
Dec 9, 2020
kvartet
reviewed
Dec 10, 2020
docs/en_US/Compression/Overview.rst
Outdated
|
|
||
| * - Name | ||
| - Brief Introduction of Algorithm | ||
| * - `Level Pruner <https://nni.readthedocs.io/en/latest/Compression/Pruner.html#level-pruner>`__ |
There was a problem hiding this comment.
Absolute path? Not just in this doc
kvartet
approved these changes
Dec 10, 2020
Let's keep it and delete it before release. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this pull request, all the docs will be converted to rst. I will also introduce "githublink". Docs will now be automatically linked to the code/directory that is in the corresponding commit.
Still a few problems to solve:
FIXME.