Workspace クラス

ワークスペースにプライベート エンドポイントを追加します。

add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, ___location=None, show_output=True, tags=None)

パラメーター

戻り値

新しい Azure Machine Learning ワークスペースを作成します。

ワークスペースが既に存在する場合、またはワークスペースの要件のいずれかが満たされていない場合は、例外をスローします。

static create(name, auth=None, subscription_id=None, resource_group=None, ___location=None, create_resource_group=True, sku='basic', tags=None, friendly_name=None, storage_account=None, key_vault=None, app_insights=None, container_registry=None, adb_workspace=None, primary_user_assigned_identity=None, cmk_keyvault=None, resource_cmk_uri=None, hbi_workspace=False, default_cpu_compute_target=None, default_gpu_compute_target=None, private_endpoint_config=None, private_endpoint_auto_approval=True, exist_ok=False, show_output=True, user_assigned_identity_for_cmk_encryption=None, system_datastores_auth_mode='accessKey', v1_legacy_mode=None)

パラメーター

戻り値

例外

注釈

この最初の例では、最小限の指定のみが必要であり、すべての依存リソースとリソース グループが自動的に作成されます。

   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=True,
                         ___location='eastus2')

次の例は、Azure リソース ID 形式を使用して既存の Azure リソースを再利用する方法を示しています。 特定の Azure リソース ID は、Azure Portal または SDK を使用して取得できます。 これは、リソース グループ、ストレージ アカウント、キー コンテナー、App Insights、コンテナー レジストリが既に存在することを前提としています。

   import os
   from azureml.core import Workspace
   from azureml.core.authentication import ServicePrincipalAuthentication

   service_principal_password = os.environ.get("AZUREML_PASSWORD")

   service_principal_auth = ServicePrincipalAuthentication(
       tenant_id="<tenant-id>",
       username="<application-id>",
       password=service_principal_password)

   ws = Workspace.create(name='myworkspace',
                         auth=service_principal_auth,
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=False,
                         ___location='eastus2',
                         friendly_name='My workspace',
                         storage_account='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.storage/storageaccounts/mystorageaccount',
                         key_vault='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault',
                         app_insights='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.insights/components/myappinsights',
                         container_registry='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.containerregistry/registries/mycontainerregistry',
                         exist_ok=False)

Azure Machine Learning ワークスペースに関連付けられているリソースを削除します。

delete(delete_dependent_resources=False, no_wait=False)

パラメーター

戻り値

ワークスペースの接続を削除します。

delete_connection(name)

パラメーター

ワークスペースへのプライベート エンドポイント接続を削除します。

delete_private_endpoint_connection(private_endpoint_connection_name)

パラメーター

ワークスペースのセットアップに関する問題を診断します。

diagnose_workspace(diagnose_parameters)

パラメーター

戻り値

既存の Azure Machine Learning ワークスペースからワークスペース オブジェクトを返します。

ファイルからワークスペース構成を読み取ります。 構成ファイルが見つからない場合は、例外をスローします。

このメソッドは、複数の Python ノートブックまたはプロジェクト間で同じワークスペースを再利用する簡単な方法を提供します。 ユーザーは、 write_config メソッドを使用してワークスペース Azure Resource Manager (ARM) プロパティを保存し、このメソッドを使用して、ワークスペース ARM プロパティを再入力せずに、異なる Python ノートブックまたはプロジェクトに同じワークスペースを読み込むことができます。

static from_config(path=None, auth=None, _logger=None, _file_name=None)

パラメーター

戻り値

既存の Azure Machine Learning ワークスペースのワークスペース オブジェクトを返します。

ワークスペースが存在しない場合、または必須フィールドがワークスペースを一意に識別しない場合は、例外をスローします。

static get(name, auth=None, subscription_id=None, resource_group=None, ___location=None, cloud='AzureCloud', id=None)

パラメーター

戻り値

ワークスペースの接続を取得します。

get_connection(name)

パラメーター

ワークスペースの既定のコンピューティング 先を取得します。

get_default_compute_target(type)

パラメーター

戻り値

ワークスペースの既定のデータストアを取得します。

get_default_datastore()

戻り値

ワークスペースの既定のキー コンテナー オブジェクトを取得します。

get_default_keyvault()

戻り値

ワークスペースの詳細を返します。

get_details()

戻り値

注釈

返されるディクショナリには、次のキーと値のペアが含まれています。

• id: サブスクリプション ID、リソース グループ、ワークスペース名を含む、このワークスペース リソースを指す URI。

• name: このワークスペースの名前。

• ___location: ワークスペースリージョン。

• type: "{providerName}/workspaces" という形式の URI。

• tags: 現在使用されていません。

• workspaceid: このワークスペースの ID。

• description: 現在使用されていません。

• friendlyName: UI に表示されるワークスペースのフレンドリ名。

• creationTime: このワークスペースが作成された時刻 (ISO8601形式)。

• containerRegistry: 実験イメージと Web サービス イメージの両方をプルおよびプッシュするために使用されるワークスペース コンテナー レジストリ。

• keyVault: ユーザーによってワークスペースに追加された資格情報を格納するために使用されるワークスペース キー コンテナー。

• applicationInsights: Application Insights は、Web サービス イベントをログに記録するためにワークスペースによって使用されます。

• identityPrincipalId:

• identityTenantId

• identityType

• storageAccount: ストレージは、実行出力、コード、ログなどを保存するためにワークスペースによって使用されます。

• sku: ワークスペース SKU (エディションとも呼ばれます)。 このパラメーターは下位互換性のために存在し、無視されます。

• resourceCmkUri: 保存データを暗号化するためのカスタマー マネージド キーのキー URI。 キーを作成してその URI を取得する方法については、 https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 を参照してください。

• hbiWorkspace: 顧客データがビジネスに大きく影響するかどうかを指定します。

• imageBuildCompute: イメージ ビルドのコンピューティング 先。

• systemDatastoresAuthMode: ワークスペース 'workspaceblobstore' および 'workspacefilestore' のシステム データストアに資格情報を使用するかどうかを決定します。 既定値は "accessKey" です。この場合、ワークスペースは資格情報を使用してシステム データストアを作成します。 "ID" に設定すると、ワークスペースは資格情報なしでシステム データストアを作成します。

これらのキーと値のペアの詳細については、 createを参照してください。

ワークスペースの MLflow 追跡 URI を取得します。

MLflow (https://mlflow.org/) は、機械学習の実験を追跡し、モデルを管理するためのオープンソース プラットフォームです。 Azure Machine Learning で MLflow ログ API を使用すると、メトリック、モデル、成果物を Azure Machine Learning ワークスペースに記録できます。

get_mlflow_tracking_uri(_with_auth=False)

パラメーター

戻り値

注釈

次のサンプルを使用して、Azure ML ワークスペースにデータを送信するように MLflow 追跡を構成します。

   import mlflow
   from azureml.core import Workspace
   workspace = Workspace.from_config()
   mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())

ワークスペース内の指定したrun_idで実行を返します。

get_run(run_id)

パラメーター

戻り値

ユーザーがサブスクリプション内でアクセスできるすべてのワークスペースを一覧表示します。

ワークスペースの一覧は、リソース グループに基づいてフィルター処理できます。

static list(subscription_id, auth=None, resource_group=None)

パラメーター

戻り値

このワークスペースの下に接続を一覧表示します。

list_connections(category=None, target=None)

パラメーター

現在のワークスペースのキーを一覧表示します。

list_keys()

戻り値

ワークスペースの下に接続を追加または更新します。

set_connection(name, category, target, authType, value)

パラメーター

ワークスペースの既定のデータストアを設定します。

set_default_datastore(name)

パラメーター

新しいワークスペースを作成するか、既存のワークスペースを取得します。

static setup()

戻り値

キーを直ちに同期するようにワークスペースをトリガーします。

ワークスペース内の任意のリソースのキーが変更された場合、自動的に更新されるまでに約 1 時間かかることがあります。 この関数を使用すると、要求に応じてキーを更新できます。 シナリオの例として、ストレージ キーを再生成した後にストレージにすぐにアクセスする必要があります。

sync_keys(no_wait=False)

パラメーター

戻り値

ワークスペースに関連付けられているフレンドリ名、説明、タグ、イメージ ビルド コンピューティング、およびその他の設定を更新します。

update(friendly_name=None, description=None, tags=None, image_build_compute=None, service_managed_resources_settings=None, primary_user_assigned_identity=None, allow_public_access_when_behind_vnet=None, v1_legacy_mode=None)

パラメーター

戻り値

次の場合は、ワークスペースに関連付けられている既存のリソースを更新します。

a) ユーザーが誤って既存の関連付けられているリソースを削除し、ワークスペース全体を再作成せずに新しいリソースで更新したい場合。 b) ユーザーに既存の関連付けられているリソースがあり、ワークスペースに関連付けられている現在のリソースを置き換える場合。 c) 関連付けられているリソースがまだ作成されておらず、既に存在する既存のリソースを使用する場合 (コンテナー レジストリにのみ適用されます)。

update_dependencies(container_registry=None, force=False)

パラメーター

戻り値

ワークスペースの Azure Resource Manager (ARM) プロパティを構成ファイルに書き込みます。

ワークスペース ARM プロパティは、後で from_config メソッドを使用して読み込むことができます。 pathは、現在の作業ディレクトリでは既定で '.azureml/' に設定され、file_nameの既定値は 'config.json' です。

このメソッドは、複数の Python ノートブックまたはプロジェクト間で同じワークスペースを再利用する簡単な方法を提供します。 ユーザーは、この関数を使用してワークスペース ARM プロパティを保存し、from_configを使用して、ワークスペース ARM プロパティを再入力することなく、異なる Python ノートブックまたはプロジェクトに同じワークスペースを読み込むことができます。

write_config(path=None, file_name=None)

パラメーター

ワークスペース内のすべてのコンピューティング 先を一覧表示します。

戻り値

ワークスペース内のすべてのデータセットを一覧表示します。

戻り値

ワークスペース内のすべてのデータストアを一覧表示します。 この操作では、データストアの資格情報は返されません。

戻り値

このワークスペースの検出 URL を返します。

戻り値

ワークスペース内のすべての環境を一覧表示します。

戻り値

ワークスペース内のすべての実験を一覧表示します。

戻り値

ワークスペース内のイメージの一覧を返します。

モデル管理サービスとの対話で問題が発生した場合に WebserviceException を発生させます。

戻り値

例外

ワークスペース内のすべてのリンクされたサービスを一覧表示します。

戻り値

このワークスペースの場所を返します。

戻り値

ワークスペース内のモデルの一覧を返します。

モデル管理サービスとの対話で問題が発生した場合に WebserviceException を発生させます。

戻り値

例外

ワークスペース名を返します。

戻り値

ワークスペースのすべてのプライベート エンドポイントを一覧表示します。

戻り値

このワークスペースのリソース グループ名を返します。

戻り値

このワークスペースのサービス コンテキストを返します。

戻り値

このワークスペースの SKU を返します。

戻り値

このワークスペースのサブスクリプション ID を返します。

戻り値

このワークスペースのタグを返します。

戻り値

ワークスペース内の Web サービスの一覧を返します。

リストを返す問題が発生した場合に WebserviceException を発生させます。

戻り値

例外

DEFAULT_CPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

DEFAULT_GPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'