Train models with Azure Machine Learning CLI, SDK, and REST API

APPLIES TO: Azure CLI ml extension v2 (current) Python SDK azure-ai-ml v2 (preview)

Azure Machine Learning provides multiple ways to submit ML training jobs. In this article, you'll learn how to submit jobs using the following methods:

  • Azure CLI extension for machine learning: The ml extension, also referred to as CLI v2.
  • Python SDK v2 for Azure Machine Learning.
  • REST API: The API that the CLI and SDK are built on.


SDK v2 is currently in public preview. The preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.


To use the SDK information, install the Azure Machine Learning SDK v2 for Python.

Clone the examples repository

The code snippets in this article are based on examples in the Azure ML examples GitHub repo. To clone the repository to your development environment, use the following command:

git clone --depth 1


Use --depth 1 to clone only the latest commit to the repository, which reduces time to complete the operation.

Example job

The examples in this article use the iris flower dataset to train an MLFlow model.

Train in the cloud

When training in the cloud, you must connect to your Azure Machine Learning workspace and select a compute resource that will be used to run the training job.

1. Connect to the workspace


Use the tabs below to select the method you want to use to train a model. Selecting a tab will automatically switch all the tabs in this article to the same tab. You can select another tab at any time.

To connect to the workspace, you need identifier parameters - a subscription, resource group, and workspace name. You'll use these details in the MLClient from the namespace to get a handle to the required Azure Machine Learning workspace. To authenticate, you use the default Azure authentication. Check this example for more details on how to configure credentials and connect to a workspace.

#import required libraries
from import MLClient
from azure.identity import DefaultAzureCredential

#Enter details of your AzureML workspace
subscription_id = '<SUBSCRIPTION_ID>'
resource_group = '<RESOURCE_GROUP>'

#connect to the workspace
ml_client = MLClient(DefaultAzureCredential(), subscription_id, resource_group, workspace)

2. Create a compute resource for training

An AzureML compute cluster is a fully managed compute resource that can be used to run the training job. In the following examples, a compute cluster named cpu-compute is created.

from import AmlCompute

# specify aml compute name.
cpu_compute_target = "cpu-cluster"

except Exception:
    print("Creating a new cpu compute target...")
    compute = AmlCompute(
        name=cpu_compute_target, size="STANDARD_D2_V2", min_instances=0, max_instances=4

4. Submit the training job

To run this script, you'll use a command. The command will be run by submitting it as a job to Azure ML.

from import command, Input

# define the command
command_job = command(
    command="python --iris-csv ${{inputs.iris_csv}} --learning-rate ${{inputs.learning_rate}} --boosting ${{inputs.boosting}}",
        "iris_csv": Input(
        "learning_rate": 0.9,
        "boosting": "gbdt",
# submit the command
returned_job =
# get a URL for the status of the job["Studio"].endpoint

In the above examples, you configured:

  • code - path where the code to run the command is located
  • command - command that needs to be run
  • environment - the environment needed to run the training script. In this example, we use a curated or ready-made environment provided by AzureML called AzureML-lightgbm-3.2-ubuntu18.04-py37-cpu. We use the latest version of this environment by using the @latest directive. You can also use custom environments by specifying a base docker image and specifying a conda yaml on top of it.
  • inputs - dictionary of inputs using name value pairs to the command. The key is a name for the input within the context of the job and the value is the input value. Inputs are referenced in the command using the ${{inputs.<input_name>}} expression. To use files or folders as inputs, you can use the Input class.

For more information, see the reference documentation.

When you submit the job, a URL is returned to the job status in the AzureML studio. Use the studio UI to view the job progress. You can also use returned_job.status to check the current status of the job.

Register the trained model

The following examples demonstrate how to register a model in your AzureML workspace.


The name property returned by the training job is used as part of the path to the model.

from import Model
from import ModelType

run_model = Model(
    description="Model created from run.",


Next steps

Now that you have a trained model, learn how to deploy it using an online endpoint.

For more examples, see the AzureML examples GitHub repository.

For more information on the Azure CLI commands, Python SDK classes, or REST APIs used in this article, see the following reference documentation: