archetypes.processing.shuffle

archetypes.processing.shuffle(data, axis=None, generator=None)

Shuffle a dataset along each dimension.

Parameters:

data: array-like

The dataset to shuffle.

ndim: list of int or None, default=None

The dimensions to shuffle. If None, all dimensions are shuffled.

generator: int, Generator or None, default=None

The generator to use for shuffling. If None, the default generator is used.

Returns:

data: array-like

The shuffled dataset.

perms: list of array-like

The permutations used.