TrainingOutput 类

定义特定 PipelineSteps 的专用输出,以便在管道中使用。

TrainingOutput 使自动化机器学习指标或模型可作为步骤输出提供,供 Azure 机器学习管道中的另一个步骤使用。 可用于 AutoMLStepHyperDriveStep.

初始化 TrainingOutput。

param model_file:要包含在输出中的特定模型文件。 仅限 HyperDriveStep

构造函数

TrainingOutput(type, iteration=None, metric=None, model_file=None)

参数

名称 说明
type
必需
str

训练输出的类型。 可能的值包括:“Metrics”、“Model”。

iteration
int

对应训练模型的迭代编号。 此迭代编号只能与类型“Model”一起提供。 iteration提供参数或metric参数,但不同时提供两者。

默认值: None
metric
str

用于返回最佳训练模型的指标。 指标只能与类型“Model”一起提供。 iteration提供参数或metric参数,但不同时提供两者。

默认值: None
model_file
str

要包含在输出中的特定模型文件。 仅限 HyperDriveStep

默认值: None
type
必需
str

训练输出的类型。 可能的值包括:“Metrics”、“Model”。

iteration
必需
int

对应训练模型的迭代编号。 此迭代编号只能与类型“Model”一起提供。 iteration提供参数或metric参数,但不同时提供两者。

metric
必需
str

用于返回最佳训练模型的指标。 指标只能与类型“Model”一起提供。 iteration提供参数或metric参数,但不同时提供两者。

注解

构造PipelineData训练输出时,使用 Pipeline TrainingOutput,以使其他步骤能够使用由AutoMLStep或生成的HyperDriveStep指标或模型。

定义 AutoMLStep 时,请使用 TrainingOutput,如下所示:


   from azureml.pipeline.core import PipelineData, TrainingOutput

   metrics_data = PipelineData(name='metrics_data', datastore=ds,
                                pipeline_output_name='metrics_output',
                                training_output=TrainingOutput(type='Metrics'))
   model_data = PipelineData(name='model_data', datastore=ds,
                             pipeline_output_name='best_model_output',
                             training_output=TrainingOutput(type='Model'))
   automl_step = AutoMLStep(name='automl_step',
                            automl_config=automl_config,
                            inputs=[input_data],
                            outputs=[metrics_data, model_data])

请参阅笔记本 https://aka.ms/pl-automl中使用 TrainingOutput 和 AutoMlStep 步骤的示例。

属性

iteration

获取对应训练模型的迭代编号。

返回

类型 说明
int

训练模型的迭代编号。

metric

获取最佳训练模型的指标。

返回

类型 说明
str

最佳训练模型的指标名称。

model_file

获取要包含在输出中的模型文件,以获得最佳训练模型。

返回

类型 说明
str

要包含在最佳训练模型的输出中的特定文件。

type

获取训练输出的类型。

返回

类型 说明
str

训练输出的类型。 可能的值包括:“Metrics”、“Model”。