SuiteResult

class SuiteResult[source]

Contain the results of a suite run.

Parameters
name: str
results: List[Union[CheckResult, CheckFailure]]
__init__(name: str, results)[source]

Initialize suite result.

__new__(*args, **kwargs)

Attributes

SuiteResult.name

SuiteResult.results

Methods

SuiteResult.save_as_html([file])

Save output as html file.

SuiteResult.show()

Display suite result.

SuiteResult.to_json([with_display])

Return check result as json.

SuiteResult.to_wandb([dedicated_run])

Export suite 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 suite name.