diff options
author | Ross Barnowski <rossbar@berkeley.edu> | 2020-04-25 12:34:34 -0700 |
---|---|---|
committer | Ross Barnowski <rossbar@berkeley.edu> | 2020-04-25 12:35:37 -0700 |
commit | 228e1931703c8fe720a0e40116bf9c48a2337151 (patch) | |
tree | cf525a12e569b49f7a28c99139c4ab859b6421cb /doc/source/reference/random/index.rst | |
parent | 619422b493eaf88c42373af1725ac0aa2297fa91 (diff) | |
download | numpy-228e1931703c8fe720a0e40116bf9c48a2337151.tar.gz |
DOC: Added bullet about axis kwarg to rng overview docs.
Modified the introductory/overview documentation for the random
module to highlight the addition of the `axis` kwarg to
methods like `shuffle` and `choice` for dealing with
multi-dimensional arrays.
Related to gh-16075
Diffstat (limited to 'doc/source/reference/random/index.rst')
-rw-r--r-- | doc/source/reference/random/index.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/source/reference/random/index.rst b/doc/source/reference/random/index.rst index bda9c4d96..79e6a285e 100644 --- a/doc/source/reference/random/index.rst +++ b/doc/source/reference/random/index.rst @@ -168,6 +168,9 @@ What's New or Different Python's `random.random`. * All BitGenerators in numpy use `SeedSequence` to convert seeds into initialized states. +* The addition of an ``axis`` keyword argument to methods such as + `Generator.choice` and `Generator.shuffle` improves support for + sampling from and shuffling multi-dimensional arrays. See :ref:`new-or-different` for a complete list of improvements and differences from the traditional ``Randomstate``. |