core 包

包含 Azure 机器学习的核心包、模块和类。

主要方面包括管理计算目标、创建/管理工作区和试验,以及提交/访问模型运行和运行输出/日志记录。

compute

此包包含用于管理 Azure 机器学习中的计算目标的类。

若要详细了解如何选择用于训练和部署的计算目标,请参阅什么是 Azure 机器学习中的计算目标?

image

包含用于在 Azure 机器学习中管理作为 Web 服务终结点部署的映像的功能。

此类已弃用。 请改用 Environment 类。

映像用于将 Model、脚本和关联文件部署为 Web 服务终结点或 IoT Edge 设备。 终结点处理传入的评分请求并返回预测。 此包的关键类是 Image 类、Azure 机器学习映像的父类、Docker 映像的派生 ContainerImage 类以及 FPGA 等预览映像。

除非有一个特别需要使用映像的工作流,否则应该改用 Environment 类来定义映像。 然后,可以将 Environment 对象与方法结合使用Modeldeploy(),将模型部署为 Web 服务。 还可以使用模型 package() 方法创建一个可以作为映像或 Dockerfile 下载到本地 Docker 安装的映像。

有关使用 Model 类的信息,请参阅使用 Azure 机器学习部署模型

有关使用自定义映像的信息,请参阅使用自定义 Docker 基础映像部署模型

webservice

包含用于在 Azure 机器学习中将机器学习模型部署为 Web 服务终结点的功能。

将 Azure 机器学习模型部署为 Web 服务的操作会创建终结点和 REST API。 可将数据发送到此 API,并接收模型返回的预测。

ModelImage 部署到 Azure 容器实例(aci 模块)、Azure Kubernetes 服务(aks 模块),以及 Azure Kubernetes 终结点 (AksEndpoint) 或现场可编程门阵列 (FPGA) 时,将会创建 Web 服务。 对于大多数用例,建议使用模型进行部署,而对于高级用例,建议使用映像进行部署。 此模块中的类支持这两类部署。

模块

authentication

包含用于在 Azure 机器学习中管理不同类型的身份验证的功能。

支持的身份验证类型:

  • 交互式登录 - 使用 Azure 机器学习 SDK 时的默认模式。 使用交互式对话。
  • Azure CLI - 与 azure-cli 包配合使用。
  • 服务主体 - 与自动化机器学习工作流配合使用。
  • MSI - 与启用了托管服务标识的资产(例如 Azure 虚拟机)配合使用。
  • Azure ML 令牌 - 仅用于为提交的运行获取 Azure ML 令牌。

若要详细了解这些身份验证机制,请参阅 https://aka.ms/aml-notebook-auth

compute_target

包含非 Azure 机器学习管理的计算目标的功能。

计算目标定义了训练计算环境,可以是本地资源,也可以是云中的远程资源。 远程资源允许利用加速的 CPU 和 GPU 处理功能轻松纵向或横向扩展机器学习试验。

有关由 Azure 机器学习管理的计算目标的信息,请参阅 ComputeTarget 类。 有关详细信息,请参阅什么是 Azure 机器学习中的计算目标?

conda_dependencies

包含用于管理 conda 环境依赖项的功能。

使用 CondaDependencies 类加载现有的 conda 环境文件,并配置和管理执行试验的新环境。

container_registry

包含用于管理 Azure 容器注册表的功能。

databricks

包含用于在 Azure 机器学习中管理 Databricks 环境的功能。

有关在 Azure 机器学习中使用 Databricks 的详细信息,请参阅为 Azure 机器学习配置开发环境

dataset

管理与 Azure 机器学习数据集的交互。

本模块提供了在 Azure 机器学习中使用原始数据、管理数据,以及对数据执行操作的功能。 使用此模块中的 Dataset 类创建数据集和 data 包中的功能,其中包含支持类 FileDatasetTabularDataset

若要开始使用数据集,请参阅“添加和注册数据集”一文

datastore

包含用于管理 Azure 机器学习中数据存储的功能。

environment

包含用于在 Azure 机器学习中创建和管理可重现环境的功能。

环境提供了一种用于管理软件依赖项的方法,以便在本地云和分布式云开发环境之间移动时,只需最少的手动配置即可重现受控环境。 环境可封装 Python 包、环境变量、用于训练和评分脚本的软件设置,以及 Python、Spark 或 Docker 上的运行时间。 若要详细了解如何使用 Azure 机器学习将环境用于训练和部署,请参阅创建和管理可重用环境

experiment

包含用于在 Azure 机器学习中提交试验和管理试验历史记录的功能。

keyvault

包含用于管理与 Azure 机器学习工作区关联的密钥保管库中的机密的功能。

此模块包含一些便捷方法,用于从与工作区关联的 Azure 密钥保管库添加、检索、删除和列出机密。

linked_service

包含用于在 AML 工作区中创建和管理链接服务的功能。

model

包含用于在 Azure 机器学习中管理机器学习模型的功能。

可以使用 Model 类完成以下主要任务:

  • 使用工作区注册模型
  • 分析模型以了解部署要求
  • 将模型打包以与 Docker 一起使用
  • 将模型作为 Web 服务部署到推理终结点

有关如何使用模型的详细信息,请参阅 Azure 机器学习的工作原理:体系结构和概念

private_endpoint

包含用于定义和配置 Azure 专用终结点的功能。

profile

包含 Azure 机器学习中的分析模型的功能。

resource_configuration

包含用于管理 Azure 机器学习实体的资源配置的功能。

run

包含用于管理 Azure 机器学习中的试验指标和项目的功能。

runconfig

包含用于管理 Azure 机器学习中试验运行的配置的功能。

此模块中的键类是 RunConfiguration,它封装了在指定的计算目标上提交训练运行所需的信息。 该配置包括一组广泛的行为定义,例如,是使用现有 Python 环境还是使用根据规范构建的 Conda 环境。

该模块中的其他配置类可通过 RunConfiguration 来访问。

script_run

包含用于管理 Azure 机器学习中提交的训练运行的功能。

script_run_config

包含用于管理在 Azure 机器学习中提交训练运行的配置的功能。

util

包含用于指定日志记录详细信息级别的类。

workspace

包含用于管理工作区(Azure 机器学习中的顶级资源)的功能。

此模块包含 Workspace 类及其方法和属性,从而允许管理机器学习项目(如计算目标、环境、数据存储、试验和模型)。 工作区与 Azure 订阅和资源组绑定,是计费的主要方式。 工作区支持 Azure 资源管理器基于角色的访问控制 (RBAC) 和工作区内保存的所有机器学习数据的区域相关性。

ComputeTarget

Azure 机器学习管理的所有计算目标的抽象父类。

计算目标是指定的计算资源/环境,可在其中运行训练脚本或托管服务部署。 此位置可以是你的本地计算机,也可以是基于云的计算资源。 有关详细信息,请参阅什么是 Azure 机器学习中的计算目标?

类 ComputeTarget 构造函数。

检索与提供的工作区关联的计算对象的云表示形式。 返回与检索的计算对象的特定类型对应的子类的实例。

ContainerRegistry

定义与 Azure 容器注册表的连接。

类 ContainerRegistry 构造函数。

Dataset

表示在 Azure 机器学习中用于探索、转换和管理数据的资源。

数据集是对 Datastore 中或公共 Web URL 后面的数据的引用。

对于此类中已弃用的方法,请查看 AbstractDataset 类以获取改进的 API。

支持以下数据集类型:

  • TabularDataset 表示表格格式的、通过分析提供的文件或文件列表所创建的数据。

  • FileDataset 引用数据存储或公共 URL 中的单个或多个文件。

若要开始使用数据集,请参阅“添加和注册数据集”一文,或查看笔记本https://aka.ms/tabulardataset-samplenotebookhttps://aka.ms/filedataset-samplenotebook笔记本。

初始化 Dataset 对象。

若要获取已在工作区中注册的数据集,请使用 get 方法。

Datastore

表示通过 Azure 机器学习存储帐户的存储抽象。

数据存储附加到工作区,用于存储到 Azure 存储服务的连接信息,以便可以按名称引用它们,并且无需记住用于连接到存储服务的连接信息和机密。

可注册为数据存储的受支持 Azure 存储服务的示例包括:

  • Azure Blob 容器

  • Azure 文件共享

  • Azure Data Lake

  • Azure Data Lake Gen2

  • Azure SQL 数据库

  • Azure Database for PostgreSQL

  • Databricks 文件系统

  • Azure Database for MySQL

使用此类可以执行管理操作,包括注册、列出、获取和移除数据存储。 每个服务的数据存储都是使用此类的 register* 方法创建的。 使用数据存储访问数据时,必须具有访问数据的权限,这取决于在数据存储中注册的凭据。

有关数据存储以及如何在机器学习中使用数据存储的详细信息,请参阅以下文章:

按名称获取数据存储。 此调用将向数据存储服务发出请求。

Environment

为机器学习试验配置可重复的 Python 环境。

环境定义了在机器学习试验中使用的 Python 包、环境变量和 Docker 设置,这些设置将包含在数据准备中,经过训练并部署到 Web 服务。 环境在 Azure 机器学习 Workspace 中进行管理和版本控制。 可以更新现有环境并检索要重用的版本。 环境只能在其被创建的工作区中使用,而不能在其他工作区中使用。

有关环境的详细信息,请参阅创建和管理可重用环境

类环境构造函数。

Experiment

表示用于在 Azure 机器学习中创建和使用试验的主要入口点。

试验是表示多个模型运行的试运行容器

试验构造函数。

Image

为 Azure 机器学习映像定义抽象父类。

此类已弃用。 请改用 Environment 类。

图像构造函数。

此类已弃用。 请改用 Environment 类。

图像构造函数用于检索与提供的工作区关联的 Image 对象的云表示形式。 将返回与检索的图像对象的特定类型对应的子类的实例。

Keyvault

管理存储在与 Azure 机器学习工作区关联的 Azure 密钥保管库机密。

每个 Azure 机器学习工作区都有关联的 Azure Key Vault。 Keyvault 类是 Azure Key Vault 的简化包装器,可用于管理密钥保管库中的机密,包括设置、检索、删除和列出机密。 使用 Keyvault 类将机密安全地传递给远程运行,而无需以明文方式公开敏感信息。

有关详细信息,请参阅在训练运行中使用机密

类 Keyvault 构造函数。

LinkedService

注意

这是一个试验性的类,可能会在任何时候更改。 有关详细信息,请参阅 https://aka.ms/azuremlexperimental

定义用于管理 AML 工作区与 Azure 上其他服务之间的链接的资源。

初始化 LinkedService 对象。

Model

表示机器学习训练的结果。

模型是 Azure 机器学习训练 Run 或 Azure 外部的其他某种模型训练过程的结果。 无论模型是如何生成的,都可以在工作区中注册,并在工作区中由名称和版本表示。 使用 Model 类,可以将模型打包,以便与 Docker 一起使用,并将它部署为可用于推理请求的实时终结点。

有关演示如何创建、管理和使用模型的端到端教程,请参阅使用 Azure 机器学习通过 MNIST 数据和 scikit-learn 训练映像分类模型

模型构造函数。

模型构造函数用于检索与提供的工作区关联的 Model 对象的云表示形式。 必须提供名称或 ID。

PrivateEndPoint

定义用于管理与 Azure ML 工作区关联的专用终结点连接的专用终结点。

初始化 PrivateEndPoint。

PrivateEndPointConfig

定义 Azure 专用终结点的配置。

Azure 专用终结点是一个网络接口,可通过专用链接私密且安全地将你连接到 Azure ML 工作区。

初始化 PrivateEndPointConfig。

Run

定义所有 Azure 机器学习试验运行的基类。

一个运行表示一个试验的单次试运行。 运行用于监视试运行的异步执行、记录指标和存储试运行的输出,以及分析结果和访问试运行生成的项目。

当你提交脚本以在 Azure 机器学习中的许多不同场景(包括 HyperDrive 运行、管道运行和 AutoML 运行)中训练模型时,会创建运行对象。 使用 Experiment 类进行 submitstart_logging 时,也会创建一个运行对象。

若要开始使用试验和运行,请参阅

初始化 Run 对象。

RunConfiguration

表示针对 Azure 机器学习中不同计算目标的试验运行配置。

RunConfiguration 对象封装在试验中提交训练运行所必需的信息。 通常,不会直接创建 RunConfiguration 对象,而是从返回 RunConfiguration 对象的方法中获取一个,例如 Experiment 类的 submit 方法。

RunConfiguration 是一种基础环境配置,也用于其他类型的配置步骤,具体取决于要触发的运行类型。 例如,设置 PythonScriptStep 时,可以访问步骤的 RunConfiguration 对象并配置 Conda 依赖项或访问运行的环境属性。

有关示例运行配置,请参阅选择并使用计算目标来训练模型

使用默认设置初始化 RunConfiguration。

ScriptRun

提供编程访问用于管理提交的训练运行。

使用 ScriptRunConfig 提交的运行表示试验中的单次试运行。 提交运行会返回一个 ScriptRun 对象,该对象可用于监视运行的异步执行、记录指标和存储运行的输出,以及分析结果和访问运行生成的项目。

若要开始使用试验和 ScriptRunConf,请参阅

类 ScriptRun 构造函数。

ScriptRunConfig

表示在 Azure 机器学习中提交训练运行的配置信息。

ScriptRunConfig 会将提交 Azure ML 运行所需的配置信息打包在一起,包括脚本、计算目标、环境以及任何特定于作业的分布式配置。

在配置脚本运行并使用 submit 提交后,将返回 ScriptRun

Class ScriptRunConfig 构造函数。

SynapseWorkspaceLinkedServiceConfiguration

注意

这是一个试验性的类,可能会在任何时候更改。 有关详细信息,请参阅 https://aka.ms/azuremlexperimental

定义链接服务配置以便链接 synapse 工作区。

初始化 SynapseWorkspaceLinkedServiceConfiguration 对象。

Webservice

定义基本功能,以用于将模型部署为 Azure 机器学习中的 Web 服务终结点。

Webservice 构造函数用于检索与提供的工作区关联的 Web 服务对象的云表示形式。 返回与检索到的特定类型的 Webservice 对象对应的子类实例。 使用 Webservice 类可以从 ModelImage 对象部署机器学习模型。

有关使用 Web 服务的详细信息,请参阅使用 Azure 机器学习部署模型

初始化 Webservice 实例。

Webservice 构造函数检索与提供的工作区关联的 Webservice 对象的云表示形式。 它将返回与检索的 Webservice 对象的特定类型对应的子类的实例。

Workspace

定义用于管理训练和部署项目的 Azure 机器学习资源。

工作区是 Azure 机器学习中的机器学习的基础资源。 可以使用工作区来试验、训练和部署机器学习模型。 每个工作区与某个 Azure 订阅和资源组相关联,并具有关联的 SKU。

有关工作区的详细信息,请参阅:

用于加载现有Azure 机器学习工作区的类工作区构造函数。

diagnostic_log

将调试日志引导到指定的文件。

函数

attach_legacy_compute_target

将计算目标附加到此项目。

attach_legacy_compute_target(experiment, source_directory, compute_target)

参数

名称 说明
experiment
必需
source_directory
必需
str
compute_target
必需
str

要附加的计算目标对象。

返回

类型 说明

如果附加成功,则为“无”,否则引发异常。

get_run

获取此试验的运行及其运行 ID。

get_run(experiment, run_id, rehydrate=True, clean_up=True)

参数

名称 说明
experiment
必需

包容性试验。

run_id
必需

运行 ID。

rehydrate
<xref:boolean>

指示是返回原始运行对象,还是仅返回基本运行对象。 如果为 True,则此函数返回原始运行对象类型。 例如,对于 AutoML 运行,将返回 AutoMLRun 对象,而对于 HyperDrive 运行,将返回 HyperDriveRun 对象。

如果为 False,则函数返回 Run 对象。

默认值: True
clean_up

如果为 true,请从run_base调用_register_kill_handler

默认值: True

返回

类型 说明
Run

提交的运行。

is_compute_target_prepared

检查计算目标是否准备就绪。

检查在 run_config 中指定的计算目标是否已准备好指定的运行配置。

is_compute_target_prepared(experiment, source_directory, run_config)

参数

名称 说明
experiment
必需
source_directory
必需
str
run_config
必需

运行配置。 这可以是运行配置名称,也可以是字符串或 azureml.core.runconfig.RunConfiguration 对象。

返回

类型 说明

如果计算目标已准备就绪,则为 True。

prepare_compute_target

准备计算目标。

根据 run_config 和 custom_run_config 安装试验运行所需的所有包。

prepare_compute_target(experiment, source_directory, run_config)

参数

名称 说明
experiment
必需
source_directory
必需
str
run_config
必需

运行配置。 这可以是运行配置名称,也可以是字符串或 azureml.core.runconfig.RunConfiguration 对象。

返回

类型 说明

运行对象

remove_legacy_compute_target

从项目中删除计算目标。

remove_legacy_compute_target(experiment, source_directory, compute_target_name)

参数

名称 说明
experiment
必需
source_directory
必需
str
compute_target_name
必需
str

返回

类型 说明

如果删除计算目标成功,则为“无”,否则引发异常。