Skip to content

Commit f19f340

Browse files
authored
Merge pull request #207202 from cloga/lochen/component-refresh
add more example, update naming convention
2 parents 1525ad5 + 58b77bd commit f19f340

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

articles/machine-learning/reference-yaml-component-command.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.topic: reference
99
ms.custom: cliv2, event-tier1-build-2022
1010
author: s-polly
1111
ms.author: scottpolly
12-
ms.date: 03/31/2022
12+
ms.date: 08/08/2022
1313
ms.reviewer: larryfr
1414
---
1515

@@ -29,7 +29,7 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
2929
| --- | ---- | ----------- | -------------- | ------------- |
3030
| `$schema` | string | The YAML schema. If you use the Azure Machine Learning VS Code extension to author the YAML file, including `$schema` at the top of your file enables you to invoke schema and resource completions. | | |
3131
| `type` | const | The type of component. | `command` | `command` |
32-
| `name` | string | **Required.** Name of the component. | | |
32+
| `name` | string | **Required.** Name of the component. Must start with lowercase letter. Allowed characters are lowercase letters, numbers, and underscore(_). Maximum length is 255 characters.| | |
3333
| `version` | string | Version of the component. If omitted, Azure ML will autogenerate a version. | | |
3434
| `display_name` | string | Display name of the component in the studio UI. Can be non-unique within the workspace. | | |
3535
| `description` | string | Description of the component. | | |
@@ -72,19 +72,19 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
7272

7373
| Key | Type | Description | Allowed values | Default value |
7474
| --- | ---- | ----------- | -------------- | ------------- |
75-
| `type` | string | **Required.** The type of component input. <br><br> Use `type: uri_file/uri_folder` if you want the runtime job input value to be a data URI or registered Azure ML data asset when the component is run. | `number`, `integer`, `boolean`, `string`, `uri_file`, `uri_folder` | |
75+
| `type` | string | **Required.** The type of component input. [Learn more about data access](concept-data.md) | `number`, `integer`, `boolean`, `string`, `uri_file`, `uri_folder`, `mltable`, `mlflow_model`| |
7676
| `description` | string | Description of the input. | | |
7777
| `default` | number, integer, boolean, or string | The default value for the input. | | |
7878
| `optional` | boolean | Whether the input is required. | | `false` |
7979
| `min` | integer or number | The minimum accepted value for the input. This field can only be specified if `type` field is `number` or `integer`. | |
8080
| `max` | integer or number | The maximum accepted value for the input. This field can only be specified if `type` field is `number` or `integer`. | |
81-
| `enum` | array | The list of allowed values for the input. Not applicable if `type` field is `boolean`. | |
81+
| `enum` | array | The list of allowed values for the input. Only applicable if `type` field is `string`.| |
8282

8383
### Component output
8484

8585
| Key | Type | Description | Allowed values | Default value |
8686
| --- | ---- | ----------- | -------------- | ------------- |
87-
| `type` | string | **Required.** The type of component output. | `uri_folder` | |
87+
| `type` | string | **Required.** The type of component output. | `uri_file`, `uri_folder`, `mltable`, `mlflow_model` | |
8888
| `description` | string | Description of the output. | | |
8989

9090
## Remarks
@@ -97,10 +97,15 @@ Command component examples are available in the examples GitHub repository. Sele
9797

9898
Examples are available in the [examples GitHub repository](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components). Several are shown below.
9999

100-
## Hello world command component
100+
## YAML: Hello world command component
101101

102102
:::code language="yaml" source="~/azureml-examples-main/cli/jobs/pipelines-with-components/basics/2a_basic_component/component.yml":::
103103

104+
## YAML: Component with different input types
105+
106+
:::code language="yaml" source="~/azureml-examples-main/cli/assets/component/train.yml":::
107+
104108
## Next steps
105109

106110
- [Install and use the CLI (v2)](how-to-configure-cli.md)
111+
- [Create ML pipelines using components (CLI v2)](how-to-create-component-pipelines-cli.md)

0 commit comments

Comments
 (0)