CheckNotApplicable

class skore.CheckNotApplicable

Raised when a check cannot run on the given report.

Parameters:

messagestr or None, default=None

Optional reason shown in the checks summary explanation.

Notes

Check implementations raise this exception when required data, task type, or model capabilities are missing. The check appears under the “Not Applicable” section of the checks summary.

Examples

>>> from skore import Check
>>> from skore._sklearn._checks._utils import CheckNotApplicable
>>> class MyCheck(Check):
...     code = "TST001"
...     title = "My check"
...     report_types = ["estimator"]
...     docs_url = None
...     severity = "issue"
...     def check_function(self, report):
...         if report.X_train is None:
...             raise CheckNotApplicable("Train data is unavailable.")
...         return None

add_note(note, /)

Add a note to the exception

with_traceback(tb, /)

Set self.__traceback__ to tb and return self.

Gallery examples

Adding custom checks

Adding custom checks