This repository has been archived by the owner on Sep 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
update doc: NNI core capacities in Overview.md, standalone mode in Trials.md #1821
Merged
QuanluZhang
merged 7 commits into
microsoft:master
from
QuanluZhang:doc-update-overview
Dec 10, 2019
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
817ee97
update overview.md
zhangql08hit 5d3345c
update overview.md
zhangql08hit 9f17133
add doc for standalone mode
zhangql08hit 26b2d0c
update
zhangql08hit 0fe68e0
update
zhangql08hit 4425489
update
zhangql08hit ed5d339
update
zhangql08hit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add this to "Overview>Key Concepts" section too? |
||
|
||
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 dummy values, and some APIs do not really report values. Please refer to the following table for the full list of these APIs. | ||
```python | ||
# NOTE: please assign default values to the hyperparameters in your trial code | ||
nni.get_next_parameter # return {} | ||
nni.report_final_result # have log printed on stdout, but does not report | ||
nni.report_intermediate_result # have log printed on stdout, but does not report | ||
nni.get_experiment_id # return "STANDALONE" | ||
nni.get_trial_id # return "STANDALONE" | ||
nni.get_sequence_id # return 0 | ||
``` | ||
|
||
You can try standalone mode with the [mnist example](https://github.com/microsoft/nni/tree/master/examples/trials/mnist-tfv1). Simply run `python3 mnist.py` under the code directory. The trial code successfully runs with default hyperparameter values. | ||
|
||
For more debuggability, please refer to [How to Debug](../Tutorial/HowToDebug.md) | ||
|
||
## Where are my trials? | ||
|
||
### Local Mode | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.