Skip to content

Commit ea7e640

Browse files
authored
new UI updates
1 parent 10c59dc commit ea7e640

File tree

1 file changed

+51
-47
lines changed

1 file changed

+51
-47
lines changed

articles/machine-learning/how-to-train-with-ui.md

Lines changed: 51 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,62 @@ There are many ways to create a training job with Azure Machine Learning. You ca
3636
* You may enter the job creation UI from the homepage. Click **Create new** and select **Job**.
3737
[![Azure Machine Learning studio homepage](media/how-to-train-with-ui/home-entry.png)](media/how-to-train-with-ui/home-entry.png)
3838

39-
* Or, you may enter the job creation from the left pane. Click **+New** and select **Job**.
40-
[![Azure Machine Learning studio left navigation](media/how-to-train-with-ui/left-nav-entry.png)](media/how-to-train-with-ui/left-nav-entry.png)
39+
In this wizard, you can select your method of training, complete the rest of the submission wizard based on your selection, and submit the training job. Below we will walkthrough the wizard for running a custom script (command job).
4140

41+
## Configure basic settings
4242

43-
These options will all take you to the job creation panel, which has a wizard for configuring and creating a training job.
43+
The first step is configuring basic information about your training job. You can proceed next if you're satisfied with the defaults we have chosen for you or make changes to your desired preference.
44+
45+
These are the fields available:
46+
47+
|Field| Description|
48+
|------| ------|
49+
|Job name| The job name field is used to uniquely identify your job. It's also used as the display name for your job. Setting this field is optional; Azure will generates a display name for you if one is not specified.|
50+
|Experiment name| This helps organize the job in Azure Machine Learning studio. Each job's run record will be organized under the corresponding experiment in the studio's "Experiment" tab. By default, Azure will put the job in the **Default** experiment.|
51+
|Description| Add some text describing your job, if desired. This is optional |
52+
|Timeout| Specify number of hours the entire training job is allowed to run. Once this limit is reached the system will cancel the job including any child jobs.|
53+
|Tags| Add tags to your job to help with organization.|
54+
55+
## Training script
56+
57+
Next step is to upload your source code, configure any inputs or outputs required to execute the training job, and specify the command to execute your training script.
58+
59+
This can be a code file or a folder from your local machine or workspace's default blob storage. Azure will show the files to be uploaded after you make the selection.
60+
61+
|Field| Description|
62+
|------| ------|
63+
|Code| This can be a file or a folder from your local machine or workspace's default blob storage as your training script. Studio will show the files to be uploaded after you make the selection.|
64+
|Inputs| Specify as many inputs as needed of the following types data, integer, number, boolean, string). |
65+
|Command| The command to execute. Command-line arguments can be explicitly written into the command or inferred from other sections, specifically **inputs** using curly braces notation, as discussed in the next section.|
66+
67+
68+
### Code
69+
The command is run from the root directory of the uploaded code folder. After you select your code file or folder, you can see the files to be uploaded. Copy the relative path to the code containing your entry point and paste it into the box labeled **Enter the command to start the job**.
70+
71+
If the code is in the root directory, you can directly refer to it in the command. For instance, `python main.py`.
72+
73+
If the code isn't in the root directory, you should use the relative path. For example, the structure of the [word language model](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/single-step/pytorch/word-language-model) is:
74+
75+
```tree
76+
.
77+
├── job.yml
78+
├── data
79+
└── src
80+
└── main.py
81+
```
82+
Here, the source code is in the `src` subdirectory. The command would be `python ./src/main.py` (plus other command-line arguments).
83+
84+
[![Refer code in the command](media/how-to-train-with-ui/code-command.png)](media/how-to-train-with-ui/code-command.png)
85+
86+
### Inputs
87+
88+
When you use an input in the command, you need to specify the input name. To indicate an input variable, use the form `${{inputs.input_name}}`. For instance, `${{inputs.wiki}}`. You can then refer to it in the command, for instance, `--data ${{inputs.wiki}}`.
89+
90+
[![Refer input name in the command](media/how-to-train-with-ui/input-command-name.png)](media/how-to-train-with-ui/input-command-name.png)
4491

4592
## Select compute resources
4693

47-
The first step in the job creation UI is to select the compute target on which you'd like your job to run. The job creation UI supports several compute types:
94+
Next step is to select the compute target on which you'd like your job to run. The job creation UI supports several compute types:
4895

4996
| Compute Type | Introduction |
5097
| --- | --- |
@@ -93,54 +140,11 @@ Custom environments are environments you've specified yourself. You can specify
93140
If you don't want to use the Azure Machine Learning curated environments or specify your own custom environment, you can use a docker image from a public container registry such as [Docker Hub](https://hub.docker.com/). If the image is in a private container, toggle **This is a private container registry**. For private registries, you will need to enter a valid username and password so Azure can get the image.
94141
[![Container registry image](media/how-to-train-with-ui/container-registry-image.png)](media/how-to-train-with-ui/container-registry-image.png)
95142

96-
## Configure your job
97-
98-
After specifying the environment, you can configure your job with more settings.
99-
100-
|Field| Description|
101-
|------| ------|
102-
|Job name| The job name field is used to uniquely identify your job. It's also used as the display name for your job. Setting this field is optional; Azure will generate a GUID name for the job if you don't enter anything. Note: the job name must be unique.|
103-
|Experiment name| This helps organize the job in Azure Machine Learning studio. Each job's run record will be organized under the corresponding experiment in the studio's "Experiment" tab. By default, Azure will put the job in the **Default** experiment.|
104-
|Code| You can upload a code file or a folder from your machine, or upload a code file from the workspace's default blob storage. Azure will show the files to be uploaded after you make the selection. |
105-
|Command| The command to execute. Command-line arguments can be explicitly written into the command or inferred from other sections, specifically **inputs** using curly braces notation, as discussed in the next section.|
106-
|Inputs| Specify the input binding. We support three types of inputs: 1) Azure Machine Learning registered dataset; 2) workspace default blob storage; 3) upload local file. You can add multiple inputs. |
107-
|Environment variables| Setting environment variables allows you to provide dynamic configuration of the job. You can add the variable and value here.|
108-
|Tags| Add tags to your job to help with organization.|
109-
110-
### Specify code and inputs in the command box
111-
112-
#### Code
113-
114-
The command is run from the root directory of the uploaded code folder. After you select your code file or folder, you can see the files to be uploaded. Copy the relative path to the code containing your entry point and paste it into the box labeled **Enter the command to start the job**.
115-
116-
If the code is in the root directory, you can directly refer to it in the command. For instance, `python main.py`.
117-
118-
If the code isn't in the root directory, you should use the relative path. For example, the structure of the [word language model](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/single-step/pytorch/word-language-model) is:
119-
120-
```tree
121-
.
122-
├── job.yml
123-
├── data
124-
└── src
125-
└── main.py
126-
```
127-
Here, the source code is in the `src` subdirectory. The command would be `python ./src/main.py` (plus other command-line arguments).
128-
129-
[![Refer code in the command](media/how-to-train-with-ui/code-command.png)](media/how-to-train-with-ui/code-command.png)
130-
131-
#### Inputs
132-
133-
When you use an input in the command, you need to specify the input name. To indicate an input variable, use the form `${{inputs.input_name}}`. For instance, `${{inputs.wiki}}`. You can then refer to it in the command, for instance, `--data ${{inputs.wiki}}`.
134-
135-
[![Refer input name in the command](media/how-to-train-with-ui/input-command-name.png)](media/how-to-train-with-ui/input-command-name.png)
136143

137144
## Review and Create
138145

139146
Once you've configured your job, choose **Next** to go to the **Review** page. To modify a setting, choose the pencil icon and make the change.
140147

141-
You may choose **view the YAML spec** to review and download the yaml file generated by this job configuration. This job yaml file can be used to submit the job from the CLI (v2). (See [Train models (create jobs) with the CLI (v2)](how-to-train-cli.md).)
142-
[![view yaml spec](media/how-to-train-with-ui/view-yaml.png)](media/how-to-train-with-ui/view-yaml.png)
143-
[![Yaml spec](media/how-to-train-with-ui/yaml-spec.png)](media/how-to-train-with-ui/yaml-spec.png)
144148

145149
To launch the job, choose **Create**. Once the job is created, Azure will show you the job details page, where you can monitor and manage your training job.
146150

0 commit comments

Comments
 (0)