Share via

az ml feature-set

  • Reference

Note

This reference is part of the ml extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az ml feature-set command. Learn more about extensions.

Manage Azure ML feature sets.

A collection of features on a source.

Commands

Name Description Type Status
az ml feature-set archive

Archive a feature set.

 Extension GA
az ml feature-set backfill

Begin backfill job.

 Extension GA
az ml feature-set create

Create a feature set.

 Extension GA
az ml feature-set get-feature

Gets a feature for a feature set.

 Extension Deprecated
az ml feature-set list

List feature set in a feature store.

 Extension GA
az ml feature-set list-features

List Features for a feature set.

 Extension GA
az ml feature-set list-materialization-operation

List Materialization operation.

 Extension GA
az ml feature-set restore

Restore an archived feature set.

 Extension GA
az ml feature-set show

Shows details for a feature set.

 Extension GA
az ml feature-set show-feature

Shows a feature for a feature set.

 Extension GA
az ml feature-set update

Update a feature set.

 Extension GA

az ml feature-set archive

Archive a feature set.

Archiving a feature set will hide it by default from list queries (az ml feature-set list).

az ml feature-set archive --name
                          --version
                          [--feature-store-name]
                          [--resource-group]
                          [--workspace-name]
                          [--yes]

Examples

Archive a specific feature set version

az ml feature-set archive --name my-feature-set --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set backfill

Begin backfill job.

az ml feature-set backfill [--by-data-status]
                           [--by-job-id]
                           [--compute-resource]
                           [--description]
                           [--display-name]
                           [--feature-store-name]
                           [--feature-window-end-time]
                           [--feature-window-start-time]
                           [--file]
                           [--name]
                           [--resource-group]
                           [--spark-configuration-settings]
                           [--tags]
                           [--version]
                           [--workspace-name]

Examples

Begin backfill job

az ml feature-set backfill --name my-feature-set --version 1 --resource-group my-resource-group --feature-store-name my-feature-store --feature-window-start-time start-time --feature-window-end-time end-time

Optional Parameters

--by-data-status -d

Specified the data availability status that you want to backfill.

--by-job-id -j

Specify the jobId to retry the failed materialization.

--compute-resource -r

Specifies the compute resource settings.

--description

Description of the object.

--display-name

Specifies the display name.

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--feature-window-end-time -e

End time of the feature window to be materialized.

--feature-window-start-time -s

Start time of the feature window to be materialized.

--file -f

Local path to the YAML file containing the feature set backfill request.

--name -n

Name of the feature set.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--spark-configuration-settings -c

Specifies the spark compute settings.

--tags

Space-separated key-value pairs for the tags of the object.

--version -v

Version of the feature set.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set create

Create a feature set.

Feature sets can be defined from files on your local machine. The created feature set will be tracked in the feature store under the specified name and version.

To create a feature set from file(s) on your local machine, specify the 'path' field in your YAML config. Azure ML will upload these file(s) to the blob container that backs the feature store's default datastore (named 'workspaceblobstore'). The created feature set will then point to that uploaded feature set.

az ml feature-set create [--description]
                         [--feature-store-name]
                         [--file]
                         [--materialization-settings]
                         [--name]
                         [--no-wait]
                         [--resource-group]
                         [--set]
                         [--specification]
                         [--version]
                         [--workspace-name]

Examples

Create a feature set from a YAML specification file

az ml feature-set create --file feature-set.yaml --resource-group my-resource-group --feature-store-name my-feature-store

Optional Parameters

--description -d

Description of the feature set.

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--file -f

Local path to the YAML file containing the Azure ML featureset specification. The YAML reference docs for featureset can be found at: https://aka.ms/ml-cli-v2-featureset-yaml-reference.

--materialization-settings -m

Materialization settings for feature set.

--name -n

Name of the feature set.

--no-wait

Do not wait for feature set creation to finish.

Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--specification -s

Specification for feature set.

--version -v

Version of the feature set.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set get-feature

Deprecated

This command has been deprecated and will be removed in a future release. Use 'ml feature-set show-feature' instead.

Gets a feature for a feature set.

az ml feature-set get-feature --feature-name
                              --name
                              --version
                              [--feature-store-name]
                              [--resource-group]
                              [--workspace-name]

Examples

Get feature

az ml feature-set get-feature --name my-feature-set --version 1 --feature-name my-feature --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--feature-name

Name of the feature (case sensitive).

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set list

List feature set in a feature store.

az ml feature-set list [--archived-only]
                       [--feature-store-name]
                       [--include-archived]
                       [--max-results]
                       [--name]
                       [--resource-group]
                       [--workspace-name]

Examples

List all the feature set in a feature store

az ml feature-set list --resource-group my-resource-group --feature-store-name my-feature-store

List all the feature set versions for the specified name in a feature store

az ml feature-set list --name my-feature-set --resource-group my-resource-group --feature-store-name my-feature-store

List all the feature set assets in a feature store using --query argument to execute a JMESPath query on the results of commands.

az ml feature-set list --query "[].{Name:name}" --output table --resource-group my-resource-group --feature-store-name my-feature-store

Optional Parameters

--archived-only

List archived feature set assets only.

Default value: False
--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--include-archived

List archived feature set assets and active feature set assets.

Default value: False
--max-results -r

Max number of results to return.

--name -n

Name of the feature set. If provided, all the feature set versions under this name will be returned.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set list-features

List Features for a feature set.

az ml feature-set list-features --name
                                --version
                                [--feature-name]
                                [--feature-store-name]
                                [--resource-group]
                                [--workspace-name]

Examples

List features

az ml feature-set list-features --name my-feature-set --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-name

Name of the feature (case sensitive).

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set list-materialization-operation

List Materialization operation.

az ml feature-set list-materialization-operation --name
                                                 --version
                                                 [--feature-store-name]
                                                 [--feature-window-end-time]
                                                 [--feature-window-start-time]
                                                 [--filters]
                                                 [--resource-group]
                                                 [--workspace-name]

Examples

List Materialization operation

az ml feature-set list-materialization-operation --name my-feature-set --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--feature-window-end-time -e

End time of the feature window to be materialized.

--feature-window-start-time -s

Start time of the feature window to be materialized.

--filters

Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set restore

Restore an archived feature set.

When an archived feature set is restored, it will no longer be hidden from list queries (az ml feature-set list).

az ml feature-set restore --name
                          --version
                          [--feature-store-name]
                          [--resource-group]
                          [--workspace-name]
                          [--yes]

Examples

Restore a specific archived feature set version

az ml feature-set restore --name my-feature-set --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set show

Shows details for a feature set.

az ml feature-set show --name
                       --version
                       [--feature-store-name]
                       [--resource-group]
                       [--workspace-name]

Examples

Show details for a feature set with the specified name and version in a feature store

az ml feature-set show --name my-feature-set --version 1 --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set show-feature

Shows a feature for a feature set.

az ml feature-set show-feature --feature-name
                               --name
                               --version
                               [--feature-store-name]
                               [--resource-group]
                               [--workspace-name]

Examples

Show feature

az ml feature-set show-feature --name my-feature-set --version 1 --feature-name my-feature --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--feature-name

Name of the feature (case sensitive).

--name -n

Name of the feature set.

--version -v

Version of the feature set.

Optional Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ml feature-set update

Update a feature set.

az ml feature-set update --feature-store-name
                         --resource-group
                         --workspace-name
                         [--add]
                         [--file]
                         [--force-string]
                         [--name]
                         [--no-wait]
                         [--remove]
                         [--set]
                         [--version]

Examples

Update a feature set from a YAML specification file

az ml feature-set update --file feature-set.yaml --resource-group my-resource-group --feature-store-name my-feature-store

Required Parameters

--feature-store-name

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Deprecated

Option '--workspace-name' has been deprecated and will be removed in a future release. Use '--feature-store-name' instead.

Name of the feature store You can configure the default group using az configure --defaults feature-store=<name>.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--file -f

Local path to the YAML file containing the feature set asset specification.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--name -n

Name of the feature set.

--no-wait

Do not wait for feature set update to finish.

Default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
--version -v

Version of the feature set.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.