TrainTestCheck#

class TrainTestCheck[source]#

Parent class for checks that compare two datasets.

The class checks train dataset and test dataset for model training and test.

__init__(**kwargs)[source]#
__new__(*args, **kwargs)#

Methods

TrainTestCheck.add_condition(name, ...)

Add new condition function to the check.

TrainTestCheck.clean_conditions()

Remove all conditions from this check instance.

TrainTestCheck.compute(context)

Compute final check result based on accumulated internal state.

TrainTestCheck.conditions_decision(result)

Run conditions on given result.

TrainTestCheck.config([include_version, ...])

Return check configuration (conditions' configuration not yet supported).

TrainTestCheck.from_config(conf[, ...])

Return check object from a CheckConfig object.

TrainTestCheck.from_json(conf[, version_unmatch])

Deserialize check instance from JSON string.

TrainTestCheck.initialize_run(context)

Initialize run before starting updating on batches.

TrainTestCheck.metadata([with_doc_link])

Return check metadata.

TrainTestCheck.name()

Name of class in split camel case.

TrainTestCheck.params([show_defaults])

Return parameters to show when printing the check.

TrainTestCheck.remove_condition(index)

Remove given condition by index.

TrainTestCheck.run(train_dataset, test_dataset)

Run check.

TrainTestCheck.to_json([indent, ...])

Serialize check instance to JSON string.

TrainTestCheck.update(context, batch, ...)

Update internal check state with given batch for either train or test.