ParallelRunStepDetails Class

Represents a Jupyter notebook widget used to view the progress of ParallelRunStep.

A widget is synchronous and provides updates until ParallelRunStep finishes.

Return a ParallelRunStepDetails widget based on the specified run type. The ParallelRunStep to be visualized can be specified in either of the following ways:

• run_instance + step_name
• workspace + run_id + step_name
• workspace + step_run_id Please make sure one of these combinations is provided in the parameters. If multiple ways are provided, the one on top will be chosen.

:rtype azureml.widgets.ParallelRunStepDetails

Inheritance

builtins.object

ParallelRunStepDetails

Constructor

ParallelRunStepDetails(run_instance: Run | None = None, step_name: str | None = None, workspace: Workspace | None = None, run_id: str | None = None, step_run_id: str | None = None)

Parameters

Name	Description
run_instance	Run instance for which the widget will be rendered. Default value: None
step_name	Name of the ParallelRunStep in the Run. Default value: None
workspace	Workspace instance where the Run resides. Default value: None
run_id	Run id in which the ParallelRunStep resides. Default value: None
step_run_id	StepRun id for which the widget will be rendered. Default value: None

Methods

show	Render widget and start synchronous refresh the widget until ParallelRunStep finishes.

show

Render widget and start synchronous refresh the widget until ParallelRunStep finishes.

show()