papyri
This is a pre-release version (2.5.0.dev0+git20251130.2de293a).Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / random / _generator / Generator

class

numpy.random._generator:Generator

source: build-install/usr/lib/python3.14/site-packages/numpy/random/_generator.cpython-314-x86_64-linux-gnu.so

Signature

class Generator(bit_generator)

Members

Summary

Container for the BitGenerators.

Extended Summary

Generator exposes a number of methods for generating random numbers drawn from a variety of probability distributions. In addition to the distribution-specific arguments, each method takes a keyword argument size that defaults to None. If size is None, then a single value is generated and returned. If size is an integer, then a 1-D array filled with generated values is returned. If size is a tuple, then an array with that shape is filled and returned.

The function numpy.random.default_rng will instantiate a Generator with numpy's default BitGenerator.

No Compatibility Guarantee

Generator does not provide a version compatibility guarantee. In particular, as better algorithms evolve the bit stream may change.

Parameters

bit_generator : BitGenerator

BitGenerator to use as the core generator.

Notes

The Python stdlib module random contains pseudo-random number generator with a number of methods that are similar to the ones available in Generator. It uses Mersenne Twister, and this bit generator can be accessed using MT19937. Generator, besides being NumPy-aware, has the advantage that it provides a much larger number of probability distributions to choose from.

Examples

from numpy.random import Generator, PCG64
rng = Generator(PCG64())
✓
rng.standard_normal()
✗
-0.30095154306537975

See also

default_rng

Recommended constructor for Generator.

Aliases

  • numpy.random.Generator

Referenced by

This package

Other packages