MLClient 類別
要與 Azure ML 服務互動的用戶端類別。
使用此用戶端來管理 Azure ML 資源,例如工作區、作業、模型等等。
- 繼承
-
builtins.objectMLClient
建構函式
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)
參數
指定是否要顯示長時間執行作業的進度列 (,例如,如果無法在互動式設定中使用此 SDK) ,客戶可能會考慮將此設定為 False。 預設值為 True。
指定是否要啟用遙測。 如果未在Jupyter Notebook中,則會覆寫為 False。 在 Jupyter Notebook 中,預設值為 True。
範例
使用主權網域 (亦即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 組態檔中:
然後,您可以使用此方法在不同的 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
參數
傳回
已建立或更新的資源。
傳回類型
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
參數
傳回
現有 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
components
compute
connections
data
datastores
environments
feature_sets
feature_store_entities
如需詳細資訊,aka.ms/azuremlexperimental。
功能存放區實體相關作業的集合。
傳回
FeatureStoreEntity 作業
傳回類型
feature_stores
jobs
models
online_deployments
online_endpoints
registries
resource_group_name
schedules
subscription_id
workspace_hubs
如需詳細資訊,aka.ms/azuremlexperimental。
工作區中樞相關作業的集合。
傳回
中樞作業
傳回類型
workspace_name
workspace_outbound_rules
workspaces
R
R = ~R
T
T = ~T