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: Web サービス イベントをログに記録するためにワークスペースで使用される Application Insights。

• 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' です。この値を使用すると、ワークスペースで資格情報を使用してシステム データストアが作成されます。 'identity' に設定すると、ワークスペースで資格情報を使用せずにシステム データストアが作成されます。

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

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

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

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'