ポータルまたは Python SDK を使用して Azure Machine Learning ワークスペースを管理する

適用対象: Python SDK azure-ai-ml v2 (プレビュー)

この記事では、Azure portal または Python 用 SDK を使用して、Azure Machine Learning 用の Azure Machine Learning ワークスペースを作成、表示、削除します

ニーズに変化が生じたり自動化の要件が増えたりしたときに、CLI または VS Code 拡張機能を使用して、ワークスペースを管理することもできます。

前提条件

  • Azure サブスクリプション。 Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。 無料版または有料版の Azure Machine Learning を今すぐお試しください。
  • Python SDK を使用している場合:
    1. SDK v2 をインストールします

    2. サブスクリプションの詳細の指定

      # Enter details of your subscription
      subscription_id = "<SUBSCRIPTION_ID>"
      resource_group = "<RESOURCE_GROUP>"
    3. サブスクリプションへのハンドルを取得します。 ml_client は、この記事のすべての Python コードで使用されます。

      # get a handle to the subscription
      
      from azure.ai.ml import MLClient
      from azure.identity import DefaultAzureCredential
      
      ml_client = MLClient(DefaultAzureCredential(), subscription_id, resource_group)
      • 複数のアカウントがある場合は、使用する Azure Active Directory のテナント ID を追加します。 Azure portal で、 [Azure Active Directory]、[外部 ID] からテナント ID を見つけます。

        DefaultAzureCredential(interactive_browser_tenant_id="<TENANT_ID>")
        
      • (省略可能) ソブリン クラウドで作業している場合**、認証に使用するソブリン クラウドを DefaultAzureCredential指定します。

        from azure.identity import AzureAuthorityHosts
        DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_GOVERNMENT))
        

制限事項

  • 新しいワークスペースを作成する場合は、ワークスペースに必要なサービスを自動的に作成するか、既存のサービスを使用することができます。 ワークスペースとは異なる Azure サブスクリプション の既存のサービスを使用する場合は、それらのサービスを含むサブスクリプションに Azure Machine Learning 名前空間を登録する必要があります。 たとえば、サブスクリプション B のストレージ アカウントを使用するサブスクリプション A でワークスペースを作成する場合、ワークスペースでストレージ アカウントを使用するには、Azure Machine Learning 名前空間がサブスクリプション B に登録されている必要があります。

    Azure Machine Learning のリソース プロバイダーは、Microsoft.MachineLearningServices です。 登録されているかどうかを確認する方法や、登録方法については、記事「Azure リソース プロバイダーと種類」を参照してください。

    重要

    これは、ワークスペースの作成時に提供されるリソースである、Azure Storage アカウント、Azure Container Register、Azure Key Vault、Application Insights にのみ適用されます。

  • 既定では、ワークスペースを作成すると Azure Container Registry (ACR) も作成されます。 現在、ACR ではリソース グループ名での Unicode 文字がサポートされていないため、これらの文字が含まれていないリソース グループを使用します。

  • Azure Machine Learning では、ワークスペースの既定のストレージ アカウントの階層型名前空間 (Azure Data Lake Storage Gen2 機能) はサポートされていません。

ヒント

Azure Application Insights インスタンスは、ワークスペースの作成時に作成されます。 必要に応じて、クラスターの作成後に Application Insights インスタンスを削除できます。 それを削除すると、ワークスペースから収集される情報が限定され、問題のトラブルシューティングが困難になる可能性があります。 ワークスペースによって作成された Application Insights インスタンスを削除した場合、ワークスペースを削除して再作成することなく、それを再作成することはできません。

この Application Insights インスタンスの使用方法の詳細については、「Machine Learning Web サービス エンドポイントからのデータの監視と収集」を参照してください。

ワークスペースの作成

ワークスペースは、Azure Machine Learning スタジオで直接作成できますが、使用できるオプションは制限されています。 または、オプションをより細かく制御するために以下のいずれかの方法を使用します。

適用対象: Python SDK azure-ai-ml v2 (プレビュー)

  • 既定の仕様。 既定では、依存するリソースとリソース グループが自動的に作成されます。 このコードでは、myworkspace という名前のワークスペースと myresourcegroup という名前のリソース グループが eastus2 に作成されます。

    # Creating a unique workspace name with current datetime to avoid conflicts
    from azure.ai.ml.entities import Workspace
    import datetime
    
    basic_workspace_name = "mlw-basic-prod-" + datetime.datetime.now().strftime(
        "%Y%m%d%H%M"
    )
    
    ws_basic = Workspace(
        name=basic_workspace_name,
        location="eastus",
        display_name="Basic workspace-example",
        description="This example shows how to create a basic workspace",
        hbi_workspace=False,
        tags=dict(purpose="demo"),
    )
    ml_client.workspaces.begin_create(ws_basic)
  • 既存の Azure リソースを使用する。 既存の Azure リソースを Azure リソース ID 形式で使用するワークスペースを作成することもできます。 Azure portal または SDK を使用して、特定の Azure リソース ID を見つけます。 この例では、リソース グループ、ストレージ アカウント、キー コンテナー、App Insights、コンテナー レジストリが既に存在していることを前提としています。

    # Creating a unique workspace name with current datetime to avoid conflicts
    import datetime
    from azure.ai.ml.entities import Workspace
    
    basic_ex_workspace_name = "mlw-basicex-prod-" + datetime.datetime.now().strftime(
        "%Y%m%d%H%M"
    )
    
    ws_with_existing = Workspace(
        name=basic_ex_workspace_name,
        location="eastus",
        display_name="Bring your own dependent resources-example",
        description="This sample specifies a workspace configuration with existing dependent resources",
        storage_account="/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.Storage/storageAccounts/<STORAGE_ACCOUNT>",
        container_registry="/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.ContainerRegistry/registries/<CONTAINER_REGISTRY>",
        key_vault="/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.KeyVault/vaults/<KEY_VAULT>",
        application_insights="/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.insights/components/<APP_INSIGHTS>",
        tags=dict(purpose="demonstration"),
    )
    
    # uncomment this line after providing details of subscription, resource group and other details above
    #  ml_client.begin_create_or_update(ws_with_existing)

詳細については、ワークスペース SDK リファレンスを参照してください。

サブスクリプションへのアクセスで問題が発生した場合は、Azure Machine Learning のリソースとワークフローのための認証の設定に関する記事と「Azure Machine Learning での認証」ノートブックを参照してください。

ネットワーク

重要

お使いのワークスペースでのプライベート エンドポイントと仮想ネットワークの使用の詳細については、ネットワークの分離とプライバシーに関する記事を参照してください。

適用対象: Python SDK azure-ai-ml v2 (プレビュー)

# Creating a unique workspace name with current datetime to avoid conflicts
import datetime
from azure.ai.ml.entities import Workspace

basic_private_link_workspace_name = (
    "mlw-privatelink-prod-" + datetime.datetime.now().strftime("%Y%m%d%H%M")
)

ws_private_link = Workspace(
    name=basic_private_link_workspace_name,
    location="eastus",
    display_name="Private Link endpoint workspace-example",
    description="When using private link, you must set the image_build_compute property to a cluster name to use for Docker image environment building. You can also specify whether the workspace should be accessible over the internet.",
    image_build_compute="cpu-compute",
    public_network_access="Disabled",
    tags=dict(purpose="demonstration"),
)

ml_client.workspaces.begin_create(ws_private_link)

このクラスには、既存の仮想ネットワークが必要です。

詳細設定

ワークスペースのメタデータは、既定で Microsoft が管理する Azure Cosmos DB インスタンスに格納されます。 このデータは Microsoft のマネージド キーで暗号化されます。

Microsoft がお使いのワークスペースで収集するデータを制限するには、ポータルで [High business impact workspace](業務への影響が大きいワークスペース) を選択するか、Python で hbi_workspace=true を設定します。 この設定の詳細については、「保存時の暗号化」を参照してください。

重要

業務への影響が大きいは、ワークスペースの作成時にのみ選択できます。 ワークスペースの作成後にこの設定を変更することはできません。

独自のデータ暗号化キーを使用する

データ暗号化用の独自のキーを用意できます。 これを行うと、自分の Azure サブスクリプションにメタデータを格納する Azure Cosmos DB インスタンスが作成されます。 詳細については、カスタマー マネージド キーに関するセクションを参照してください。

独自のキーを用意するには、次の手順を実行します。

重要

これらの手順を実行する前に、まず次のアクションを実行する必要があります。

カスタマー マネージド キーの構成に関する記事の手順に従って以下を行います。

  • Azure Cosmos DB プロバイダーを登録する
  • Azure Key Vault を作成して構成する
  • キーを生成する

適用対象: Python SDK azure-ai-ml v2 (プレビュー)


from azure.ai.ml.entities import Workspace, CustomerManagedKey

# specify the workspace details
ws = Workspace(
    name="my_workspace",
    location="eastus",
    display_name="My workspace",
    description="This example shows how to create a workspace",
    customer_managed_key=CustomerManagedKey(
        key_vault="/subscriptions/<SUBSCRIPTION_ID>/resourcegroups/<RESOURCE_GROUP>/providers/microsoft.keyvault/vaults/<VAULT_NAME>"
        key_uri="<KEY-IDENTIFIER>"
    )
    tags=dict(purpose="demo")
)

ml_client.workspaces.begin_create(ws)

構成ファイルをダウンロードする

コンピューティング インスタンスでコードを実行する場合は、この手順をスキップします。 コンピューティング インスタンスは、このファイルのコピーを作成して格納します。

このワークスペース () を参照するローカル環境でコードを使用する場合は、構成ファイルを記述します。

  1. Azure Studio でワークスペースを選択する

  2. 右上でワークスペース名を選択し、[config.json のダウンロード] を選択します。

    config.json をダウンロードする

このファイルは、Python スクリプトまたは Jupyter Notebook を含むディレクトリ構造内に置きます。 それは、同じディレクトリ内、 .azureml という名前のサブディレクトリ内、または親ディレクトリ内に置くことができます。 コンピューティング インスタンスを作成するとき、このファイルは VM 上の正しいディレクトリに自動的に追加されます。

ワークスペースに接続する

SDK を使用して機械学習タスクを実行する場合は、ワークスペースへの接続を指定する MLClient オブジェクトが必要です。 オブジェクトは MLClient 、パラメーターから作成することも、構成ファイルを使用して作成することもできます。

適用対象:Python SDK azureml v1

  • このコードにより、構成ファイルの内容が読み取られ、ワークスペースが検索されます。 まだ認証されていない場合は、サインインを求めるメッセージが表示されます。

    from azure.ai.ml import MLClient
    
    # read the config from the current directory
    ws_from_config = MLClient.from_config()
    
  • パラメーターから: この方法を使用する場合は、config.json ファイルを使用する必要はありません。

    from azure.ai.ml import MLClient
    from azure.ai.ml.entities import Workspace
    from azure.identity import DefaultAzureCredential
    
    # uncomment this line after providing details of subscription, resource group and workspace name
    # ws = MLClient(DefaultAzureCredential(), subscription_id='<SUBSCRIPTION_ID>', resource_group_name='<RESOURCE_GROUP>', workspace_name='<AML_WORKSPACE_NAME>')

サブスクリプションへのアクセスで問題が発生した場合は、Azure Machine Learning のリソースとワークフローのための認証の設定に関する記事と「Azure Machine Learning での認証」ノートブックを参照してください。

ワークスペースの検索

使用できるすべてのワークスペースの一覧を表示します。
スタジオ内でワークスペースを検索することもできます。 Azure Machine Learning の資産を検索する (プレビュー)

適用対象: Python SDK azure-ai-ml v2 (プレビュー)

from azure.ai.ml import MLClient
from azure.ai.ml.entities import Workspace
from azure.identity import DefaultAzureCredential

# Enter details of your subscription
subscription_id = "<SUBSCRIPTION_ID>"
resource_group = "<RESOURCE_GROUP>"

my_ml_client = MLClient(DefaultAzureCredential(), subscription_id, resource_group)
for ws in my_ml_client.workspaces.list():
    print(ws.name, ":", ws.location, ":", ws.description)

特定のワークスペースの詳細を取得するには:

ws = my_ml_client.workspaces.get("<AML_WORKSPACE_NAME>")
# uncomment this line after providing a workspace name above
# print(ws.location,":", ws.resource_group)

ワークスペースを削除する

ワークスペースが不要になったら、削除します。

警告

Azure Machine Learning ワークスペースはいったん削除されると、元に戻せません。

ワークスペースを誤って削除した場合も、ノートブックを引き続き取得することができる可能性があります。 詳細については、「事業継続とディザスター リカバリーのためのフェールオーバー」を参照してください。

適用対象: Python SDK azure-ai-ml v2 (プレビュー)

ml_client.workspaces.begin_delete(name=ws_basic.name, delete_dependent_resources=True)

既定のアクションによって、ワークスペースに関連付けられているリソース (コンテナー レジストリ、ストレージ アカウント、キー コンテナー、Application Insights) が削除されることはありません。 これらのリソースも削除するには、delete_dependent_resources を True に設定します。

リソースをクリーンアップする

重要

作成したリソースは、Azure Machine Learning に関連したその他のチュートリアルおよびハウツー記事の前提条件として使用できます。

作成したどのリソースも今後使用する予定がない場合は、課金が発生しないように削除します。

  1. Azure Portal で、左端にある [リソース グループ] を選択します。

  2. 一覧から、作成したリソース グループを選択します。

  3. [リソース グループの削除] を選択します。

    Azure portal でリソース グループの削除を選択する画面のスクリーンショット。

  4. リソース グループ名を入力します。 次に、 [削除] を選択します。

トラブルシューティング

  • Azure Machine Learning スタジオでサポートされているブラウザー:オペレーティング システムと互換性のある最新ブラウザーを使うことをお勧めします。 次のブラウザーがサポートされています。

    • Microsoft Edge (新しい Microsoft Edge、最新バージョン。レガシ Microsoft Edge ではない)
    • Safari (最新バージョン、Mac のみ)
    • Chrome (最新バージョン)
    • Firefox (最新バージョン)
  • Azure ポータル:

    • SDK または Azure portal で共有リンクからワークスペースに直接移動する場合、拡張機能のサブスクリプション情報を含む標準の [概要] ページは表示できません。 このシナリオでは、別のワークスペースに切り替えることもできません。 別のワークスペースを表示するには、Azure Machine Learning Studio に直接移動し、そのワークスペース名を検索します。
    • すべての資産 (データ、実験、コンピューティングなど) は、Azure Machine Learning スタジオでのみ使用できます。 Azure portal から使用することは "できません"。
    • Azure portal からワークスペースのテンプレートをエクスポートしようとすると、次のテキストのようなエラーが返されることがあります。Could not get resource of the type <type>. Resources of this type will not be exported.回避策として、https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.machinelearningservices に用意されているテンプレートの 1 つをテンプレートのベースとして使用します。

ワークスペース診断

Azure Machine Learning スタジオまたは Python SDK から、ワークスペースの診断を実行することができます。 診断の実行後、検出された問題の一覧が返されます。 この一覧には、考えられる解決策へのリンクが含まれています。 詳細については、「ワークスペース診断の使用方法」を参照してください。

リソース プロバイダーのエラー

Azure Machine Learning ワークスペース (またはワークスペースで使用されるリソース) を作成しようとすると、次のメッセージに似たエラーが表示されることがあります。

  • No registered resource provider found for location {location}
  • The subscription is not registered to use namespace {resource-provider-namespace}

ほとんどのリソースプロバイダーは自動的に登録されますが、すべてではありません。 このメッセージが表示された場合は、言及されているプロバイダーを登録する必要があります。

次の表に、Azure Machine Learning で必要なリソース プロバイダーの一覧を示します。

リソース プロバイダー 必要な理由
Microsoft.MachineLearningServices Azure Machine Learning ワークスペースの作成。
Microsoft.Storage Azure Storage アカウントは、ワークスペースの既定のストレージとして使用されます。
Microsoft.ContainerRegistry Azure Container Registry は、Docker イメージを構築するためにワークスペースによって使用されます。
Microsoft.KeyVault Azure Key Vault は、シークレットを格納するためにワークスペースによって使用されます。
Microsoft.Notebooks/NotebookProxies Azure Machine Learning コンピューティング インスタンス上の統合されたノートブック。
Microsoft.ContainerService トレーニング済みのモデルを Azure Kubernetes Service にデプロイすることを計画している場合。

Azure Machine Learning でカスタマー マネージド キーを使用することを計画している場合は、以下のサービス プロバイダーを登録する必要があります。

リソース プロバイダー 必要な理由
Microsoft.DocumentDB/databaseAccounts ワークスペースのメタデータをログに記録する Azure CosmosDB インスタンス。
Microsoft.Search/searchServices Azure Search では、ワークスペースのインデックス作成機能を提供します。

リソースプロバイダーの登録については、「リソースプロバイダー登録エラーの解決」を参照してください。

Azure Container Registry の削除

Azure Machine Learning ワークスペースでは、一部の操作に対して Azure Container Registry (ACR) が使用されます。 これにより ACR インスタンスは、最初に必要になったときに自動的に作成されます。

警告

いったん、Azure Container Registry をワークスペースに対して作成したら、削除しないでください。 それを行うと、Azure Machine Learning ワークスペースが破損します。

この記事の例は workspace.ipynb に由来します。

次のステップ

ワークスペースを作成したら、モデルをトレーニングしてデプロイする方法を確認します。

組織の要件に合わせてワークスペースを計画する方法の詳細については、Azure Machine Learning の整理とセットアップに関するページを参照してください。

最新のセキュリティ更新プログラムを使用して Azure ML を最新の状態に保つ方法については、脆弱性の管理に関する記事を参照してください。