你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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 机器学习工作区返回客户端。 此方法提供了一种在多个 Python 笔记本或项目中重复使用同一工作区的简单方法。 可以使用以下格式将工作区的 Azure 资源管理器 (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 机器学习工作区返回客户端。
此方法提供了一种在多个 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
参数
返回
现有 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