Skip to content

i_dataset

Module for IDatasetData interface

!!! interfaces IDatasetData

IDatasetData (ABC)

Interface for dataset information

Source code in api/i_dataset.py 
class IDatasetData(ABC):
    """Interface for dataset information"""

    @property
    @abstractmethod
    def path(self) -> Path:
        """File path to the dataset"""

    @property
    @abstractmethod
    def start_date(self) -> str:
        """start date to filter the dataset"""
        # start_date is passed as string (not datetime) because it is optional

    @property
    @abstractmethod
    def end_date(self) -> str:
        """end date to filter the dataset"""
        # end_date is passed as string (not datetime) because it is optional

    @property
    @abstractmethod
    def mapping(self) -> dict[str, str]:
        """Variable name mapping (source to target)"""

    @path.setter
    def path(self, path: Path):
        """path of the model"""

end_date: str property readonly

end date to filter the dataset

mapping: dict[str, str] property readonly

Variable name mapping (source to target)

path: Path property writable

File path to the dataset

start_date: str property readonly

start date to filter the dataset