utils module

Utility functions for the corrdim library.

corrdim.utils.clamp(values, reference, low, high)[source]

Filter values by a reference range, returning filtered values and reference.

Parameters:

  • values (torch.Tensor | numpy.ndarray)

  • reference (torch.Tensor | numpy.ndarray)

  • low (float)

  • high (float)

Return type:

Tuple[torch.Tensor | numpy.ndarray, torch.Tensor | numpy.ndarray]

corrdim.utils.group_add(vectors, num_groups)[source]
Parameters:

  • vectors (torch.Tensor | numpy.ndarray)

  • num_groups (int)

Return type:

torch.Tensor | numpy.ndarray

corrdim.utils.group_mean(vectors, num_groups)[source]
Parameters:

  • vectors (torch.Tensor | numpy.ndarray)

  • num_groups (int)

Return type:

torch.Tensor | numpy.ndarray

corrdim.utils.reduce_dimension(vectors, num_groups=8192, method='group_add')[source]
Parameters:

  • vectors (torch.Tensor | numpy.ndarray)

  • num_groups (int)

  • method (str)

Return type:

torch.Tensor | numpy.ndarray