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:

scorespd.DataFrame

The scores as dataframe.

modelstr, optional

The model to inspect (default None).

Xlist of str, optional

The features as list (default None).

ystr, optional

The target (default None).

groupsstr, optional

The grouping labels in case a group CV is used (default None).

cvint, optional

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:

PipelineInspector

A PipelineInspector instance with model set.

Raises:

ValueError

If no model is provided.

property folds: FoldsInspector

Return the folds.

Returns:

FoldsInspector

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

Inspecting the fold-wise predictions

Inspecting Models

Inspecting Models