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

Update Trial's doc and move HowToDebug to Tutorial #887

Merged
merged 6 commits into from
Apr 1, 2019
Merged
Show file tree
Hide file tree
Changes from 4 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
3 changes: 1 addition & 2 deletions docs/en_US/Contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Contribute to NNI

.. toctree::
Development Setup<SetupNNIDeveloperEnvironment>
Contribution Guide<CONTRIBUTING>
Debug HowTo<HowToDebug>
Contribution Guide<CONTRIBUTING>
22 changes: 22 additions & 0 deletions docs/en_US/Trials.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,28 @@ In the YAML configure file, you need to set *useAnnotation* to true to enable NN
useAnnotation: true
```


## Where are my trials?

In NNI, every trial has a dedicated directory for them to output their own data. In each trial, an environment variable called `NNI_OUTPUT_DIR` is exported. Under this directory, you could find each trials code, data and other possible log. In addition, each trial's log will be re-directed to a file name `trial.log` under that directory.

Besides, trial's converted code is in another temporary directory if NNI Annotation is used. You can check that in a file named `run.sh` under the directory indicated by `NNI_OUTPUT_DIR`. The second line of this file will change directory to the actual directory where code is located. Below is an example of `run.sh`:
```shell
#!/bin/bash
cd /tmp/user_name/nni/annotation/tmpzj0h72x6 #This is the actual directory
export NNI_PLATFORM=local
export NNI_SYS_DIR=/home/user_name/nni/experiments/K1unkStq/trials/nrbb2
export NNI_TRIAL_JOB_ID=nrbb2
export NNI_OUTPUT_DIR=/home/user_name/nni/experiments/K1unkStq/trials/nrbb2
export NNI_TRIAL_SEQ_ID=1
export MULTI_PHASE=false
export CUDA_VISIBLE_DEVICES=
eval python3 mnist.py 2>/home/user_name/nni/experiments/K1unkStq/trials/nrbb2/stderr
echo $? `date +%s000` >/home/user_name/nni/experiments/K1unkStq/trials/nrbb2/.nni/state
```

For more information, please refer to [HowToDebug](HowToDebug.md)

<a name="more-examples"></a>
## More Trial Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/en_US/Tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ Tutorials
WebUI
Training Platform<training_services>
How to use docker<HowToUseDocker>
advanced
advanced
Debug HowTo<HowToDebug>