default_rng#

scikitplot.random.default_rng(seed=None, bit_width=None)#

Create default KISS random number generator.

This is the recommended way to create an RNG, matching numpy.random.default_rng() signature.

Parameters:
seed{None, int, KissSeedSequence, KissBitGenerator, KissGenerator, KissRandomState}, optional

Random seed or generator

Returns:
KissGenerator

Initialized bit generator ready for use

bit_widthint, default=64

Generator bit width

Raises:
ValueError

If bit_width not in {32, 64}

See also

Kiss32Random

32-bit version for smaller datasets

Kiss64Random

64-bit version for larger datasets

KissRandom

Factory function for auto-detecting

KissSeedSequence

Seed sequence for initialization

KissBitGenerator

NumPy-compatible bit generator

KissGenerator

High-level generator using this BitGenerator

KissRandomState

Inherites from KissGenerator

Notes

This is the recommended entry point for most users. Compatible with numpy.random.default_rng() interface.

Examples

>>> from scikitplot.random import default_rng
>>>
>>> rng = default_rng(42)
>>> rng.random(5)
>>> rng.integers(0, 100, 10)
>>> rng.normal(0, 1, 1000)
>>>
>>> # Context manager
>>> with default_rng(42) as rng:
...     data = rng.random(1000)
>>>
>>> # Serialization
>>> import pickle
>>> restored = pickle.loads(pickle.dumps(rng))