noether.data.base.wrapper

Classes

DatasetWrapperConfig

DatasetWrapper

Wrapper around arbitrary noether.data.Dataset instances to generically change something about the dataset.

Module Contents

class noether.data.base.wrapper.DatasetWrapperConfig(/, **data)

Bases: pydantic.BaseModel

Parameters:

data (Any)

kind: str
class noether.data.base.wrapper.DatasetWrapper(dataset)

Wrapper around arbitrary noether.data.Dataset instances to generically change something about the dataset. For example:

  • Create a subset of the dataset (noether.data.Subset)

  • Define which properties/items to load from the dataset, i.e., which getitem_* methods to call (noether.data.ModeWrapper)

What exactly is changed depends on the specific implementation of the DatasetWrapper child class.

Parameters:

dataset (noether.data.base.dataset.Dataset | DatasetWrapper) – base dataset to be wrapped

dataset