pipeline_run_helper Module

Helper methods to execute an AutoML pipeline fit.

Classes

PipelineRunOutput

Data class used to encapsulate return values from calling run_pipeline. Initialize a PipelineRunOutput object.

Functions

run_pipeline

Run a pipeline using the given settings and context.

run_pipeline(control_settings: ExperimentControlSettings, resource_settings: ExperimentResourceSettings, automl_pipeline: AutoMLPipeline, automl_run_context: AutoMLAbstractRunContext, iteration_timeout_min: int | None) -> PipelineRunOutput

Parameters

Name	Description
pipeline_run_params Required	settings object to use for this job.
automl_pipeline Required	the pipeline definition to use for this job.
automl_run_context Required	the run context to use for this job.
iteration_timeout_min Required	upper bound for how long this job can take. Passing None disables timeout.
control_settings Required
resource_settings Required

Returns

Type	Description
	a PipelineRunOutput object containing the results