CLI (v2) 特徴量ストアの YAML スキーマ

  • [アーティクル]

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

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 を含めることで、スキーマとリソースの入力候補を呼び出すことができます。
name string 必須。 特徴量ストアの名前。
compute_runtime object 具体化ジョブに使われるコンピューティング ランタイム構成。
compute_runtime.spark_runtime_version string Azure Machine Learning Spark ランタイムのバージョン。 3.4 3.4
offline_store object
offline_store.type string offline_store が指定されている場合は必須。 オフライン ストアの種類。 Data Lake Gen2 の種類のストレージのみがサポートされています。 azure_data_lake_gen2
offline_store.target string offline_store が指定されている場合は必須。 /subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Storage/storageAccounts/<account>/blobServices/default/containers/<container> の形式での、Data Lake Gen2 ストレージの URI。
online_store オブジェクト
online_store.type string 必須 online_storeが指定されている場合。 オンライン ストアの種類。 Redis Cache のみがサポートされています。 redis
online_store.target string 必須 online_storeが指定されている場合。 /subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Cache/Redis/<redis-name>形式の Redis Cache URI。
materialization_identity object 具体化ジョブに使われるユーザー割り当てマネージド ID。 この ID には、Feature Store サービス、データ ソース、およびオフライン ストレージにアクセスするために必要なロールが付与されている必要があります。
materialization_identity.client_id string ユーザー割り当てマネージド ID のクライアント ID。
materialization_identity.resource_id string ユーザー割り当てマネージド ID のリソース ID。
materialization_identity.principal_id string ユーザー割り当てマネージド ID のプリンシパル ID。
description string 特徴量ストアの説明。
tags object 特徴量ストアのタグの辞書。
display_name string スタジオ UI での特徴量ストアの表示名。 リソース グループ内で一意でなくてもかまいません。
location string 特徴量ストアの場所。 リソース グループの場所。
resource_group string 特徴量ストアを含むリソース グループ。 リソース グループが存在しない場合は、新しく作成されます。

他のワークスペース プロパティを含めることができます。

解説

Azure Machine Learning の特徴量ストア ワークスペースの管理には、az ml feature-store コマンドを使用できます。

例

例は、GitHub リポジトリの例にあります。 一般的な例をいくつか次に示します。

YAML の基本

$schema: http://azureml/sdk-2-0/FeatureStore.json
name: mktg-feature-store
location: eastus

オフライン ストア構成での YAML

$schema: http://azureml/sdk-2-0/FeatureStore.json
name: mktg-feature-store

compute_runtime:
    spark_runtime_version: 3.2

offline_store:
    type: azure_data_lake_gen2
    target: /subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.Storage/storageAccounts/<account_name>/blobServices/default/containers/<container_name>

materialization_identity:
    client_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    resource_id: /subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<uai-name>

# Many of workspace parameters will also be supported:
location: eastus
display_name: marketing feature store
tags:
  foo: bar

YAML を使用して CLI でオンライン ストアを構成する

$schema: http://azureml/sdk-2-0/FeatureStore.json
name: mktg-feature-store

compute_runtime:
  spark_runtime_version: 3.4

online_store:
  type: redis
  target: "/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.Cache/Redis/<redis-name>"

materialization_identity:
  client_id: 00001111-aaaa-2222-bbbb-3333cccc4444
  principal_id: aaaaaaaa-bbbb-cccc-1111-222222222222
  resource_id: /subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<uai-name>

# Many of workspace parameters will also be supported:
location: eastus
display_name: marketing feature store
tags:
  foo: bar

Python を使用して CLI でオンライン ストアを構成する

redis_arm_id = f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{redis_name}"
online_store = MaterializationStore(type="redis", target=redis_arm_id)
 
fs = FeatureStore(
    name=featurestore_name,
    location=location,
    online_store=online_store,
)
 
# wait for feature store creation
fs_poller = ml_client.feature_stores.begin_create(fs)

# move the feature store to a YAML file

yaml_path = root_dir + "/featurestore/featurestore_with_online.yaml"
fs.dump(yaml_path)

次のステップ