CheckResult¶

class CheckResult[source]¶

Class which returns from a check with result that can later be used for automatic pipelines and display value.

Class containing the result of a check

The class stores the results and display of the check. Evaluating the result in an IPython console / notebook will show the result display output.

Parameters

valueAny: Value calculated by check. Can be used to decide if decidable check passed.
displayList[Union[Callable, str, pd.DataFrame, Styler]] , default: None: Dictionary with formatters for display. possible formatters are: ‘text/html’, ‘image/png’
headerstr , default: None: Header to be displayed in python notebook.

__init__(value, header: Optional[str] = None, display: Optional[Any] = None)[source]¶

Attributes

`CheckResult.priority`	Return priority of the current result.
`CheckResult.value`
`CheckResult.header`
`CheckResult.display`
`CheckResult.conditions_results`
`CheckResult.check`

Methods

`CheckResult.display_check`([unique_id, ...])	Display the check result or return the display as widget.
`CheckResult.display_from_json`(json_data)	Display the check result from a json received from a to_json.
`CheckResult.get_header`()	Return header for display.
`CheckResult.have_conditions`()	Return if this check have condition results.
`CheckResult.have_display`()	Return if this check have dsiplay.
`CheckResult.passed_conditions`()	Return if this check have not passing condition results.
`CheckResult.process_conditions`()	Process the conditions results from current result and check.
`CheckResult.show`([unique_id, ...])	Display check result.
`CheckResult.to_json`([with_display])	Return check result as json.
`CheckResult.to_wandb`([dedicated_run])	Export check result to wandb. Parameters ---------- dedicated_run : bool , default: None If to initiate and finish a new wandb run. If None it will be dedicated if wandb.run is None. kwargs: Keyword arguments to pass to wandb.init. Default project name is deepchecks. Default config is the check metadata (params, train/test/ name etc.).

check

CheckResult.priority