Share via

StepRunOutput Class

  • Reference

Represents an output created by a StepRun in a Pipeline.

StepRunOutput can be used to access the PortDataReference created by the step.

Initialize StepRunOutput.

Inheritance
builtins.object
StepRunOutput

Constructor

StepRunOutput(context, pipeline_run_id, step_run, name, step_output)

Parameters

Name Description
context
Required
<xref:azureml.pipeline.core._GraphContext>

The graph context object.
pipeline_run_id
Required
str

The id of the pipeline run which created the output.
step_run
Required
StepRun

The step run object which created the output.
name
Required
str

The name of the output.
step_output
Required
<xref:azureml.pipeline.core._restclients.aeva.models.NodeOutput>

The step output.
context
Required
<xref:azureml.pipeline.core._GraphContext>

The graph context object.
pipeline_run_id
Required
str

The id of the pipeline run which created the output.
step_run
Required
StepRun

The step run object which created the output.
name
Required
str

The name of the output.
step_output
Required
<xref:azureml.pipeline.core._restclients.aeva.models.NodeOutput>

The step output.

Remarks

Step run outputs are instantiated by calling get_output. Use get_port_data_reference to retrieve the PortDataReference which can be used to download the data and can be used as an step input in a future pipeline.

An example of getting the StepRunOutput from a StepRun and downloading the output data is as follows:


   from azureml.pipeline.core import PipelineRun, StepRun, PortDataReference

   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
   step_run = pipeline_run.find_step_run("<step_name>")[0]

   step_run_output = step_run.get_output("<output_name>")

   port_data_reference = step_run_output.get_port_data_reference()
   port_data_reference.download(local_path="path")

Methods

get_port_data_reference

Get port data reference produced by the step.

get_port_data_reference

Get port data reference produced by the step.

get_port_data_reference()

Returns

Type Description
PortDataReference

The port data reference.