Pipeline

Pipeline class using Notebooks as steps with StepRunner. see: StepRunner

Pipeline

 Pipeline (steps:List[StepRunner]|StepRunner=None, *args)

Create pipeline of notebooks with optional variables

source

Pipeline.add_step

 Pipeline.add_step (step:Union[stdflow.step_runner.StepRunner,str]=None,
                    **kwargs)

Add step to pipeline

	Type	Default	Details
step	StepRunner \| str	None	StepRunner or path to notebook
kwargs

source

Pipeline.verify

 Pipeline.verify ()

Verify that all steps are valid

source

Pipeline.run

 Pipeline.run (save_notebook:bool=False, progress_bar:bool=False, kernel:U
               nion[Literal[':current',':target',':any_available'],str]=':
               target', kernels_on_fail:Union[str,list]=None,
               verbose=True, **kwargs)

Run pipeline

	Type	Default	Details
save_notebook	bool	False	Saves the output of cells in the notebook if True (default: False)
progress_bar	bool	False	Whether to show progress bar
kernel	Literal[‘:current’, ‘:target’, ‘:any_available’] \| str	:target	kernel name or :current to use current kernel, :target to use kernel specified in metadata of target notebook, :any_available to use any available kernel.
kernels_on_fail	str \| list	None	kernels to try if `kernel` does not exist / is not available (default: [“:current”, “python”, “:any_available”])
verbose	bool	True	Whether to print output of cells
kwargs

source

Pipeline.call

 Pipeline.__call__ (progress_bar:bool=False, **kwargs)

Run pipeline

	Type	Default	Details
progress_bar	bool	False	Whether to show progress bar
kwargs