CLI (v2) コンピューティング クラスター (AmlCompute) YAML スキーマ

  • [アーティクル]

適用対象: Azure CLI ml 拡張機能 v2 (現行)

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

Note

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

YAML 構文

キー Type 説明 使用できる値 既定値
$schema string YAML スキーマ。 Azure Machine Learning 用 VS Code 拡張機能を使用して YAML ファイルを作成する場合は、ファイルの先頭に $schema を含めることで、スキーマとリソースの入力候補を呼び出すことができます。
type string 必須。 コンピューティングの種類。 amlcompute
name string 必須。 コンピューティングの名前。
description string コンピューティングの説明。
location string コンピューティングの場所。 省略した場合、既定ではワークスペースの場所に設定されます。
size string クラスターに使用する VM サイズ。 詳細については、「サポートされている VM シリーズおよびサイズ」をご覧ください。 すべてのリージョンですべてのサイズを使用できるわけではありません。 特定のリージョンでサポートされているサイズの一覧については、az ml compute list-sizes を使用してください。 Standard_DS3_v2
tier string クラスターに使用する VM 優先度レベル。 優先順位の低い VM はプリエンプティブルですが、専用 VM と比較してコストが削減されます。 $ dedicated
min_instances 整数 (integer) クラスターで使用するノードの最小数。 ノードの最小数を 0 に設定すると、Azure Machine Learning はクラスターが使用されていないときに、クラスターをスケールダウンしてノードをゼロにすることができます。 0 よりも大きい値を指定すると、クラスターが使用されていない場合でも、指定した数のノードが実行され続けます。 0
max_instances 整数 (integer) クラスターで使用するノードの最大数。 1
idle_time_before_scale_down 整数 (integer) クラスターをスケールダウンするまでのノードのアイドル時間 (秒)。 120
ssh_public_access_enabled boolean クラスターのノードでパブリック SSH アクセスを有効にするかどうか。 false
ssh_settings object クラスターに接続するための SSH 設定。
ssh_settings.admin_username string ノードへの SSH 接続に使用できる管理者のユーザー アカウントの名前。
ssh_settings.admin_password string 管理者のユーザー アカウントのパスワード。 admin_password または ssh_key_value のいずれかが必須です。
ssh_settings.ssh_key_value string 管理者ユーザー アカウントの SSH 公開キー。 admin_password または ssh_key_value のいずれかが必須です。
network_settings object ネットワークのセキュリティ設定。
network_settings.vnet_name string 新しい仮想ネットワーク (VNet) を作成するとき、または既存の仮想ネットワークを参照するときの、仮想ネットワークの名前。
network_settings.subnet string 新しい VNet を作成するとき、既存の VNet を参照するとき、または既存の VNet のサブネットの完全修飾リソース ID を参照するときの、サブネットの名前。 サブネット ID が指定されている場合は network_settings.vnet_name を指定しないでください。 サブネット ID は、別のリソース グループ内の VNet またはサブネットを参照できます。
identity object コンピューティングに割り当てるマネージド ID 構成。 AmlCompute クラスターは、システムによって割り当てられた 1 つの ID またはユーザーによって割り当てられた複数の ID のみをサポートします。両方同時にはサポートされません。
identity.type string コンピューティングに割り当てるマネージド ID の種類。 型が user_assigned の場合は、identity.user_assigned_identities プロパティも指定する必要があります。 $
identity.user_assigned_identities array ユーザー割り当て ID の完全修飾リソース ID の一覧。

Remarks

az ml compute コマンドを使用して、Azure Machine Learning コンピューティング クラスター (AmlCompute) を管理できます。

例

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

YAML: 最小

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: minimal-example
type: amlcompute

YAML: 基本

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: basic-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120

YAML: カスタムの場所

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: location-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120
location: westus

YAML: 低優先度

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: low-pri-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120
tier: low_priority

YAML: SSH ユーザー名およびパスワード

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: ssh-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120
ssh_settings:
  admin_username: example-user
  admin_password: example-password

次の手順