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.Inspector¶

class julearn.inspect.Inspector(scores, model=None, X=None, y=None, groups=None, cv=None)¶

Base class for inspector.

Parameters:

scores (DataFrame) – The scores as dataframe.
model (str | PipelineCreator | BaseEstimator | None, default: None) – The model to inspect (default None).
X (DataFrame | None, default: None) – The features as list (default None).
y (Series | None, default: None) – The target (default None).
groups (Series | None, default: None) – The grouping labels in case a group CV is used (default None).
cv (int | BaseCrossValidator | None, default: None) – The number of folds for cross-validation (default None).

__init__(scores, model=None, X=None, y=None, groups=None, cv=None)¶

property model: PipelineInspector¶

Return the model.

Returns:: A PipelineInspector instance with model set.
Raises:: ValueError – If no model is provided.

property folds: FoldsInspector¶

Return the folds.

Returns:: A FoldsInspector instance with parameters set.
Raises:: ValueError – If no cv, X or y is provided.

Examples using `julearn.inspect.Inspector`¶

Inspecting the fold-wise predictions

/auto_examples/99_docs/run_model_inspection_docs

Inspecting Models

julearn.inspect.Inspector¶

Examples using julearn.inspect.Inspector¶

Examples using `julearn.inspect.Inspector`¶