適用対象:
Azure CLI ml 拡張機能 v2 (現行)
ソース 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 Machine Learning 用 VS Code 拡張機能を使用して YAML ファイルを作成する場合は、ファイルの先頭に $schema を含めることで、スキーマとリソースの入力候補を呼び出すことができます。 |
||
type |
定数 | コンポーネントの種類。 | pipeline |
pipeline |
name |
ひも | 必須。 コンポーネント名。 先頭には小文字を使用する必要があります。 使用できる文字は、小文字、数字、アンダースコア (_) です。 最大文字数は 255 文字です。 | ||
version |
ひも | コンポーネントのバージョン。 省略した場合、Azure Machine Learning によってバージョンが自動生成されます。 | ||
display_name |
ひも | Studio UI でのコンポーネントの表示名。 ワークスペース内で一意ではない場合があります。 | ||
description |
ひも | コンポーネントの説明。 | ||
tags |
オブジェクト | コンポーネントのタグの辞書。 | ||
jobs |
オブジェクト | 必須。 パイプライン内のステップとして実行する個々のジョブのセットの辞書。 これらのジョブは、親パイプライン ジョブの子ジョブと見なされます。 キーは、パイプライン ジョブのコンテキスト内のステップの名前です。 この名前は、子ジョブの一意のジョブ名とは異なります。 値は、コマンド ジョブ スキーマまたはスイープ ジョブ スキーマに従うジョブ仕様です。 現在、パイプラインで実行できるのは、コマンド ジョブとスイープ ジョブのみです。 |
||
inputs |
オブジェクト | パイプライン ジョブへの入力の辞書。 キーは、ジョブのコンテキスト内の入力の名前であり、値は入力値です。 これらのパイプライン入力は、 ${{ parent.inputs.<input_name> }} 式を使用して、パイプライン内の個々のステップ ジョブの入力によって参照できます。 パイプライン ステップの入力を最上位のパイプライン ジョブの入力にバインドする方法の詳細については、パイプライン ジョブのステップ間で入力と出力をバインドするための式構文を参照してください。 |
||
inputs.<input_name> |
数値、整数、ブール値、文字列、またはオブジェクト | リテラル値 (型番号、整数、ブール値、または文字列) のいずれか、またはコンポーネント入力データ仕様を含むオブジェクト。 | ||
outputs |
オブジェクト | パイプライン ジョブの出力構成の辞書。 キーはジョブのコンテキスト内の出力の名前であり、値は出力構成です。 これらのパイプライン出力は、 ${{ parents.outputs.<output_name> }} 式を使用して、パイプライン内の個々のステップ ジョブの出力によって参照できます。 パイプライン ステップの入力を最上位のパイプライン ジョブの入力にバインドする方法の詳細については、パイプライン ジョブのステップ間で入力と出力をバインドするための式構文を参照してください。 |
||
outputs.<output_name> |
オブジェクト | オブジェクトは空のままにしておくことができます。この場合、既定では出力の種類は uri_folder になり、Azure Machine Learning は次のテンプレート パスに基づいて出力の出力場所をシステム生成します: {settings.datastore}/azureml/{job-name}/{output-name}/。 出力ディレクトリへのファイルは、読み取り/書き込みマウントを使用して書き込まれます。 出力に別のモードを指定する場合は、コンポーネント出力仕様を含むオブジェクトを指定します。 |
コンポーネント入力
| キー | タイプ | 説明 | 使用できる値 | 既定値 |
|---|---|---|---|---|
type |
ひも | 必須。 コンポーネント入力の種類。 データ アクセスの詳細について確認してください |
number, integer, boolean, string, uri_file, uri_folder, mltable, mlflow_model, custom_model |
|
description |
ひも | 入力の説明。 | ||
default |
number、integer、boolean、または string | 入力の既定値。 | ||
optional |
ブーリアン | 入力が必須かどうか。
true に設定されている場合は、$[[]] を使用して、オプションの入力を含むコマンドを使用する必要があります。 |
false |
|
min |
integer または number | 入力に許容される最小値。 このフィールドは、type フィールドが number または integer の場合にのみ指定できます。 |
||
max |
integer または number | 入力に許容される最大値。 このフィールドは、type フィールドが number または integer の場合にのみ指定できます。 |
||
enum |
配列 | 入力に使用できる値のリスト。
type フィールドが string の場合のみ適用されます。 |
コンポーネント出力
| キー | タイプ | 説明 | 使用できる値 | 既定値 |
|---|---|---|---|---|
type |
ひも | 必須。 コンポーネント出力の種類。 |
uri_file, uri_folder, mltable, mlflow_model, custom_model |
|
description |
ひも | 出力の説明。 |
注釈
az ml component コマンドを使用して、Azure Machine Learning コンポーネントを管理できます。
例
例は、GitHub リポジトリの例にあります。