Skip to content

stemflow.utils.validation

Validation module. Most of these functions are plain checking and easy to understand.

check_random_state(seed)

Turn seed into a np.random.RandomState instance.

Parameters:

  • seed (Union[None, int, Generator]) –

    If seed is None, return a random generator. If seed is an int, return a random generator with that seed. If seed is already a random generator instance, return it. Otherwise raise ValueError.

Returns:

  • Generator –

    The random generator object based on seed parameter.

Source code in stemflow/utils/validation.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def check_random_state(seed: Union[None, int, np.random._generator.Generator]) -> np.random._generator.Generator:
    """Turn seed into a np.random.RandomState instance.

    Args:
        seed:
            If seed is None, return a random generator.
            If seed is an int, return a random generator with that seed.
            If seed is already a random generator instance, return it.
            Otherwise raise ValueError.

    Returns:
        The random generator object based on `seed` parameter.
    """
    if seed is None:
        return np.random.default_rng(np.random.randint(0, 2**32 - 1))
    if isinstance(seed, int):
        return np.random.default_rng(seed)
    if isinstance(seed, np.random._generator.Generator):
        return seed
    raise ValueError("%r cannot be used to seed a np.random.default_rng instance" % seed)