noether.data.base.wrappers.shuffle

Classes

ShuffleWrapperConfig
ShuffleWrapper	Shuffles the dataset, optionally with seed.

Module Contents

class noether.data.base.wrappers.shuffle.ShuffleWrapperConfig(/, **data)

Bases: noether.data.base.wrapper.DatasetWrapperConfig

Parameters:

data (Any)

kind: str = 'noether.data.base.wrappers.ShuffleWrapper'

seed: int | None = None

Random seed for shuffling. If None, a random seed is used.

class noether.data.base.wrappers.shuffle.ShuffleWrapper(config, dataset)

Bases: noether.data.base.subset.Subset

Shuffles the dataset, optionally with seed.

Example

dataset_wrappers:
    kind: noether.data.base.wrappers.ShuffleWrapper
    seed: 42

Parameters:

• config (ShuffleWrapperConfig) – Configuration for the ShuffleWrapper. See ShuffleWrapperConfig for available options.

• dataset (noether.data.base.dataset.Dataset | noether.data.base.wrapper.DatasetWrapper) – The dataset to shuffle. Can be a base dataset or an already wrapped dataset.

Raises:

ValueError – If the dataset is not an instance of noether.data.Dataset or DatasetWrapper, or if the seed is not an integer or None.

seed