cblearn.utils.check_size#

cblearn.utils.check_size(size, max_objects)[source]#

Convert size argument to the number of objects.

Parameters:
  • size (None | int | float) – The ommited, relative, or absolute number of objects.

  • max_objects (int) – The maximum number of objects for relative size.

Returns:

The absolute size, corresponding to

max_objects, if size is None size, if size is int size * max_objects, if size is float

Return type:

int

Raises
ValueError:

If size is int and < 0 or > max_objects If size is float and < 0 or > 1.