Share via

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 订阅 ID。 仅适用于注册表资产的可选项。 默认值为“None”。

resource_group_name
Optional[str]
默认值: None

Azure 资源组。 仅适用于注册表资产的可选项。 默认值为“None”。

workspace_name
Optional[str]
默认值: None

在客户端中使用的工作区。 仅对不依赖于工作区的操作可选。 默认值为“None”。

registry_name
Optional[str]
默认值: None

在客户端中使用的注册表。 仅对不依赖于工作区的操作可选。 默认值为“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 机器学习工作区返回客户端。

此方法提供了一种在多个 Python 笔记本或项目中重复使用同一工作区的简单方法。 可以使用以下格式将工作区的 Azure 资源管理器 (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]
必需

要创建或更新的资源。

返回

创建/更新操作后的资源。

返回类型

LROPoller[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]
必需

要创建或更新的资源。

返回

创建或更新的资源。

返回类型

Union[Job, Model , Environment, Component, Datastore]

from_config

使用文件配置从现有 Azure 机器学习工作区返回客户端。

此方法提供了一种在多个 Python 笔记本或项目中重复使用同一工作区的简单方法。 可以使用以下格式将工作区的 Azure 资源管理器 (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]

路径为目录路径时要搜索的配置文件名称。 默认为“config.json”。

cloud
Optional[str]

要使用的云名称。 默认为“AzureCloud”。

返回

现有 Azure ML 工作区的客户端。

返回类型

MLClient

例外

ValidationException

如果在目录中找不到“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 部署操作。

返回类型

BatchDeploymentOperations

batch_endpoints

批处理终结点相关操作的集合。

返回

Batch 终结点操作

返回类型

BatchEndpointOperations

components

组件相关操作的集合。

返回

组件操作。

返回类型

ComponentOperations

compute

计算相关操作的集合。

返回

计算操作

返回类型

ComputeOperations

connections

工作区连接相关操作的集合。

返回

工作区连接操作

返回类型

WorkspaceConnectionsOperations

data

数据相关操作的集合。

返回

数据操作。

返回类型

DataOperations

datastores

数据存储相关操作的集合。

返回

数据存储操作。

返回类型

DatastoreOperations

environments

环境相关操作的集合。

返回

环境操作。

返回类型

EnvironmentOperations

feature_sets

有关详细信息，aka.ms/azuremlexperimental。

功能集相关操作的集合。

返回

FeatureSet 操作

返回类型

FeatureSetOperations

feature_store_entities

有关详细信息，aka.ms/azuremlexperimental。

功能存储实体相关操作的集合。

返回

FeatureStoreEntity 操作

返回类型

FeatureStoreEntityOperations

feature_stores

有关详细信息，aka.ms/azuremlexperimental。

功能存储相关操作的集合。

返回

FeatureStore 操作

返回类型

FeatureStoreOperations

jobs

与作业相关的操作的集合。

返回

作业操作

返回类型

JobOperations

models

模型相关操作的集合。

返回

模型操作

返回类型

ModelOperations

online_deployments

联机部署相关操作的集合。

返回

联机部署操作

返回类型

OnlineDeploymentOperations

online_endpoints

联机终结点相关操作的集合。

返回

联机终结点操作

返回类型

OnlineEndpointOperations

registries

有关详细信息，aka.ms/azuremlexperimental。

与注册表相关的操作的集合。

返回

注册表操作

返回类型

RegistryOperations

resource_group_name

获取 MLClient 对象的资源组名称。

返回

Azure 资源组名称。

返回类型

str

schedules

计划相关操作的集合。

返回

计划操作。

返回类型

ScheduleOperations

subscription_id

获取 MLClient 对象的订阅 ID。

返回

Azure 订阅 ID。

返回类型

str

workspace_hubs

有关详细信息，aka.ms/azuremlexperimental。

工作区中心相关操作的集合。

返回

中心操作

返回类型

<xref:HubOperations>

workspace_name

将执行工作区相关操作的工作区的名称。

返回

默认工作区的名称。

返回类型

Optional[str]

workspace_outbound_rules

工作区出站规则相关操作的集合。

返回

工作区出站规则操作

返回类型

WorkspaceOutboundRuleOperations

workspaces

与工作区相关的操作的集合。

返回

工作区操作

返回类型

WorkspaceOperations

R 

R = ~R

T 

T = ~T