AutoMLRun 类

表示 Azure 机器学习中的自动化 ML 试验运行。

AutoMLRun 类可用于管理运行、检查运行状态以及在提交 AutoML 运行后检索运行详细信息。 有关使用试验运行的详细信息，请参阅 Run 类。

初始化 AutoML 运行。

继承

Run

AutoMLRun

构造函数

AutoMLRun(experiment, run_id, **kwargs)

参数

名称	说明
experiment 必需	Experiment 与运行相关的试验。
run_id 必需	str 运行的 ID。
experiment 必需	Experiment 与运行相关的试验。
run_id 必需	str 运行的 ID。

注解

使用试验的 submit 方法时，将返回 AutoMLRun 对象。

若要检索已启动的运行，请使用以下代码：

   from azureml.train.automl.run import AutoMLRun
   ws = Workspace.from_config()
   experiment = ws.experiments['my-experiment-name']
   automl_run = AutoMLRun(experiment, run_id = 'AutoML_9fe201fe-89fd-41cc-905f-2f41a5a98883')

方法

cancel	取消 AutoML 运行。 如果成功取消 AutoML 运行，则返回 True。
cancel_iteration	取消特定的子运行。
complete	完成 AutoML 运行。
continue_experiment	继续运行现有的 AutoML 试验。
fail	使 AutoML 运行失败。 （可选）使用传递给 error_details 的消息或异常设置运行的 Error 属性。
get_best_child	返回此 AutoML 运行的评分最高的子运行。
get_guardrails	输出并返回运行 Guardrail 验证后的详细结果。
get_output	返回运行和已测试的相应最佳管道。 如果未提供输入参数，则 get_output 将根据主要指标返回最佳管道。 或者，可以使用 iteration 或 metric 参数分别检索特定迭代或提供的每个指标的最佳运行。
get_run_sdk_dependencies	获取给定运行的 SDK 运行依赖项。
pause	如果成功暂停 AutoML 运行，则返回 True。 未实现此方法。
register_model	将模型注册到 AzureML ACI 服务。
resume	如果成功恢复 AutoML 运行，则返回 True。 未实现此方法。
retry	如果成功重试 AutoML 运行，则返回 True。 未实现此方法。
summary	获取一个表，其中包含尝试的算法及其评分的摘要。
wait_for_completion	等待此运行完成。 返回等待后的状态对象。

cancel

取消 AutoML 运行。

如果成功取消 AutoML 运行，则返回 True。

cancel()

返回

类型	说明
	无

cancel_iteration

取消特定的子运行。

cancel_iteration(iteration)

参数

名称	说明
iteration 必需	int 要取消的迭代。

返回

类型	说明
	无

complete

完成 AutoML 运行。

complete(**kwargs)

返回

类型	说明
	无

continue_experiment

继续运行现有的 AutoML 试验。

continue_experiment(X=None, y=None, sample_weight=None, X_valid=None, y_valid=None, sample_weight_valid=None, data=None, label=None, columns=None, cv_splits_indices=None, spark_context=None, experiment_timeout_hours=None, experiment_exit_score=None, iterations=None, show_output=False, training_data=None, validation_data=None, **kwargs)

参数

名称	说明
X	DataFrame 或 ndarray 或 <xref:azureml.dataprep.Dataflow> 训练特征。 默认值: None
y	DataFrame 或 ndarray 或 <xref:azureml.dataprep.Dataflow> 训练标签。 默认值: None
sample_weight	DataFrame 或 ndarray 或 <xref:azureml.dataprep.Dataflow> 训练数据的示例权重。 默认值: None
X_valid	DataFrame 或 ndarray 或 <xref:azureml.dataprep.Dataflow> 验证特征。 默认值: None
y_valid	DataFrame 或 ndarray 或 <xref:azureml.dataprep.Dataflow> 验证标签。 默认值: None
sample_weight_valid	DataFrame 或 ndarray 或 <xref:azureml.dataprep.Dataflow> 验证集样本权重。 默认值: None
data	DataFrame 训练特征和标签。 默认值: None
label	str 为数据中的列设置标签。 默认值: None
columns	list(str) 数据中允许用作特征的列的列表。 默认值: None
cv_splits_indices	ndarray 用于交叉验证的拆分训练数据的索引。 每行都是一个单独的交叉折叠，在每个交叉折叠内，提供 2 个数组，第一个数组包含用于训练数据的样本索引，第二个数组包含用于验证数据的索引。 例如 [[t1, v1], [t2, v2], ...]，其中 t1 是第一个交叉折叠的训练索引，v1 是第一个交叉折叠的验证索引。 默认值: None
spark_context	<xref:SparkContext> Spark 上下文，仅当在 Azure Databricks/Spark 环境中使用时才适用。 默认值: None
experiment_timeout_hours	float 要将此试验运行额外多少个小时。 默认值: None
experiment_exit_score	int 如果已指定，则表示达到此值时终止试验。 默认值: None
iterations	int 要为此试验运行多少次额外迭代。 默认值: None
show_output	bool 指示是否在控制台中列显输出的标志。 默认值: False
training_data	<xref:azureml.dataprep.Dataflow> 或 DataFrame 输入训练数据。 默认值: None
validation_data	<xref:azureml.dataprep.Dataflow> 或 DataFrame 验证数据。 默认值: None

返回

类型	说明
AutoMLRun	AutoML 父运行。

例外

类型	说明
ConfigException
InvalidRunState

fail

使 AutoML 运行失败。

（可选）使用传递给 error_details 的消息或异常设置运行的 Error 属性。

fail(error_details=None, error_code=None, _set_status=True, **kwargs)

参数

名称	说明
error_details	str 或 BaseException 错误的可选详细信息。 默认值: None
error_code	str 错误分类的错误的可选错误代码。 默认值: None
_set_status	bool 指示是否发送状态事件进行跟踪。 默认值: True

get_best_child

返回此 AutoML 运行的评分最高的子运行。

get_best_child(metric: str | None = None, onnx_compatible: bool = False, **kwargs: Any) -> Run

参数

名称	说明
metric	str 选择要返回的最佳运行时使用的指标。 默认值为主要指标。 默认值: None
onnx_compatible	是否仅返回生成了 onnx 模型的运行。 默认值: False
kwargs 必需

返回

类型	说明
	AutoML 子运行。

get_guardrails

输出并返回运行 Guardrail 验证后的详细结果。

get_guardrails(to_console: bool = True) -> Dict[str, Any]

参数

名称	说明
to_console	bool 指示是否将验证结果写入控制台。 默认值: True

返回

类型	说明
dict	验证器结果的字典。

例外

类型	说明
UserErrorException

get_output

返回运行和已测试的相应最佳管道。

如果未提供输入参数，则 get_output 将根据主要指标返回最佳管道。 或者，可以使用 iteration 或 metric 参数分别检索特定迭代或提供的每个指标的最佳运行。

get_output(iteration: int | None = None, metric: str | None = None, return_onnx_model: bool = False, return_split_onnx_model: SplitOnnxModelName | None = None, **kwargs: Any) -> Tuple[Run, Any]

参数

名称	说明
iteration	int 要返回的相应运行和拟合模型的迭代次数。 默认值: None
metric	str 选择要返回的最佳运行和拟合模型时使用的指标。 默认值: None
return_onnx_model	bool 如果在 AutoMLConfig 对象中将 enable_onnx_compatible_models 参数设置为 True，则此方法将返回转换的 ONNX 模型。 默认值: False
return_split_onnx_model	SplitOnnxModelName 要返回的拆分 onnx 模型的类型 默认值: None

返回

类型	说明
Run, <xref:Model>	运行和相应的拟合模型。

例外

类型	说明
ConfigException
OnnxConvertException
NotFoundException

注解

若要检查使用的预处理器和算法（估算器），可以通过 Model.steps 执行此操作，类似于使用 sklearn.pipeline.Pipeline.steps。 例如，以下代码演示如何检索估算器。

   best_run, model = parent_run.get_output()
   estimator = model.steps[-1]

get_run_sdk_dependencies

获取给定运行的 SDK 运行依赖项。

get_run_sdk_dependencies(iteration=None, check_versions=True, **kwargs)

参数

名称	说明
iteration	int 要检索的拟合运行的迭代次数。 如果为 None，则检索父环境。 默认值: None
check_versions	bool 如果为 True，则检查包含当前环境的版本。 如果为 False，则通过检查。 默认值: True

返回

类型	说明
dict	从 RunHistory 检索的依赖项的字典。

例外

类型	说明
ConfigException

pause

如果成功暂停 AutoML 运行，则返回 True。

未实现此方法。

pause()

例外

类型	说明
NotImplementedError

register_model

将模型注册到 AzureML ACI 服务。

register_model(model_name=None, description=None, tags=None, iteration=None, metric=None)

参数

名称	说明
model_name	str 正在部署的模型的名称。 默认值: None
description	str 正在部署的模型的说明。 默认值: None
tags	dict 正在部署的模型的标记。 默认值: None
iteration	int 要部署的模型的重写。 为给定的迭代部署模型。 默认值: None
metric	str 要部署的模型的重写。 为不同的指标部署最佳模型。 默认值: None

返回

类型	说明
<xref:Model>	已注册的模型对象。

resume

如果成功恢复 AutoML 运行，则返回 True。

未实现此方法。

resume()

例外

类型	说明
NotImplementedError:

retry

如果成功重试 AutoML 运行，则返回 True。

未实现此方法。

retry()

例外

类型	说明
NotImplementedError

summary

获取一个表，其中包含尝试的算法及其评分的摘要。

summary()

返回

类型	说明
DataFrame	包含 AutoML 模型统计信息的 Pandas 数据帧。

wait_for_completion

等待此运行完成。

返回等待后的状态对象。

wait_for_completion(show_output=False, wait_post_processing=False)

参数

名称	说明
show_output	bool 指示是否在 sys.stdout 上显示运行输出。 默认值: False
wait_post_processing	bool 指示是否在运行完成后等待后处理完成。 默认值: False

返回

类型	说明
dict	状态对象。

例外

类型	说明
ExperimentExecutionException

属性

run_id

返回当前运行的运行 ID。

返回

类型	说明
str	当前运行的运行 ID。