This repository has been archived by the owner on Sep 18, 2024. It is now read-only.
update doc: NNI core capacities in Overview.md, standalone mode in Trials.md #1821
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
QuanluZhang
requested review from
xuehui1991,
squirrelsc,
scarlett2018 and
yangmao99
QuanluZhang
changed the title
squirrelsc
reviewed
Dec 5, 2019
squirrelsc
reviewed
Dec 5, 2019
squirrelsc
reviewed
Dec 5, 2019
squirrelsc
reviewed
Dec 5, 2019
xuehui1991
reviewed
Dec 5, 2019
scarlett2018
suggested changes
Dec 6, 2019
| @@ -127,6 +127,23 @@ In the YAML configure file, you need to set *useAnnotation* to true to enable NN | |||
| useAnnotation: true | |||
| ``` | |||
|
|
|||
| ## Standalone mode for debug | |||
There was a problem hiding this comment.
Add this to "Overview>Key Concepts" section too?
docs/en_US/TrialExample/Trials.md
Outdated
| @@ -127,6 +127,23 @@ In the YAML configure file, you need to set *useAnnotation* to true to enable NN | |||
| useAnnotation: true | |||
| ``` | |||
|
|
|||
| ## Standalone mode for debug | |||
|
|
|||
| NNI supports standalone mode for trial code to run without starting an NNI experiment. This is for finding out bugs in trial code more conveniently. NNI annotation natively supports standalone mode, as the added NNI related lines are comments. For NNI trial APIs, the APIs have changed behaviors in standalone mode, some APIs return fake/empty values, and some APIs do not really report values. Details are shown below. | |||
There was a problem hiding this comment.
"standalone mode" sounds confusing... may we call it "single trial debug mode" or something more clear connect to "trial".
docs/en_US/TrialExample/Trials.md
Outdated
| @@ -127,6 +127,23 @@ In the YAML configure file, you need to set *useAnnotation* to true to enable NN | |||
| useAnnotation: true | |||
| ``` | |||
|
|
|||
| ## Standalone mode for debug | |||
|
|
|||
| NNI supports standalone mode for trial code to run without starting an NNI experiment. This is for finding out bugs in trial code more conveniently. NNI annotation natively supports standalone mode, as the added NNI related lines are comments. For NNI trial APIs, the APIs have changed behaviors in standalone mode, some APIs return fake/empty values, and some APIs do not really report values. Details are shown below. | |||
There was a problem hiding this comment.
For NNI trial APIs, the APIs have changed behaviors in standalone mode, some APIs return fake/empty values, and some APIs do not really report values. Details are shown below.
In trial debug model, experiment related fields are filled with dummy values, please refer to the following table for the full lists of these fields.
| @@ -46,6 +46,33 @@ For each experiment, user only needs to define a search space and update a few l | |||
|
|
|||
| More details about how to run an experiment, please refer to [Get Started](Tutorial/QuickStart.md). | |||
|
|
|||
| ## Core Features | |||
There was a problem hiding this comment.
I'm thinking to replace this or put this ahead of the current "easy-to-use", "scalability", etc. section. let's discuss more in our scrum today.
squirrelsc
approved these changes
Dec 6, 2019
44 tasks
scarlett2018
approved these changes
Dec 10, 2019
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.
describe core capacities of NNI, including hyperparameter tuning, neural architecture search, model compression, and feature engineering.
describe standalone mode, in which trial code can run without NNI experiment for easy debug.