czbenchmarks.datasets.validators.dataset_validator
==================================================

.. py:module:: czbenchmarks.datasets.validators.dataset_validator


Attributes
----------

.. autoapisummary::

   czbenchmarks.datasets.validators.dataset_validator.logger


Classes
-------

.. autoapisummary::

   czbenchmarks.datasets.validators.dataset_validator.DatasetValidator


Module Contents
---------------

.. py:data:: logger

.. py:class:: DatasetValidator

   Bases: :py:obj:`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


   .. py:attribute:: dataset_type
      :type:  ClassVar[Type[czbenchmarks.datasets.Dataset]]


   .. py:method:: __init_subclass__() -> None
      :classmethod:


      Validate that subclasses define required class variables.

      :raises TypeError: If required class variables are missing



   .. py:method:: 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

      :param dataset: Dataset to validate

      :raises ValueError: If validation fails