normalize_ratios

normalize_ratios(ratios: float | Sequence[float], epsilon: float = 1e-06) → tuple[float, ...][source]

Normalize relative sizes.

If the sum is smaller than 1, adds (1 - sum)

Parameters:

  • ratios (float | Sequence[float]) – The ratios.

  • epsilon (float) – A small constant for comparing sum of ratios against 1.

Returns:

A sequence of ratios of at least two elements which sums to one.

Raises:

ValueError – if the ratio sum is bigger than 1.0

Return type:

tuple[float, …]