az ml batch-endpoint

手記

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の ml 拡張機能の一部です。 拡張機能は、az ml batch-endpoint コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

Azure ML バッチ エンドポイントを管理します。

Azure ML エンドポイントは、モデルデプロイを作成および管理するためのシンプルなインターフェイスを提供します。 各エンドポイントには、1 つ以上のデプロイを含めることができます。 バッチ エンドポイントは、オフライン バッチ スコアリングに使用されます。

コマンド

名前	説明	型	状態
az ml batch-endpoint create	エンドポイントを作成します。	延長	ジョージア 州
az ml batch-endpoint delete	エンドポイントを削除します。	延長	ジョージア 州
az ml batch-endpoint invoke	エンドポイントを呼び出します。	延長	ジョージア 州
az ml batch-endpoint list	ワークスペース内のエンドポイントを一覧表示します。	延長	ジョージア 州
az ml batch-endpoint list-jobs	バッチ エンドポイントのバッチ スコアリング ジョブを一覧表示します。	延長	ジョージア 州
az ml batch-endpoint show	エンドポイントの詳細を表示します。	延長	ジョージア 州
az ml batch-endpoint update	エンドポイントを更新します。	延長	ジョージア 州

az ml batch-endpoint create

エンドポイントを作成します。

エンドポイントを作成するには、バッチ エンドポイント構成を含む YAML ファイルを指定します。 エンドポイントが既に存在する場合は、新しい設定で過剰に書き込まれます。

az ml batch-endpoint create --resource-group
                            --workspace-name
                            [--file]
                            [--name]
                            [--no-wait]
                            [--set]

例

YAML 仕様ファイルからエンドポイントを作成する

az ml batch-endpoint create --file endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

名前を持つエンドポイントを作成する

az ml batch-endpoint create --name endpointname --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

省略可能のパラメーター

--file -f

Azure ML バッチ エンドポイント仕様を含む YAML ファイルへのローカル パス。 バッチ エンドポイントの YAML リファレンス ドキュメントは、https://aka.ms/ml-cli-v2-endpoint-batch-yaml-referenceにあります。

--name -n

バッチ エンドポイントの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

規定値: False

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=value。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az ml batch-endpoint delete

エンドポイントを削除します。

az ml batch-endpoint delete --name
                            --resource-group
                            --workspace-name
                            [--no-wait]
                            [--yes]

例

すべてのデプロイを含むバッチ エンドポイントを削除する

az ml batch-endpoint delete --name my-batch-endpoint --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

バッチ エンドポイントの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

省略可能のパラメーター

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

規定値: False

--yes -y

確認を求めないでください。

規定値: False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az ml batch-endpoint invoke

エンドポイントを呼び出します。

一部のデータを使用してエンドポイントを呼び出すことで、バッチ推論の実行を開始できます。 バッチ エンドポイントの場合、呼び出しによって非同期バッチ スコアリング ジョブがトリガーされます。

az ml batch-endpoint invoke --name
                            --resource-group
                            --workspace-name
                            [--deployment-name]
                            [--experiment-name]
                            [--file]
                            [--input]
                            [--input-type]
                            [--inputs]
                            [--instance-count]
                            [--job-name]
                            [--mini-batch-size]
                            [--output-path]
                            [--outputs]
                            [--set]

例

登録済みの Azure ML データ資産からの入力データを使用してバッチ エンドポイントを呼び出し、mini_batch_sizeの既定のデプロイ設定をオーバーライドする

az ml batch-endpoint invoke --name my-batch-endpoint --input azureml:my-dataset:1 --mini-batch-size 64 --resource-group my-resource-group --workspace-name my-workspace

パブリック URI から入力ファイルを使用してバッチ エンドポイントを呼び出す

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_file --input https://pipelinedata.blob.core.windows.net/sampledata/mnist/0.png --resource-group my-resource-group --workspace-name my-workspace

登録済みのデータストアから入力ファイルを使用してバッチ エンドポイントを呼び出す

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_file --input azureml://datastores/workspaceblobstore/paths/{path_to_data}/mnist/0.png --resource-group my-resource-group --workspace-name my-workspace

パブリック URI から入力フォルダーを使用してバッチ エンドポイントを呼び出す

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_folder --input https://pipelinedata.blob.core.windows.net/sampledata/mnist --resource-group my-resource-group --workspace-name my-workspace

登録済みのデータストアから入力フォルダーを使用してバッチ エンドポイントを呼び出す

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_folder --input azureml://datastores/workspaceblobstore/paths/{path_to_data}/mnist --resource-group my-resource-group --workspace-name my-workspace

ローカル フォルダー内のファイルを使用してバッチ エンドポイントを呼び出す

az ml batch-endpoint invoke --name my-batch-endpoint --input ./mnist_folder --resource-group my-resource-group --workspace-name my-workspace

入力パスと出力パスとしてローカル フォルダーを使用してバッチ エンドポイントを呼び出し、エンドポイント呼び出し中にいくつかのバッチデプロイ設定を上書きする

az ml batch-endpoint invoke --name my-batch-endpoint --input ./mnist_folder --instance-count 2 --mini-batch-size 5 --output-path azureml://datastores/workspaceblobstore/paths/tests/output --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

バッチ エンドポイントの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

省略可能のパラメーター

--deployment-name -d

ターゲットとするデプロイの名前。

--experiment-name

パイプライン コンポーネントデプロイの実験の名前。

--file -f

バッチ呼び出しに使用されるファイルの名前。

--input

バッチ推論に使用する入力データへの参照。 データストア上のパス、パブリック URI、登録済みデータ資産、またはローカル フォルダー パスを指定できます。

--input-type

入力の種類。ファイルかフォルダーかを指定します。 データストアまたはパブリック URI のパスを使用する場合に使用します。 サポートされている値: uri_folder、uri_file。

--inputs

呼び出しジョブの入力のディクショナリ。

--instance-count -c

予測が実行されるインスタンスの数。

--job-name

バッチ呼び出しのジョブの名前。

--mini-batch-size -m

予測のために入力データが分割される各ミニ バッチのサイズ。

--output-path

出力ファイルのアップロード先となるデータストアのパス。

--outputs

結果を格納する場所を指定するディクショナリ。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=value。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az ml batch-endpoint list

ワークスペース内のエンドポイントを一覧表示します。

az ml batch-endpoint list --resource-group
                          --workspace-name

例

ワークスペース内のすべてのバッチ エンドポイントを一覧表示する

az ml batch-endpoint list --resource-group my-resource-group --workspace-name my-workspace

ワークスペース内のすべてのバッチ エンドポイントを一覧表示する

az ml batch-endpoint list  --resource-group my-resource-group --workspace-name my-workspace

--query 引数を使用してワークスペース内のすべてのバッチ エンドポイントを一覧表示し、コマンドの結果に対して JMESPath クエリを実行します。

az ml batch-endpoint list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az ml batch-endpoint list-jobs

バッチ エンドポイントのバッチ スコアリング ジョブを一覧表示します。

az ml batch-endpoint list-jobs --name
                               --resource-group
                               --workspace-name

例

エンドポイントのすべてのバッチ スコアリング ジョブを一覧表示する

az ml batch-endpoint list-jobs --name my-batch-endpoint --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

バッチ エンドポイントの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az ml batch-endpoint show

エンドポイントの詳細を表示します。

az ml batch-endpoint show --name
                          --resource-group
                          --workspace-name

例

バッチ エンドポイントの詳細を表示する

az ml batch-endpoint show --name my-batch-endpoint  --resource-group my-resource-group --workspace-name my-workspace

--query 引数を使用して、コマンドの結果に対して JMESPath クエリを実行するエンドポイントのプロビジョニング状態を表示します。

az ml batch-endpoint show -n my-endpoint --query "{Name:name,State:provisioning_state}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

バッチ エンドポイントの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az ml batch-endpoint update

エンドポイントを更新します。

エンドポイントの 'description'、'tags'、および 'defaults' プロパティを更新できます。 さらに、新しいデプロイをエンドポイントに追加したり、既存のデプロイを更新したりできます。

az ml batch-endpoint update --resource-group
                            --workspace-name
                            [--add]
                            [--defaults]
                            [--file]
                            [--force-string]
                            [--name]
                            [--no-wait]
                            [--remove]
                            [--set]

例

YAML 仕様ファイルからエンドポイントを更新する

az ml batch-endpoint update --name my-batch-endpoint --file updated_endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

既存のエンドポイントに新しいデプロイを追加する

az ml batch-endpoint update --name my-batch-endpoint  --set defaults.deployment_name=depname  --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<name>を使用して既定のワークスペースを構成できます。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>.

規定値: []

--defaults

エンドポイント呼び出しの既定の設定内のdeployment_nameを更新します。

--file -f

Azure ML バッチ エンドポイント仕様を含む YAML ファイルへのローカル パス。 バッチ エンドポイントの YAML リファレンス ドキュメントは、https://aka.ms/ml-cli-v2-endpoint-batch-yaml-referenceにあります。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False

--name -n

バッチ エンドポイントの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

規定値: False

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

規定値: []

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>.

規定値: []

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。