CLI (v2) feature entity YAML schema

  • 12/06/2024

APPLIES TO: Azure CLI ml extension v2 (current)

Note

The YAML syntax detailed in this document is based on the JSON schema for the latest version of the ML CLI v2 extension. This syntax is guaranteed only to work with the latest version of the ML CLI v2 extension. You can find the schemas for older extension versions at https://azuremlschemasprod.azureedge.net/.

YAML syntax

Key Type Description Allowed values Default value
$schema string The YAML schema. If you use the Azure Machine Learning VS Code extension to author the YAML file, including $schema at the top of your file enables you to invoke schema and resource completions.
name string Required. Feature store entity name.
version string Required. Feature store entity version.
description string Feature store entity description.
stage string Feature store entity stage. Development, Production, Archived Development
tags object Dictionary of tags for the feature store entity.
index_columns list of object Required. The index columns of the feature store entity.
index_columns.name string Required. The index column name.
index_columns.type string Required. The index column data type. string, integer, long, float, double, binary, datetime, boolean

Remarks

The az ml feature-store-entity command can be used for managing a feature store entity.

Examples

Examples are available in the examples GitHub repository. A basic example is shown below.

YAML: basic

$schema: http://azureml/sdk-2-0/FeatureStoreEntity.json

name: account
version: "1"
description: This entity represents user account index key accountID.
index_columns:
  - name: accountID
    type: string
tags:
  data_type: nonPII

Next steps