resolve_negative_axis

tfsnippet.utils.resolve_negative_axis(ndims, axis)

Resolve all negative axis indices according to ndims into positive.

Usage:

resolve_negative_axis(4, [0, -1, -2])  # output: (0, 3, 2)

Parameters:

• ndims (int) – Number of total dimensions.
• axis (Iterable[int]) – The axis indices.

Returns:

The resolved positive axis indices.

Return type:

tuple[int]

Raises:

ValueError – If any index in axis is out of range.