diff options
| author | Robert Kern <robert.kern@gmail.com> | 2023-04-14 01:14:05 -0400 |
|---|---|---|
| committer | Robert Kern <robert.kern@gmail.com> | 2023-04-14 01:18:39 -0400 |
| commit | 188b8a08f01a8b154fe8554f31406ce7650547c0 (patch) | |
| tree | d3983dbd13cda46853bdc140aac3209bfcebde31 /doc/source/reference/random/index.rst | |
| parent | 4268399a93889de55c3c405fd1d4c9e8d7f6b04a (diff) | |
| download | numpy-188b8a08f01a8b154fe8554f31406ce7650547c0.tar.gz | |
DOC: compatibility note
Diffstat (limited to 'doc/source/reference/random/index.rst')
| -rw-r--r-- | doc/source/reference/random/index.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/reference/random/index.rst b/doc/source/reference/random/index.rst index f9717104c..666a2d7d8 100644 --- a/doc/source/reference/random/index.rst +++ b/doc/source/reference/random/index.rst @@ -235,6 +235,15 @@ matrix decomposition algorithm from the LAPACK that it links to, causing valid!) results. We strive to prefer algorithms that are more resistant to these effects, but this is always imperfect. +.. note:: + + Most of the `Generator` methods allow you to draw multiple values from + a distribution as arrays. The requested size of this array is a parameter, + for the purposes of the above policy. Calling ``rng.random()`` 5 times is + not *guaranteed* to give the same numbers as ``rng.random(5)``. We reserve + the ability to decide to use different algorithms for different-sized + blocks. In practice, this happens rarely. + Like the rest of Numpy, we generally maintain API source compatibility from version to version. If we *must* make an API-breaking change, then we will only do so with an appropriate deprecation period and |