az ml model

Note

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

Azure ML モデルを管理します。

Azure ML モデルは、機械学習モデルと対応するメタデータを表すバイナリ ファイルで構成されます。 これらのモデルは、リアルタイムおよびバッチ推論のためにエンドポイントデプロイで使用できます。

コマンド

名前	説明	型	Status
az ml model archive	モデルをアーカイブします。	拡張子	GA
az ml model create	モデルを作成します。	拡張子	GA
az ml model download	すべてのモデル関連ファイルをダウンロードします。	拡張子	GA
az ml model list	ワークスペース/レジストリ内のモデルを一覧表示します。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。	拡張子	GA
az ml model package	モデルを環境にパッケージ化します。	拡張子	プレビュー
az ml model restore	アーカイブされたモデルを復元します。	拡張子	GA
az ml model share	ワークスペースからレジストリに特定のモデルを共有します。	拡張子	GA
az ml model show	ワークスペース/レジストリ内のモデルの詳細を表示します。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。	拡張子	GA
az ml model update	ワークスペース/レジストリ内のモデルを更新します。	拡張子	GA

az ml model archive

モデルをアーカイブします。

モデルをアーカイブすると、既定でリスト クエリ (az ml model list) から非表示になります。 アーカイブされたモデルは、ワークフローで参照し、使用し続けることができます。 モデル コンテナーまたは特定のモデル バージョンをアーカイブできます。 モデル コンテナーをアーカイブすると、その名前でモデルのすべてのバージョンがアーカイブされます。 アーカイブされたモデルは、次を使用して az ml model restore復元できます。 モデル コンテナー全体がアーカイブされている場合、モデルの個々のバージョンを復元することはできません。モデル コンテナーを復元する必要があります。

az ml model archive --name
                    [--label]
                    [--registry-name]
                    [--resource-group]
                    [--version]
                    [--workspace-name]

例

モデル コンテナーをアーカイブする (そのモデルのすべてのバージョンをアーカイブする)

az ml model archive --name my-model --resource-group my-resource-group --workspace-name my-workspace

特定のモデル バージョンをアーカイブする

az ml model archive --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

モデルの名前。

省略可能のパラメーター

--label -l

モデルのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--resource-group -g

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

--version -v

モデルのバージョン。

--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 model create

モデルを作成します。

モデルは、ローカル ファイル、ローカル ディレクトリ、データストア、またはジョブ出力から作成できます。 作成されたモデルは、指定された名前とバージョンでワークスペース/レジストリで追跡されます。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。

az ml model create [--datastore]
                   [--description]
                   [--file]
                   [--name]
                   [--no-wait]
                   [--path]
                   [--registry-name]
                   [--resource-group]
                   [--set]
                   [--stage]
                   [--tags]
                   [--type]
                   [--version]
                   [--workspace-name]

例

YAML 仕様ファイルからモデルを作成する

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

コマンド オプションを使用してローカル フォルダーからモデルを作成する

az ml model create --name my-model --version 1 --path ./my-model --resource-group my-resource-group --workspace-name my-workspace

mlflow 実行 URI 形式 'runs:/<run-id><path-to-model-relative-to-the-root-of-the-artifact-location>/' とコマンド オプションを使用してモデルを作成する

az ml model create --name my-model --version 1 --path runs:/c42d2507-4953-4a7c-a4c1-2b5bfe0ac64e/model/ --type mlflow_model --resource-group my-resource-group --workspace-name my-workspace

azureml ジョブ URI 形式の 'azureml://jobs/<job-name>/outputs//paths/<named-output><path-to-model-relative-to-the-named-output-location>' とコマンド オプションを使用して、名前付きジョブ出力からモデルを作成します。 既定の名前付き出力は成果物です

az ml model create --name my-model --version 1 --path azureml://jobs/c42d2507-4953-4a7c-a4c1-2b5bfe0ac64e/outputs/artifacts/paths/model/ --resource-group my-resource-group --workspace-name my-workspace

コマンド オプションを使用してデータストア 'azureml://datastores/<datastore-name>/paths/<path-to-model-relative-to-the-root-of-the-datastore-location>' からモデルを作成する

az ml model create --name my-model --version 1 --path azureml://datastores/myblobstore/paths/models/cifar10/cifar.pt --resource-group my-resource-group --workspace-name my-workspace

省略可能のパラメーター

--datastore

ローカル成果物をアップロードするデータストア。

--description

モデルの説明。

--file -f

Azure ML モデル仕様を含む YAML ファイルへのローカル パス。 モデルの YAML リファレンス ドキュメントは次 https://aka.ms/ml-cli-v2-model-yaml-referenceの場所にあります。

--name -n

モデルの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--path -p

モデル ファイルへのパス。 ローカルまたはリモートの場所を指定できます。 指定する場合は、--name/-n と --version/-v も指定する必要があります。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--resource-group -g

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

--set

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

--stage -s

モデルのステージ。

--tags

オブジェクトのタグのスペース区切りのキーと値のペア。

--type -t

モデルの型、使用可能な値はcustom_model、mlflow_model、およびtriton_model。 既定の型はcustom_modelです。

--version -v

モデルのバージョン。

--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 model download

すべてのモデル関連ファイルをダウンロードします。

ファイルは、モデルの名前にちなんだフォルダーにダウンロードされます。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。

az ml model download --name
                     --version
                     [--download-path]
                     [--registry-name]
                     [--resource-group]
                     [--workspace-name]

例

指定した名前とバージョンのモデルをダウンロードする

az ml model download --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

指定した名前とバージョンのモデルを、指定したローカル パスにダウンロードする

az ml model download --name my-model --version 1  --download-path local_path --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

モデルの名前。

--version -v

モデルのバージョン。

省略可能のパラメーター

--download-path -p

モデル ファイルをダウンロードするためのパス。既定では、現在の作業ディレクトリが使用されます。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--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 model list

ワークスペース/レジストリ内のモデルを一覧表示します。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。

az ml model list [--archived-only]
                 [--include-archived]
                 [--max-results]
                 [--name]
                 [--registry-name]
                 [--resource-group]
                 [--stage]
                 [--workspace-name]

例

ワークスペース内のすべてのモデルを一覧表示する

az ml model list --resource-group my-resource-group --workspace-name my-workspace

ワークスペース内の指定した名前のすべてのモデル バージョンを一覧表示する

az ml model list --name my-model --resource-group my-resource-group --workspace-name my-workspace

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

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

省略可能のパラメーター

--archived-only

アーカイブされたモデルのみを一覧表示します。

既定値: False

--include-archived

アーカイブされたモデルとアクティブなモデルを一覧表示します。

既定値: False

--max-results -r

返される結果の最大数。

--name -n

モデルの名前。 指定した場合、この名前のすべてのモデル バージョンが返されます。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--resource-group -g

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

--stage -s

モデルのステージ。

--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 model package

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

モデルを環境にパッケージ化します。

モデルがパッケージ化されると、すべての依存関係を持つ環境が作成されます。

az ml model package --file
                    --name
                    --version
                    [--registry-name]
                    [--resource-group]
                    [--workspace-name]

例

指定した名前とバージョンを使用してモデルをパッケージ化する

az ml model package --name my-model --version my-version --resource-group my-resource-group --workspace-name my-workspace --file my-package.yml

必須のパラメーター

--file -f

モデル パッケージ定義を含む YAML ファイルへのローカル パス。

--name -n

モデルの名前。

--version -v

モデルのバージョン。

省略可能のパラメーター

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--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 model restore

アーカイブされたモデルを復元します。

アーカイブされたモデルが復元されると、リスト クエリ (az ml model list) では非表示ではなくなります。 モデル コンテナー全体がアーカイブされている場合は、そのアーカイブされたコンテナーを復元できます。 これにより、指定された名前のモデルのすべてのバージョンが復元されます。 モデル コンテナー全体がアーカイブされている場合、特定のモデル バージョンのみを復元することはできません。コンテナー全体を復元する必要があります。 個々のモデル バージョンのみがアーカイブされている場合は、その特定のバージョンを復元できます。

az ml model restore --name
                    [--label]
                    [--registry-name]
                    [--resource-group]
                    [--version]
                    [--workspace-name]

例

アーカイブされたモデル コンテナーを復元する (そのモデルのすべてのバージョンを復元します)

az ml model restore --name my-model --resource-group my-resource-group --workspace-name my-workspace

アーカイブされた特定のモデル バージョンを復元する

az ml model restore --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

モデルの名前。

省略可能のパラメーター

--label -l

モデルのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--resource-group -g

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

--version -v

モデルのバージョン。

--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 model share

ワークスペースからレジストリに特定のモデルを共有します。

ワークスペース間で再利用するために、ワークスペースからレジストリに既存のモデルをコピーします。

az ml model share --name
                  --registry-name
                  --share-with-name
                  --share-with-version
                  --version
                  [--resource-group]
                  [--workspace-name]

例

ワークスペースからレジストリに既存の環境を共有する

az ml model share --name my-model --version my-version --resource-group my-resource-group --workspace-name my-workspace --share-with-name new-name-in-registry --share-with-version new-version-in-registry --registry-name my-registry

必須のパラメーター

--name -n

モデルの名前。

--registry-name

移行先のレジストリ。

--share-with-name

作成するモデルの名前。

--share-with-version

作成するモデルのバージョン。

--version -v

モデルのバージョン。

省略可能のパラメーター

--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 model show

ワークスペース/レジストリ内のモデルの詳細を表示します。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。

az ml model show --name
                 [--label]
                 [--registry-name]
                 [--resource-group]
                 [--version]
                 [--workspace-name]

例

指定した名前とバージョンを持つモデルの詳細を表示する

az ml model show --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

モデルの名前。

省略可能のパラメーター

--label -l

モデルのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--resource-group -g

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

--version -v

モデルのバージョン。

--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 model update

ワークスペース/レジストリ内のモデルを更新します。

'description' プロパティと 'tags' プロパティを更新できます。 レジストリを使用している場合は、オプションに--registry-name <registry-name>置き換えます--workspace-name my-workspace。

az ml model update --name
                   --resource-group
                   [--add]
                   [--force-string]
                   [--label]
                   [--registry-name]
                   [--remove]
                   [--set]
                   [--stage]
                   [--version]
                   [--workspace-name]

例

モデルのフレーバーを更新する

az ml model update --name my-model --version 1 --set flavors.python_function.python_version=3.8 --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

モデルの名前。

--resource-group -g

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

省略可能のパラメーター

--add

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

既定値: []

--force-string

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

既定値: False

--label -l

モデルのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。 そのため、リソース グループとワークスペースは必要ありません。

--remove

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

既定値: []

--set

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

既定値: []

--stage -s

モデルのステージ。

--version -v

モデルのバージョン。

--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 を使います。