You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/machine-learning/reference-yaml-component-command.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
37
37
|`is_deterministic`| boolean |This option determines if the component will produce the same output for the same input data. You should usually set this to `false` for components that load data from external sources, such as importing data from a URL. This is because the data at the URL might change over time. ||`true`|
38
38
|`command`| string |**Required.** The command to execute. |||
39
39
|`code`| string | Local path to the source code directory to be uploaded and used for the component. |||
40
-
|`environment`| string or object |**Required.** The environment to use for the component. This value can be either a reference to an existing versioned environment in the workspace or an inline environment specification. <br><br> To reference an existing environment, use the `azureml:<environment-name>:<environment-version>` syntax. <br><br> To define an environment inline, follow the [Environment schema](reference-yaml-environment.md#yaml-syntax). Exclude the `name` and `version` properties as they are not supported for inline environments. |||
40
+
|`environment`| string or object |**Required.** The environment to use for the component. This value can be either a reference to an existing versioned environment in the workspace or an inline environment specification. <br><br> To reference an existing environment, use the `azureml:<environment-name>:<environment-version>` syntax. <br><br> To define an environment inline, follow the [Environment schema](reference-yaml-environment.md#yaml-syntax). Exclude the `name` and `version` properties as they aren't supported for inline environments. |||
41
41
|`distribution`| object | The distribution configuration for distributed training scenarios. One of [MpiConfiguration](#mpiconfiguration), [PyTorchConfiguration](#pytorchconfiguration), or [TensorFlowConfiguration](#tensorflowconfiguration). |||
42
42
|`resources.instance_count`| integer | The number of nodes to use for the job. ||`1`|
43
43
|`inputs`| object | Dictionary of component inputs. The key is a name for the input within the context of the component and the value is the component input definition. <br><br> Inputs can be referenced in the `command` using the `${{ inputs.<input_name> }}` expression. |||
@@ -108,7 +108,7 @@ Examples are available in the [examples GitHub repository](https://github.com/Az
108
108
109
109
### Define optional inputs in command line
110
110
When the input is set as `optional = true`, you need use `$[[]]` to embrace the command line with inputs. For example `$[[--input1 ${{inputs.input1}}]`. The command line at runtime may have different inputs.
111
-
- If you are using only specify the required `training_data` and `model_output` parameters, the command line will look like:
111
+
- If you're using only specify the required `training_data` and `model_output` parameters, the command line will look like:
@@ -127,9 +127,9 @@ Following are some common errors and corresponding recommended suggestions when
127
127
128
128
| Key | Errors | Recommendation |
129
129
| --- | ---- | ----------- |
130
-
|command|1. Only optional inputs can be in `$[[]]`<br>2. Using `\` to make a new line is not supported in command.<br>3. Inputs or outputs are not found.|1. Check that all the inputs or outputs used in command are already defined in the `inputs` and `outputs` sections, and use the correct format for optional inputs `$[[]]` or required ones `${{}}`.<br>2. Do not use `\` to make a new line.|
131
-
|environment|1. No definition exists for environment `{envName}` version `{envVersion}`. <br>2. No environment exists for name `{envName}`, version `{envVersion}`.<br>3. Could not find asset with ID `{envAssetId}`. |1. Make sure the environment name and version you refer in the component definition exists. <br>2. You need to specify the version if you refer to a registered environment.|
132
-
|inputs/outputs|1. Inputs/outputs names conflict with system reserved parameters.<br>2. Deplicated names of inputs or outputs.|1. Do not use any of these reserved parameters as your inputs/outputs name: `path`, `ld_library_path`, `user`, `logname`, `home`, `pwd`, `shell`.<br>2. Make sure names of inputs and outputs are not duplicated.|
130
+
|command|1. Only optional inputs can be in `$[[]]`<br>2. Using `\` to make a new line isn't supported in command.<br>3. Inputs or outputs aren't found.|1. Check that all the inputs or outputs used in command are already defined in the `inputs` and `outputs` sections, and use the correct format for optional inputs `$[[]]` or required ones `${{}}`.<br>2. Don't use `\` to make a new line.|
131
+
|environment|1. No definition exists for environment `{envName}` version `{envVersion}`. <br>2. No environment exists for name `{envName}`, version `{envVersion}`.<br>3. Couldn't find asset with ID `{envAssetId}`. |1. Make sure the environment name and version you refer in the component definition exists. <br>2. You need to specify the version if you refer to a registered environment.|
132
+
|inputs/outputs|1. Inputs/outputs names conflict with system reserved parameters.<br>2. Duplicated names of inputs or outputs.|1. Don't use any of these reserved parameters as your inputs/outputs name: `path`, `ld_library_path`, `user`, `logname`, `home`, `pwd`, `shell`.<br>2. Make sure names of inputs and outputs aren't duplicated.|
0 commit comments