Skip to content

numerical

optimus_dl.core.numerical

get_item(number)

Extract the scalar value from a tensor or array.

Source code in optimus_dl/core/numerical.py 
 7
 8
 9
10
11
12
13
14
15
16
def get_item(number: ScalarLike) -> float | int | bool:
    """Extract the scalar value from a tensor or array."""
    if isinstance(number, torch.Tensor):
        assert number.numel() == 1, "Tensor must be a scalar."
        return number.item()
    elif isinstance(number, np.ndarray):
        assert number.size == 1, "Array must be a scalar."
        return number.item()
    else:
        return number

safe_round(number, ndigits)

Safely round a number, handling various numeric types.

This function handles rounding for Python numbers, PyTorch tensors, and NumPy arrays. It recursively handles nested types (e.g., single-element tensors) until it reaches a roundable Python number.

Parameters:

Name Type Description Default
number ScalarLike

The number to round. Can be a Python number, PyTorch tensor, or NumPy array.

 required
ndigits int | None

Number of decimal places to round to. If None, returns the number unchanged.

 required

Returns:

Type Description
float | int

Rounded number as float or int (depending on whether rounding occurred).
Example 
safe_round(3.14159, 2)  # 3.14
safe_round(torch.tensor(3.14159), 2)  # 3.14
safe_round(3.14159, None)  # 3.14159 (no rounding)
Source code in optimus_dl/core/numerical.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def safe_round(number: ScalarLike, ndigits: int | None) -> float | int:
    """Safely round a number, handling various numeric types.

    This function handles rounding for Python numbers, PyTorch tensors, and
    NumPy arrays. It recursively handles nested types (e.g., single-element
    tensors) until it reaches a roundable Python number.

    Args:
        number: The number to round. Can be a Python number, PyTorch tensor,
            or NumPy array.
        ndigits: Number of decimal places to round to. If None, returns the
            number unchanged.

    Returns:
        Rounded number as float or int (depending on whether rounding occurred).

    Example:
        ```python
        safe_round(3.14159, 2)  # 3.14
        safe_round(torch.tensor(3.14159), 2)  # 3.14
        safe_round(3.14159, None)  # 3.14159 (no rounding)

        ```"""
    number = get_item(number)
    if ndigits is None:
        return number
    if hasattr(number, "__round__"):
        return round(number, ndigits)
    return number