engine.data.DataModule#

class DataModule(root: str = './data', num_workers: int = 4, batch_size: int = 1)[source]#

Class of interfaces for data modules

Warning

This class can only be used as a base class for inheritance.

read_data and get_labels methods must be overridden in the child class.

Parameters:

root (str, optional) – The directory where datasets are stored. Defaults to “./data”.
num_workers (int, optional) – A positive integer will turn on multi-process data loading with the specified number of loader worker processes. Defaults to 4.
batch_size (int, optional) – Number of elements in a batch. Defaults to 1.

Methods

`get_labels`	Returns a list of class names
`read_data`	Read the dataset images and labels
`test_dataloader`	Returns the test dataloader
`train_dataloader`	Returns the training dataloader
`val_dataloader`	Returns a validation dataloader

read_data(split: str) → None[source]#

Read the dataset images and labels

engine.data.DataModule