Skip to content

Bring-Your-Own-Dataset (BYOD)

The Bring-Your-Own-Dataset (BYOD) feature allows users to add custom datasets for training and evaluating models. This feature is useful when working with proprietary or custom datasets that are not available in the SleepKit library.

How it Works

  1. Create a Dataset: Define a new dataset by creating a new Python file. The file should contain a class that inherits from the HKDataset base class and implements the required methods.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    import sleepkit as sk

class CustomDataset(sk.Dataset):
    def __init__(self, config):
        super().__init__(config)

    def download(self):
        pass

    def generate(self):
        pass

  2. Register the Dataset: Register the new dataset with the sk.DatasetFactory by calling the register method. This method takes the dataset name and the dataset class as arguments.

    1
2
3
    import sleepkit as sk

sk.DatasetFactory.register("custom", CustomDataset)

  3. Use the Dataset: The new dataset can now be used with the sk.DatasetFactory to perform various operations such as downloading and generating data.

    1
2
3
    import sleepkit as sk

dataset = sk.DatasetFactory.create("custom", config)