ensemble.permute_groups
ensemble.permute_groups(groups, n_perms, seed=0)Generate permutations of group members.
In each permutation, groups of the same size are randomly reordered among themselves, and members within each placed group are shuffled. Members never cross group boundaries.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| groups | list of arrays | Each array contains the sample indices of members of one group. np.sort(np.concatenate(groups)) must equal np.arange(n). |
required |
| n_perms | int | Number of permutations to generate. | required |
| seed | int | Random seed for the random number generator. | 0 |
Returns
| Name | Type | Description |
|---|---|---|
| perms | ndarray of int, shape (n_perms, n) | Each row is a permutation array. data[perms[p]] gives the permuted data for permutation p. |