Source code for immuneML.data_model.dataset.Dataset

import abc



[docs]class Dataset:
    TRAIN = "train"
    TEST = "test"
    SUBSAMPLED = "subsampled"
    PREPROCESSED = "preprocessed"

    def __init__(self, encoded_data=None, name: str = None, identifier: str = None, labels: dict = None):
        self.encoded_data = encoded_data
        self.identifier = identifier
        self.name = name if name is not None else self.identifier
        self.labels = labels


[docs]    @classmethod
    @abc.abstractmethod
    def build_from_objects(cls, **kwargs):
        pass



[docs]    @abc.abstractmethod
    def make_subset(self, example_indices, path, dataset_type: str):
        pass



[docs]    @abc.abstractmethod
    def get_example_count(self):
        pass



[docs]    @abc.abstractmethod
    def get_data(self, batch_size: int = 1):
        pass



[docs]    @abc.abstractmethod
    def get_batch(self, batch_size: int = 1):
        pass



[docs]    @abc.abstractmethod
    def get_example_ids(self):
        pass



[docs]    @abc.abstractmethod
    def get_label_names(self):
        pass



[docs]    @abc.abstractmethod
    def clone(self, keep_identifier: bool = False):
        pass



[docs]    @abc.abstractmethod
    def get_metadata(self, field_names: list, return_df: bool = False):
        pass