czbenchmarks.datasets.validators.dataset_validator

Attributes

logger

Classes

DatasetValidator

Abstract base class for dataset validators. Not used in code and provided as convenience to validate user datasets.

Module Contents

czbenchmarks.datasets.validators.dataset_validator.logger

class czbenchmarks.datasets.validators.dataset_validator.DatasetValidator

Bases: abc.ABC

Abstract base class for dataset validators. Not used in code and provided as convenience to validate user datasets.

Defines the interface for validating datasets against dataset requirements. Validators ensure datasets meet dataset-specific requirements like: - Compatible data types - Organism compatibility - Feature name formats

Each validator must: 1. Define a dataset_type class variable 2. Implement _validate_dataset, inputs, and outputs as abstract methods/properties

dataset_type: ClassVar[Type[czbenchmarks.datasets.Dataset]]

classmethod __init_subclass__() → None

Validate that subclasses define required class variables.

Raises:

TypeError – If required class variables are missing

validate_dataset(dataset: czbenchmarks.datasets.Dataset)

Validate that a dataset meets all requirements.

Checks: 1. Dataset type matches dataset_type 2. Runs dataset specific validation

Parameters:

dataset – Dataset to validate

Raises:

ValueError – If validation fails