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

Typo on #12 #281

Merged
merged 1 commit into from
Oct 31, 2018
Merged

Typo on #12 #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/StartExperiment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
How to start an experiment
===
## 1.Introduce
There are few steps to start an new experiment of nni, here are the process.
There are few steps to start an new experiment of nni, here are the process.
<img src="./img/experiment_process.jpg" width="50%" height="50%" />
## 2.Details
### 2.1 Check environment
The first step to start an experiment is to check whether the environment is ready, nnictl will check if there is an old experiment running or the port of restfurl server is occupied.
NNICTL will also validate the content of config yaml file, to ensure the experiment config is in correct format.

### 2.2 Start restful server
After check environment, nnictl will start an restful server process to manage nni experiment, the devault port is 51188.
After check environment, nnictl will start an restful server process to manage nni experiment, the default port is `51188`.

### 2.3 Check restful server
Before next steps, nnictl will check whether restful server is successfully started, or the starting process will stop and show error message.
Expand All @@ -21,7 +21,7 @@ NNICTL need to set experiment config before start an experiment, experiment conf
NNICTL will ensure the request to set config is successfully executed.

### 2.6 Start WebUI
NNICTL will start a WebUI to show information,the default port of WebUI is 51188.
NNICTL will start a WebUI to show information,the default port of WebUI is `51188`.

### 2.7 Check WebUI
If WebUI is not successfully started, nnictl will give a warning information, and will continue to start experiment.
Expand All @@ -30,4 +30,4 @@ If WebUI is not successfully started, nnictl will give a warning information, an
This is the most import step of starting an nni experiment, nnictl will call restful server process to setup an experiment.

### 2.9 Check experiment
After start experiment, nnictl will check whether the experiment is correctly created, and show more information of this experiment to users.
After start experiment, nnictl will check whether the experiment is correctly created, and show more information of this experiment to users.