CLI (v2) feature retrieval specification YAML schema

  • Article

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
serialization_version string The version to serialize this spec file. 2
featurestores list of object The feature stores.
featurestores.featurestore object The feature store object.
featurestores.featurestore.features list of object The list of features to retrieve from this feature store.
featurestores.featurestore.features.feature_name string The feature name.
featurestores.featurestore.features.feature_set string The feature name and version in the format of featureset_name:version.
featurestores.featurestore.location string The location of the feature store.
featurestores.featurestore.uri string The URI of the feature store in the format of azureml://subscriptions/{sub_id}/resourceGroups/{rg}/workspaces/{featurestore_name}.
featurestores.featurestore.workspace_id string The feature store workspace ID.

Examples

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

YAML: basic

featurestores:
- features:
  - feature_name: transaction_1d_count
    feature_set: transaction1d:1
  - feature_name: transaction_amount_1d_sum
    feature_set: transaction1d:1
  location: chinanorth3
  uri: azureml://subscriptions/{sub_id}/resourcegroups/{rg}/workspaces/{ws_name}
  workspace_id: {ws_id}
serialization_version: 1

Next steps