sfaira.data.store.batch_schedule.BatchDesignBase

class sfaira.data.store.batch_schedule.BatchDesignBase(retrieval_batch_size: int, randomized_batch_access: bool, random_access: bool, **kwargs)

Manages distribution of selected indices for a given data object over subsequent batches.

This involves randomisation and possible meta-data dependent batching. This class is centred on the property .design which yields a list of observation indices (arrays), where each array is the set of indices that map to a batch and the sequence of batches in the list encodes the sequence of batches during an epoch over the data.

Attributes

batchsplits	Batch size of the yieleded batches.
design	Yields index objects for one epoch of all data.
idx	Protects property from uncontrolled changing.
n_batches

Methods