CLI (v2) 環境 YAML スキーマ

[アーティクル]
04/04/2023

ソース JSON スキーマは https://azuremlschemas.azureedge.net/latest/environment.schema.json にあります。

Note

このドキュメントで詳しく説明されている YAML 構文は、最新バージョンの ML CLI v2 拡張機能の JSON スキーマに基づいています。この構文は、ML CLI v2 拡張機能の最新バージョンでのみ動作することが保証されています。以前のバージョンの拡張機能のスキーマについては、https://azuremlschemasprod.azureedge.net/ でご確認いただけます。

YAML 構文

キー	種類	説明	使用できる値	既定値
`$schema`	string	YAML スキーマ。 Azure Machine Learning 用 VS Code 拡張機能を使用して YAML ファイルを作成する場合は、ファイルの先頭に `$schema` を含めることで、スキーマとリソースの入力候補を呼び出すことができます。
`name`	string	必須。環境の名前。
`version`	string	環境のバージョン。省略した場合、Azure Machine Learning によってバージョンが自動生成されます。
`description`	string	環境の説明。
`tags`	object	環境のタグのディクショナリ。
`image`	string	環境に使用する Docker イメージ。 `image` または `build` のいずれかが必須です。
`conda_file`	文字列またはオブジェクト	conda 環境の依存関係の標準 conda YAML 構成ファイル。「https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-file-manually」を参照してください。指定されている場合は、`image` を指定する必要があります。 Azure Machine Learning は、提供されている Docker イメージを基盤にして conda 環境をビルドします。
`build`	object	環境に使用する Docker ビルドコンテキスト構成。 `image` または `build` のいずれかが必須です。
`build.path`	string	ビルドコンテキストとして使用するディレクトリへのローカルパス。
`build.dockerfile_path`	string	ビルドコンテキスト内の Dockerfile への相対パス。		`Dockerfile`
`os_type`	string	オペレーティングシステムの種類。	`linux`, `windows`	`linux`
`inference_config`	object	推論コンテナーの構成。環境を使用してオンラインデプロイ用のサービスコンテナーを構築する場合にのみ適用されます。詳しくは、`inference_config`キーの属性について参照してください。

`inference_config` キーの属性

キー	種類	説明
`liveness_route`	object	サービスコンテナーの liveness ルート。
`liveness_route.path`	string	liveness 要求をルーティングするパス。
`liveness_route.port`	整数 (integer)	liveness 要求をルーティングするポート。
`readiness_route`	object	サービスコンテナーの準備ルート。
`readiness_route.path`	string	準備要求をルーティングするパス。
`readiness_route.port`	整数 (integer)	準備要求をルーティングするポート。
`scoring_route`	object	サービスコンテナーのスコアリングルート。
`scoring_route.path`	string	スコアリング要求をルーティングするパス。
`scoring_route.port`	整数 (integer)	スコアリング要求をルーティングするポート。

解説

az ml environment コマンドは、Azure Machine Learning 環境を管理するために使用できます。

例

例は、GitHub リポジトリの例にあります。以下にいくつか示します。

YAML: ローカル Docker ビルドコンテキスト

$schema: https://azuremlschemas.azureedge.net/latest/environment.schema.json
name: docker-context-example
build:
  path: docker-contexts/python-and-pip

YAML: Docker イメージ

$schema: https://azuremlschemas.azureedge.net/latest/environment.schema.json
name: docker-image-example
image: pytorch/pytorch:latest
description: Environment created from a Docker image.

YAML: Docker イメージと conda ファイル

$schema: https://azuremlschemas.azureedge.net/latest/environment.schema.json
name: docker-image-plus-conda-example
image: mcr.microsoft.com/azureml/openmpi4.1.0-ubuntu20.04
conda_file: conda-yamls/pydata.yml
description: Environment created from a Docker image plus Conda environment.

次の手順

CLI (v2) をインストールして使用する