Skip to content

Randomness

Utilities for dealing with randomness.

def as_rng(seed=None) #

Converts a valid seed arg into a numpy.random.Generator instance.

PARAMETER DESCRIPTION
seed

The seed to use

TYPE: Seed | None DEFAULT: None

RETURNS DESCRIPTION
Generator

A valid np.random.Generator object to use
Source code in src/amltk/randomness.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def as_rng(seed: Seed | None = None) -> np.random.Generator:
    """Converts a valid seed arg into a numpy.random.Generator instance.

    Args:
        seed: The seed to use

    Returns:
        A valid np.random.Generator object to use
    """
    match seed:
        case None | int() | np.integer():
            return np.random.default_rng(seed)
        case np.random.Generator():
            return seed
        case np.random.RandomState():
            _seed = seed.randint(0, MAX_INT)
            return np.random.default_rng(_seed)

    raise ValueError(f"Can't {seed=} ({type(seed)}) to create numpy.random.Generator")

def as_randomstate(seed=None) #

Converts a valid seed arg into a numpy.random.RandomState instance.

PARAMETER DESCRIPTION
seed

The seed to use

TYPE: Seed | None DEFAULT: None

RETURNS DESCRIPTION
RandomState

A valid np.random.RandomSTate object to use
Source code in src/amltk/randomness.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def as_randomstate(seed: Seed | None = None) -> np.random.RandomState:
    """Converts a valid seed arg into a numpy.random.RandomState instance.

    Args:
        seed: The seed to use

    Returns:
        A valid np.random.RandomSTate object to use
    """
    match seed:
        case None | int() | np.integer():
            return np.random.RandomState(seed)
        case np.random.RandomState():
            return seed
        case np.random.Generator():
            _seed = seed.integers(0, MAX_INT)
            return np.random.RandomState(_seed)

    raise ValueError(f"Can't {seed=} ({type(seed)}) to create numpy.random.RandomState")

def as_int(seed=None) #

Converts a valid seed arg into an integer.

PARAMETER DESCRIPTION
seed

The seed to use

TYPE: Seed | None DEFAULT: None

RETURNS DESCRIPTION
int

A valid integer to use as a seed
Source code in src/amltk/randomness.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def as_int(seed: Seed | None = None) -> int:
    """Converts a valid seed arg into an integer.

    Args:
        seed: The seed to use

    Returns:
        A valid integer to use as a seed
    """
    match seed:
        case None:
            return int(np.random.default_rng().integers(0, MAX_INT))
        case np.integer() | int():
            return int(seed)
        case np.random.Generator():
            return int(seed.integers(0, MAX_INT))
        case np.random.RandomState():
            return int(seed.randint(0, MAX_INT))

    raise ValueError(f"Can't {seed=} ({type(seed)}) to create int")

def randuid(k=8, *, charset=ALPHABET, seed=None) #

Generate a random alpha-numeric uuid of a specified length.

See: stackoverflow.com/a/56398787/5332072

PARAMETER DESCRIPTION
k

The length of the uuid to generate

TYPE: int DEFAULT: 8

charset

The charset to use

TYPE: Sequence[str] DEFAULT: ALPHABET

seed

The seed to use

TYPE: Seed | None DEFAULT: None

RETURNS DESCRIPTION
str

A random uid
Source code in src/amltk/randomness.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def randuid(
    k: int = 8,
    *,
    charset: Sequence[str] = ALPHABET,
    seed: Seed | None = None,
) -> str:
    """Generate a random alpha-numeric uuid of a specified length.

    See: https://stackoverflow.com/a/56398787/5332072

    Args:
        k: The length of the uuid to generate
        charset: The charset to use
        seed: The seed to use

    Returns:
        A random uid
    """
    rng = as_rng(seed)
    return "".join(rng.choice(np.asarray(charset), size=k))