az ml run
Note
This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml run command. Learn more about extensions.
Commands for submitting, updating, and monitoring runs.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az ml run cancel |
Cancel run. |
Extension | GA |
| az ml run download-logs |
Download log files. |
Extension | GA |
| az ml run list |
List runs. |
Extension | GA |
| az ml run monitor-logs |
Monitor the logs for an existing run. |
Extension | GA |
| az ml run monitor-tensorboard |
Monitor an existing run using tensorboard. |
Extension | GA |
| az ml run show |
Show run. |
Extension | GA |
| az ml run submit-hyperdrive |
Submit a hyper parameter sweep using run config. |
Extension | GA |
| az ml run submit-pipeline |
Submit a pipeline for execution, from a published pipeline ID or pipeline YAML file. |
Extension | GA |
| az ml run submit-script |
Submit a script for execution. |
Extension | GA |
| az ml run update |
Update the run by adding tags. |
Extension | GA |
az ml run cancel
Cancel run.
az ml run cancel --run
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The runId of an experiment run.
Optional Parameters
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run download-logs
Download log files.
az ml run download-logs --output-dir
--run
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
Output directory to download log files to.
The runId of an experiment run.
Optional Parameters
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run list
List runs.
az ml run list [--compute-target-name]
[--experiment-name]
[--last]
[--minimal]
[--output-metadata-file]
[--parent-run-id]
[--path]
[--pipeline-run-id]
[--resource-group]
[--status {Completed, Failed, Finalizing, Preparing, Provisioning, Queued, Running, Starting}]
[--subscription-id]
[--tags]
[--workspace-name]Optional Parameters
The compute target name.
Experiment name.
Fetch the latest N elements.
Flag to provide minimum properties for run output.
Provide an optional output file location for structured object output.
Parent Run ID.
Path to a root directory for run configuration files.
Pipeline Run ID.
Resource group name.
Status of the run.
Specifies the subscription Id.
Tags for a run with 'key[=value]' syntax.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run monitor-logs
Monitor the logs for an existing run.
az ml run monitor-logs --run
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The runId of an experiment run.
Optional Parameters
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run monitor-tensorboard
Monitor an existing run using tensorboard.
az ml run monitor-tensorboard --run
[--experiment-name]
[--local-directory]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The runId of an experiment run.
Optional Parameters
Experiment name.
Local Directory to stage tensorboard files being monitored.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run show
Show run.
az ml run show --run
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The runId of an experiment run.
Optional Parameters
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run submit-hyperdrive
Submit a hyper parameter sweep using run config.
az ml run submit-hyperdrive --hyperdrive-configuration-name
[--async]
[--conda-dependencies]
[--ct]
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--run-configuration-name]
[--source-directory]
[--subscription-id]
[--workspace-name]
[<USER_SCRIPT_AND_ARGUMENTS>]Required Parameters
The full name of the hyperdrive configuration file. The file should be in a sub-folder of the directory specified by the path parameter.
Optional Parameters
Disable output streaming.
Override the default Conda dependencies file.
The name of the compute target to use for the run.
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Name (without extension) of a run configuration file. The file should be in a sub-folder of the directory specified by the path parameter.
A local directory containing source code files. Defaults to path if source directory is not provided.
Specifies the subscription Id.
Workspace name.
The run submit arguments, like script name and script arguments.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run submit-pipeline
Submit a pipeline for execution, from a published pipeline ID or pipeline YAML file.
az ml run submit-pipeline [--datapaths]
[--experiment-name]
[--output-metadata-file]
[--output_file]
[--parameters]
[--path]
[--pipeline-id]
[--pipeline-yaml]
[--resource-group]
[--subscription-id]
[--workspace-name]Optional Parameters
Comma-separated list of name=datastore/path pairs for datapath parameter assignments.
Experiment name for run submission. If unspecified, use the pipeline name.
Provide an optional output file location for structured object output.
File to write output in JSON format.
Comma-separated list of name=value pairs for pipeline parameter assignments.
Path to a root directory for run configuration files.
ID of a pipeline to submit (guid).
YAML file which defines a pipeline.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run submit-script
Submit a script for execution.
az ml run submit-script [--async]
[--conda-dependencies]
[--ct]
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--run-configuration-name]
[--source-directory]
[--subscription-id]
[--workspace-name]
[<USER_SCRIPT_AND_ARGUMENTS>]Optional Parameters
Disable output streaming.
Override the default Conda dependencies file.
The name of the compute target to use for the run.
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Name (without extension) of a run configuration file. The file should be in a sub-folder of the directory specified by the path parameter.
A local directory containing source code files. Defaults to path if source directory is not provided.
Specifies the subscription Id.
Workspace name.
The run submit arguments, like script name and script arguments.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az ml run update
Update the run by adding tags.
az ml run update --run
[--add-tag]
[--experiment-name]
[--output-metadata-file]
[--path]
[--resource-group]
[--subscription-id]
[--workspace-name]Required Parameters
The runId of an experiment run.
Optional Parameters
Tag the entitiy with 'key[=value]' syntax.
Experiment name.
Provide an optional output file location for structured object output.
Path to a root directory for run configuration files.
Resource group name.
Specifies the subscription Id.
Workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for