Configuration¶

Setting up your Azure Machine Learning services workspace

Table of Contents¶

Introduction
1. What is an Azure Machine Learning workspace
Setup
1. Azure subscription
2. Azure ML SDK and other library installationregistration
Configure your Azure ML Workspace
1. Workspace parameters
2. Access your workspace
3. Create a new workspace
Next steps

Introduction¶

This notebook configures your library of notebooks to connect to an Azure Machine Learning (ML) workspace. In this case, a library contains all of the notebooks in the current folder and any nested folders. You can configure this notebook library to use an existing workspace or create a new workspace.

Typically you will need to run this notebook only once per notebook library as all other notebooks will use connection information that is written here. If you want to redirect your notebook library to work with a different workspace, then you should re-run this notebook.

In this notebook you will

Learn about getting an Azure subscription
Specify your workspace parameters
Access or create your workspace
Add a default compute cluster for your workspace

What is an Azure Machine Learning workspace¶

An Azure ML Workspace is an Azure resource that organizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows. In particular, an Azure ML Workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, deployment, inferencing, and the monitoring of deployed models.

Setup¶

This section describes activities required before you can access any Azure ML services functionality.

1. Azure Subscription¶

In order to create an Azure ML Workspace, first you need access to an Azure subscription. An Azure subscription allows you to manage storage, compute, and other assets in the Azure cloud. You can create a new subscription or access existing subscription information from the Azure portal. Later in this notebook you will need information such as your subscription ID in order to create and access AML workspaces.

2. Azure ML SDK and other library installation¶

If you are running in your own environment, follow SDK installation instructions. If you are running in Azure Notebooks or another Microsoft managed environment, the SDK is already installed.

Once installation is complete, the following cell checks the Azure ML SDK version:

In [ ]:

import azureml.core

print("This notebook was created using version 1.0.33 of the Azure ML SDK")
print("You are currently using version", azureml.core.VERSION, "of the Azure ML SDK")

Configure your Azure ML workspace¶

Workspace parameters¶

To use an AML Workspace, you will need to import the Azure ML SDK and supply the following information:

Your subscription id
A resource group name
(optional) The region that will host your workspace
A name for your workspace

You can get your subscription ID from the Azure portal.

You will also need access to a resource group, which organizes Azure resources and provides a default region for the resources in a group. You can see what resource groups to which you have access, or create a new one in the Azure portal. If you don't have a resource group, the create workspace command will create one for you using the name you provide.

The region to host your workspace will be used if you are creating a new workspace. You do not need to specify this if you are using an existing workspace. You can find the list of supported regions here. You should pick a region that is close to your location or that contains your data.

The name for your workspace is unique within the subscription and should be descriptive enough to discern among other AML Workspaces. The subscription may be used only by you, or it may be used by your department or your entire enterprise, so choose a name that makes sense for your situation.

The following cell allows you to specify your workspace parameters. This cell uses the python method os.getenv to read values from environment variables which is useful for automation. If no environment variable exists, the parameters will be set to the specified default values.

Replace the default values in the cell below with your workspace parameters

In [ ]:

import os

subscription_id = os.getenv("SUBSCRIPTION_ID", default="<you subscription id>")
resource_group = os.getenv("RESOURCE_GROUP", default="<your resource group>")
workspace_name = os.getenv("WORKSPACE_NAME", default="<your workspace name>")
workspace_region = os.getenv("WORKSPACE_REGION", default="<your workspace region>")

Access your workspace¶

The following cell uses the Azure ML SDK to attempt to load the workspace specified by your parameters. If this cell succeeds, you will be able to access the workspace from all notebooks using the Workspace.from_config() method. The cell can fail if the specified workspace doesn't exist or you don't have permissions to access it.

In [ ]:

from azureml.core import Workspace

try:
    ws = Workspace(subscription_id = subscription_id, resource_group = resource_group, workspace_name = workspace_name)
    # write the details of the workspace to a configuration file to the notebook library
    ws.write_config()
    print("Workspace configuration succeeded. Skip the workspace creation steps below")
except:
    print("Workspace not accessible. Change your parameters or create a new workspace below")

Create a new workspace¶

If you don't have an existing workspace and are the owner of the subscription or resource group, you can create a new workspace. If you don't have a resource group, the create workspace command will create one for you using the name you provide.

Note: As with other Azure services, there are limits on certain resources (for example AmlCompute quota) associated with the Azure ML service. Please read this article on the default limits and how to request more quota.

This cell will create an Azure ML workspace for you in a subscription provided you have the correct permissions.

This will fail if:

You do not have permission to create a workspace in the resource group
You do not have permission to create a resource group if it's non-existing.
You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription

If workspace creation fails, please work with your IT admin to provide you with the appropriate permissions or to provision the required resources.

In [ ]:

from azureml.core import Workspace

# Create the workspace using the specified parameters
ws = Workspace.create(name = workspace_name,
                      subscription_id = subscription_id,
                      resource_group = resource_group, 
                      location = workspace_region,
                      create_resource_group = True,
                      exist_ok = True)
ws.get_details()

# write the details of the workspace to a configuration file to the notebook library
ws.write_config()

Next steps¶

In this notebook you created or configured your Azure ML workspace. Next, please navigate to the hyperparameter_tuning notebook where you can run the hyper-parameter tuning for different scenarios in this tutorial.

In [ ]: