az ml environment

Note

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

Azure ML 環境を管理します。

Azure ML 環境では、ジョブとエンドポイントのデプロイの実行環境を定義し、トレーニングと推論の依存関係をカプセル化します。 これらの環境定義は Docker イメージに組み込まれています。

コマンド

名前	説明	型	Status
az ml environment archive	環境をアーカイブします。	拡張子	GA
az ml environment create	環境を作成する。	拡張子	GA
az ml environment list	ワークスペース内の環境を一覧表示します。	拡張子	GA
az ml environment restore	アーカイブされた環境を復元します。	拡張子	GA
az ml environment share	ワークスペースからレジストリに特定の環境を共有します。	拡張子	GA
az ml environment show	環境の詳細を表示します。	拡張子	GA
az ml environment update	環境を更新します。	拡張子	GA

az ml environment archive

環境をアーカイブします。

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

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

例

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

az ml environment archive --name my-env --resource-group my-resource-group --workspace-name my-workspace

特定の環境バージョンをアーカイブする

az ml environment archive --name my-env --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 environment create

環境を作成する。

環境は、Docker イメージ、Dockerfile、または Conda ファイルから定義できます。 Azure ML メインベース イメージとして使用できる一連の CPU および GPU Docker イメージが含まれています。 これらのイメージの詳細については、次を参照してください https://github.com/Azure/AzureML-Containers。

作成された環境は、指定された名前とバージョンでワークスペースで追跡されます。

az ml environment create [--build-context]
                         [--conda-file]
                         [--datastore]
                         [--description]
                         [--dockerfile-path]
                         [--file]
                         [--image]
                         [--name]
                         [--no-wait]
                         [--os-type]
                         [--registry-name]
                         [--resource-group]
                         [--set]
                         [--tags]
                         [--version]
                         [--workspace-name]

例

YAML 仕様ファイルから環境を作成する

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

Docker イメージから環境を作成する

az ml environment create --name my-env --version 1 --file my_env.yml  --image pytorch/pytorch --resource-group my-resource-group --workspace-name my-workspace

ビルド コンテキストから環境を作成する

az ml environment create --name my-env --version 1 --file my_env.yml  --build-context envs/context/ --dockerfile-path Dockerfile --resource-group my-resource-group --workspace-name my-workspace

Conda 仕様から環境を作成する

az ml environment create --name my-env --version 1 --file my_env.yml  --conda-file conda_dep.yml --image mcr.microsoft.com/azureml/openmpi3.1.2-ubuntu18.04 --resource-group my-resource-group --workspace-name my-workspace

YAML 仕様ファイルからレジストリに環境を作成する

az ml environment create --file my_env.yml --registry-name my-registry-name --resource-group my-resource-group

省略可能のパラメーター

--build-context -b

Docker ビルド コンテキストとして使用するディレクトリへのローカル パス。 --build-context/-b と --image/-i は相互に排他的な引数です。

--conda-file -c

conda 仕様ファイルへのローカル パス。 この引数を使用する場合は、--image/-i も指定する必要があります。

--datastore

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

--description

環境の説明。

--dockerfile-path -d

--build-context/-b で指定されたディレクトリ内の Dockerfile への相対パス。 省略すると、'./Dockerfile' が使用されます。

既定値: /Dockerfile

--file -f

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

--image -i

Docker イメージ。 --image/-i と --build-context/-b は相互に排他的な引数です。

--name -n

環境の名前。

--no-wait

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

既定値: False

--os-type

オペレーティング システムの種類。 使用できる値: linux、windows。 既定値: linux。

--registry-name

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

--resource-group -g

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

--set

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

--tags

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

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

ワークスペース内の環境を一覧表示します。

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

例

ワークスペース内のすべての環境を一覧表示する

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

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

az ml environment list --name my-env --resource-group my-resource-group --workspace-name my-workspace

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

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

レジストリ内のすべての環境を一覧表示する

az ml environment list --registry-name my-registry-name --resource-group my-resource-group

レジストリ内の指定した名前のすべての環境バージョンを一覧表示する

az ml environment list --name my-env --registry-name my-registry-name --resource-group my-resource-group

省略可能のパラメーター

--archived-only

アーカイブされた環境のみを一覧表示します。

既定値: False

--include-archived

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

既定値: False

--max-results -r

返される結果の最大数。

--name -n

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

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

アーカイブされた環境を復元します。

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

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

例

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

az ml environment restore --name my-env --resource-group my-resource-group --workspace-name my-workspace

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

az ml environment restore --name my-env --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 environment share

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

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

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

例

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

az ml environment share --name my-environment --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 environment show

環境の詳細を表示します。

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

例

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

az ml environment show --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

指定した名前とバージョンを持つレジストリ内の環境の詳細を表示する

az ml environment show --name my-env --version 1 --registry-name my-registry-name --resource-group my-resource-group

必須のパラメーター

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

環境を更新します。

'description' プロパティと 'tags' プロパティのみを更新できます。

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

必須のパラメーター

--name -n

環境の名前。

省略可能のパラメーター

--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.

既定値: []

--resource-group -g

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

--set

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

既定値: []

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