archetypes.datasets.permute_dataset

archetypes.datasets.permute_dataset(data, perms=None) -> (<built-in function array>, <class 'dict'>)

Permute a dataset along each dimension.

Parameters:

data: array-like

The dataset to permute.

perms: list of array-like

The permutations to use. If None, no permutation is applied.

Returns:

data: array-like

The permuted dataset.

info: dict

The information about the permutation.