Skip to content

rng

Random Number Generator API

This module provides utility functions to set random seed and create random id generators.

Functions:

Functions

set_random_seed 

set_random_seed(seed: int | None = None) -> int

Set random seed across libraries: TF, Numpy, Python

Parameters:

  • seed

    (int | None, default: None ) –

    Random seed state to use. Defaults to None.

Returns:

  • int ( int ) –

    Random seed

Source code in neuralspot_edge/utils/rng.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def set_random_seed(seed: int | None = None) -> int:
    """Set random seed across libraries: TF, Numpy, Python

    Args:
        seed (int | None, optional): Random seed state to use. Defaults to None.

    Returns:
        int: Random seed
    """

    seed = seed or random.randint(0, 2**16)
    random.seed(seed)
    # keras will set all backends including numpy
    keras.utils.set_random_seed(seed)
    return seed

uniform_id_generator 

uniform_id_generator(ids: Iterable[T], repeat: bool = True, shuffle: bool = True) -> Generator[T, None, None]

Simple generator that yields ids in a uniform manner.

Parameters:

  • ids

    (Iterable[T]) –

    List of ids.

  • repeat

    (bool, default: True ) –

    Whether to repeat generator. Defaults to True.

  • shuffle

    (bool, default: True ) –

    Whether to shuffle ids.. Defaults to True.

Note

If repeat is False, generator will stop after yielding all ids once. If shuffle, ids parameter will be modified in place.

Returns:

  • None –

    Generator[T, None, None]: Generator

Yields: T: Id

Source code in neuralspot_edge/utils/rng.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def uniform_id_generator(
    ids: Iterable[T],
    repeat: bool = True,
    shuffle: bool = True,
) -> Generator[T, None, None]:
    """Simple generator that yields ids in a uniform manner.

    Args:
        ids (Iterable[T]): List of ids.
        repeat (bool, optional): Whether to repeat generator. Defaults to True.
        shuffle (bool, optional): Whether to shuffle ids.. Defaults to True.

    Note:
        If repeat is False, generator will stop after yielding all ids once.
        If shuffle, ids parameter will be modified in place.

    Returns:
        Generator[T, None, None]: Generator
    Yields:
        T: Id
    """
    while True:
        if shuffle:
            random.shuffle(ids)
        yield from ids
        if not repeat:
            break

random_id_generator 

random_id_generator(ids: Iterable[T], weights: list[int] | None = None) -> Generator[T, None, None]

Simple generator that yields ids in a random manner.

Parameters:

  • ids

    (Iterable[T]) –

    List of ids

  • weights

    (list[int], default: None ) –

    Weights for each id. Defaults to None.

Returns:

  • None –

    Generator[T, None, None]: Generator

Yields:

  • T ( T ) –

    Id

Source code in neuralspot_edge/utils/rng.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def random_id_generator(
    ids: Iterable[T],
    weights: list[int] | None = None,
) -> Generator[T, None, None]:
    """Simple generator that yields ids in a random manner.

    Args:
        ids (Iterable[T]): List of ids
        weights (list[int], optional): Weights for each id. Defaults to None.

    Returns:
        Generator[T, None, None]: Generator

    Yields:
        T: Id
    """
    while True:
        yield random.choice(ids)