你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CLI (v2) 管道组件 YAML 架构
源 JSON 架构可在 https://azuremlschemas.azureedge.net/latest/pipelineComponent.schema.json 中找到。
注意
本文档中详细介绍的 YAML 语法基于最新版本的 ML CLI v2 扩展的 JSON 架构。 此语法必定仅适用于最新版本的 ML CLI v2 扩展。 可以在 https://azuremlschemasprod.azureedge.net/ 上查找早期扩展版本的架构。
YAML 语法
| 密钥 | 类型 | 说明 | 允许的值 | 默认值 |
|---|---|---|---|---|
$schema |
字符串 | YAML 架构。 如果使用 Azure 机器学习 VS Code 扩展来创作 YAML 文件，则可通过在文件顶部包含 $schema 来调用架构和资源完成操作。 |
||
type |
const | 组件的类型。 | pipeline |
pipeline |
name |
字符串 | 必需。 组件的名称。 必须以小写字母开头。 允许的字符是小写字母、数字和下划线 (_)。 最大长度为 255 个字符。 | ||
version |
字符串 | 组件的版本。 如果省略，Azure 机器学习将自动生成一个版本。 | ||
display_name |
字符串 | 组件在工作室 UI 中的显示名称。 它在工作区中可以不唯一。 | ||
description |
字符串 | 组件的说明。 | ||
tags |
object | 组件的标记字典。 | ||
jobs |
object | 必需。 在管道中作为步骤运行的一组单个作业的字典。 这些作业被视为父管道作业的子作业。 键是步骤在管道作业的上下文中的名称。 此名称不同于子作业的唯一作业名称。 该值是作业规范，可以跟在 job schema 命令或 sweep job schema 命令之后。 目前，只能在管道中运行命令作业和扫描作业。 |
||
inputs |
object | 管道作业的输入字典。 键是作业上下文中的输入名称，值是输入值。 这些管道输入可以被管道中单个步骤作业的输入所引用（使用 ${{ parent.inputs.<input_name> }} 表达式）。 有关如何将管道步骤的输入绑定到顶级管道作业的输入的详细信息，请参阅用于在管道作业的步骤之间绑定输入和输出的表达式语法。 |
||
inputs.<input_name> |
数字、整数、布尔值、字符串或对象 | 文字值（数字、整数、布尔值或字符串类型）或包含组件输入数据规范的对象之一。 | ||
outputs |
object | 管道作业的输出配置字典。 键是作业上下文中的输出名称，值是输出配置。 这些管道输出可以被管道中单个步骤作业的输出所引用（使用 ${{ parents.outputs.<output_name> }} 表达式）。 有关如何将管道步骤的输入绑定到顶级管道作业的输入的详细信息，请参阅用于在管道作业的步骤之间绑定输入和输出的表达式语法。 |
||
outputs.<output_name> |
object | 可以将对象留空，在这种情况下，默认情况下，输出将是 uri_folder 类型，Azure 机器学习将根据以下模板路径为输出系统生成输出位置：{settings.datastore}/azureml/{job-name}/{output-name}/。 将通过读写挂载将文件写入输出目录。 如果要为输出指定不同的模式，请提供一个包含组件输出规范的对象。 |
组件输入
| 密钥 | 类型 | 说明 | 允许的值 | 默认值 |
|---|---|---|---|---|
type |
字符串 | 必需。 组件输入的类型。 详细了解数据访问 | ||
description |
字符串 | 输入的说明。 | ||
default |
数字、整数、布尔值或字符串 | 输入的默认值。 | ||
optional |
boolean | 输入是否为必需。 如果设置为 true，则需要使用包含带 $[[]] 可选输入的命令 |
false |
|
min |
整数或数字 | 接受的最小输入值。 仅当 type 字段为 number 或 integer 时，才能指定此字段。 |
||
max |
整数或数字 | 接受的最大输入值。 仅当 type 字段为 number 或 integer 时，才能指定此字段。 |
||
enum |
array | 允许的输入值列表。 仅当 type 字段为 string 时才适用。 |
组件输出
| 密钥 | 类型 | 说明 | 允许的值 | 默认值 |
|---|---|---|---|---|
type |
字符串 | 必需。 组件输出的类型。 | ||
description |
字符串 | 输出的说明。 |
备注
az ml component 命令可用于管理 Azure 机器学习组件。
示例
示例 GitHub 存储库中提供了示例。