Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the What you really need to know section for the big picture.

julearn.inspect.PipelineInspector

class julearn.inspect.PipelineInspector(model)

Provide inspector for pipeline.

Parameters:

model (Pipeline) – The pipeline to inspect.

__init__(model)
get_step_names()

Get the names of the steps in the pipeline.

Returns:

The names of the steps in the pipeline.

get_step(name, as_estimator=False)

Get a step from the pipeline.

Parameters:

  • name (str) – The name of the step to retrieve.

  • as_estimator (bool, default: False) – Whether to return the step as an estimator inspector or not.

Returns:

The requested step.

get_params()

Get the parameters of the pipeline.

Returns:

The parameters of the pipeline.

get_fitted_params()

Get the fitted parameters of the pipeline.

Get the fitted parameters of the pipeline. This includes both hyperparameters and fitted parameters.

Returns:

The fitted parameters of the pipeline.

Examples using julearn.inspect.PipelineInspector

/auto_examples/99_docs/run_model_inspection_docs

Inspecting Models