MLClient 類別

要與 Azure ML 服務互動的用戶端類別。

使用此用戶端來管理 Azure ML 資源,例如工作區、作業、模型等等。

繼承
builtins.object
MLClient

建構函式

MLClient(credential: TokenCredential, subscription_id: str | None = None, resource_group_name: str | None = None, workspace_name: str | None = None, registry_name: str | None = None, **kwargs: Any)

參數

credential
TokenCredential
必要

要用於驗證的認證。

subscription_id
Optional[str]
預設值: None

Azure 訂用帳戶識別碼。 僅限登錄資產的選擇性。 預設值為 [無]。

resource_group_name
Optional[str]
預設值: None

Azure 資源群組。 僅限登錄資產的選擇性。 預設值為 [無]。

workspace_name
Optional[str]
預設值: None

要用於用戶端的工作區。 僅適用于不相依工作區的作業。 預設值為 [無]。

registry_name
Optional[str]
預設值: None

要用於用戶端的登錄。 僅適用于不相依工作區的作業。 預設值為 [無]。

show_progress
Optional[bool]

指定是否要顯示長時間執行作業的進度列 (,例如,如果無法在互動式設定中使用此 SDK) ,客戶可能會考慮將此設定為 False。 預設值為 True。

enable_telemetry
Optional[bool]

指定是否要啟用遙測。 如果未在Jupyter Notebook中,則會覆寫為 False。 在 Jupyter Notebook 中,預設值為 True。

cloud
Optional[str]

要使用的雲端名稱。 預設為 「AzureCloud」。

範例

使用主權網域 (亦即AZURE_PUBLIC_CLOUD) 以外的任何雲端時,您必須在 kwargs 中傳入雲端名稱,而且必須使用具有 DefaultAzureCredential 的授權單位。


   from azure.ai.ml import MLClient
   from azure.identity import AzureAuthorityHosts, DefaultAzureCredential

   kwargs = {"cloud": "AzureChinaCloud"}
   ml_client = MLClient(
       subscription_id=subscription_id,
       resource_group_name=resource_group,
       credential=DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_CHINA),
       **kwargs,
   )

方法

begin_create_or_update

以非同步方式建立或更新 Azure ML 資源。

create_or_update

建立或更新 Azure ML 資源。

from_config

使用檔案組態從現有的 Azure Machine Learning 工作區傳回用戶端。

這個方法提供一個簡單的方法,可在多個 Python 筆記本或專案中重複使用相同的工作區。 您可以使用下列格式,將工作區的 Azure Resource Manager (ARM) 屬性儲存在 JSON 組態檔中:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

然後,您可以使用此方法在不同的 Python 筆記本或專案中載入相同的工作區,而不需重新系結工作區 ARM 屬性。

begin_create_or_update

以非同步方式建立或更新 Azure ML 資源。

begin_create_or_update(entity: R, **kwargs) -> LROPoller[R]

參數

entity
Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]
必要

要建立或更新的資源。

傳回

建立/更新作業之後的資源。

傳回類型

create_or_update

建立或更新 Azure ML 資源。

create_or_update(entity: T, **kwargs) -> T

參數

entity
Union[Job , Model, Environment, Component , Datastore]
必要

要建立或更新的資源。

傳回

已建立或更新的資源。

傳回類型

from_config

使用檔案組態從現有的 Azure Machine Learning 工作區傳回用戶端。

這個方法提供一個簡單的方法,可在多個 Python 筆記本或專案中重複使用相同的工作區。 您可以使用下列格式,將工作區的 Azure Resource Manager (ARM) 屬性儲存在 JSON 組態檔中:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

然後,您可以使用此方法在不同的 Python 筆記本或專案中載入相同的工作區,而不需重新系結工作區 ARM 屬性。

from_config(credential: TokenCredential, *, path: PathLike | str | None = None, file_name=None, **kwargs) -> MLClient

參數

credential
TokenCredential
必要

工作區的認證物件。

path
Optional[Union[PathLike, str]]

組態檔的路徑,或要在其中搜尋組態檔的起始目錄。 預設值為 [無],表示將使用目前的目錄。

file_name
Optional[str]

當 path 是目錄路徑時要搜尋的組態檔名稱。 預設為 「config.json」。

cloud
Optional[str]

要使用的雲端名稱。 預設為 「AzureCloud」。

傳回

現有 Azure ML 工作區的用戶端。

傳回類型

例外狀況

如果在目錄中找不到 「config.json」 或 file_name,則引發 。 錯誤訊息中將會提供詳細資料。

範例

從目錄 「src」 中名為 「config.json」 的檔案建立 MLClient。


   from azure.ai.ml import MLClient

   client = MLClient.from_config(credential=DefaultAzureCredential(), path="./sdk/ml/azure-ai-ml/samples/src")

從目前目錄中名為 「team_workspace_configuration.json」 的檔案建立 MLClient。


   from azure.ai.ml import MLClient

   client = MLClient.from_config(
       credential=DefaultAzureCredential(),
       file_name="./sdk/ml/azure-ai-ml/samples/team_workspace_configuration.json",
   )

屬性

batch_deployments

批次部署相關作業的集合。

傳回

批次部署作業。

傳回類型

batch_endpoints

批次端點相關作業的集合。

傳回

Batch 端點作業

傳回類型

components

元件相關作業的集合。

傳回

元件作業。

傳回類型

compute

計算相關作業的集合。

傳回

計算作業

傳回類型

connections

工作區連線相關作業的集合。

傳回

工作區連線作業

傳回類型

data

資料相關作業的集合。

傳回

資料作業。

傳回類型

datastores

資料存放區相關作業的集合。

傳回

資料存放區作業。

傳回類型

environments

環境相關作業的集合。

傳回

環境作業。

傳回類型

feature_sets

如需詳細資訊,aka.ms/azuremlexperimental。

功能集相關作業的集合。

傳回

FeatureSet 作業

傳回類型

feature_store_entities

如需詳細資訊,aka.ms/azuremlexperimental。

功能存放區實體相關作業的集合。

傳回

FeatureStoreEntity 作業

傳回類型

feature_stores

如需詳細資訊,aka.ms/azuremlexperimental。

功能存放區相關作業的集合。

傳回

FeatureStore 作業

傳回類型

jobs

作業相關作業的集合。

傳回

工作的作業

傳回類型

models

模型相關作業的集合。

傳回

模型作業

傳回類型

online_deployments

線上部署相關作業的集合。

傳回

線上部署作業

傳回類型

online_endpoints

線上端點相關作業的集合。

傳回

線上端點作業

傳回類型

registries

如需詳細資訊,aka.ms/azuremlexperimental。

登錄相關作業的集合。

傳回

登錄作業

傳回類型

resource_group_name

取得 MLClient 物件的資源組名。

傳回

Azure 資源組名。

傳回類型

str

schedules

排程相關作業的集合。

傳回

排程作業。

傳回類型

subscription_id

取得 MLClient 物件的訂用帳戶識別碼。

傳回

Azure 訂用帳戶識別碼。

傳回類型

str

workspace_hubs

如需詳細資訊,aka.ms/azuremlexperimental。

工作區中樞相關作業的集合。

傳回

中樞作業

傳回類型

<xref:HubOperations>

workspace_name

將執行工作區相依作業的工作區名稱。

傳回

預設工作區的名稱。

傳回類型

workspace_outbound_rules

工作區輸出規則相關作業的集合。

傳回

工作區輸出規則作業

傳回類型

workspaces

工作區相關作業的集合。

傳回

工作區作業

傳回類型

R

R = ~R

T

T = ~T