tensorbay.healthcheck.basic_check

Method check_basic.

check_basic() checks whether Dataset or FusionDataset is empty and whether the Segment or FusionDataset in the object is empty.

class tensorbay.healthcheck.basic_check.BasicError(name)

Bases: tensorbay.healthcheck.report.Error

The base class of the basic error.

Parameters

name (str) – The dataset or segment name which has error.

Return type

None

class tensorbay.healthcheck.basic_check.EmptyDatasetError(name)

Bases: tensorbay.healthcheck.basic_check.BasicError

The health check function for empty dataset.

This error is raised to indicate that Dataset or FusionDataset is empty.

Parameters

name (str) –

Return type

None

class tensorbay.healthcheck.basic_check.EmptySegmentError(name)

Bases: tensorbay.healthcheck.basic_check.BasicError

The health check function for empty segment.

This error is raised to indicate that Segment or FusionDataset is empty.

Parameters

name (str) –

Return type

None

tensorbay.healthcheck.basic_check.check_basic(dataset)

The health check function for basic error.

Parameters

dataset (Union[tensorbay.dataset.dataset.Dataset, tensorbay.dataset.dataset.FusionDataset]) – The Dataset or FusionDataset needs to be checked.

Yields

BasicError indicating that Dataset, FusionDataset, Segment or FusionSegment is empty.

Return type

Iterator[tensorbay.healthcheck.basic_check.BasicError]