summaryrefslogtreecommitdiff
path: root/numpy/random
diff options
context:
space:
mode:
authormattip <matti.picus@gmail.com>2019-11-21 13:13:16 -0800
committermattip <matti.picus@gmail.com>2019-11-21 16:47:30 -0800
commit0a5e42873095af920a5ba1df59cf156ddb5d03f4 (patch)
treeb065e3886fea3f92ea4a2b34fefc14882cbe69d7 /numpy/random
parenta413620ed8c13efc1f513859e3140ad6922d67d0 (diff)
downloadnumpy-0a5e42873095af920a5ba1df59cf156ddb5d03f4.tar.gz
DOC: update note from review
Diffstat (limited to 'numpy/random')
-rw-r--r--numpy/random/mtrand.pyx168
1 files changed, 84 insertions, 84 deletions
diff --git a/numpy/random/mtrand.pyx b/numpy/random/mtrand.pyx
index 928969376..a4d409f37 100644
--- a/numpy/random/mtrand.pyx
+++ b/numpy/random/mtrand.pyx
@@ -380,8 +380,8 @@ cdef class RandomState:
(b - a) * random_sample() + a
.. note::
- New code should use ``default_rng().random`` (see
- `random-quick-start`) instead.
+ New code should use the ``random`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -450,8 +450,8 @@ cdef class RandomState:
It is often seen in Bayesian inference and order statistics.
.. note::
- New code should use ``default_rng().beta`` (see
- `random-quick-start`) instead.
+ New code should use the ``beta`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -500,8 +500,8 @@ cdef class RandomState:
between page requests to Wikipedia [2]_.
.. note::
- New code should use ``default_rng().exponential`` (see
- `random-quick-start`) instead.
+ New code should use the ``exponential`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -549,8 +549,8 @@ cdef class RandomState:
with a scale parameter of 1.
.. note::
- New code should use ``default_rng().standard_exponential`` (see
- `random-quick-start`) instead.
+ New code should use the ``standard_exponential`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -650,8 +650,8 @@ cdef class RandomState:
`high` is None (the default), then results are from [0, `low`).
.. note::
- New code should use ``default_rng().integers`` (see
- `random-quick-start`) instead.
+ New code should use the ``integers`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -772,8 +772,8 @@ cdef class RandomState:
Return random bytes.
.. note::
- New code should use ``default_rng().bytes`` (see
- `random-quick-start`) instead.
+ New code should use the ``bytes`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -810,8 +810,8 @@ cdef class RandomState:
.. versionadded:: 1.7.0
.. note::
- New code should use ``default_rng().choice`` (see
- `random-quick-start`) instead.
+ New code should use the ``choice`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1007,8 +1007,8 @@ cdef class RandomState:
by `uniform`.
.. note::
- New code should use ``default_rng().uniform`` (see
- `random-quick-start`) instead.
+ New code should use the ``uniform`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1168,8 +1168,8 @@ cdef class RandomState:
other NumPy functions like `numpy.zeros` and `numpy.ones`.
.. note::
- New code should use ``default_rng().standard_normal`` (see
- `random-quick-start`) instead.
+ New code should use the ``standard_normal`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
If positive int_like arguments are provided, `randn` generates an array
of shape ``(d0, d1, ..., dn)``, filled
@@ -1322,8 +1322,8 @@ cdef class RandomState:
Draw samples from a standard Normal distribution (mean=0, stdev=1).
.. note::
- New code should use ``default_rng().standard_normal`` (see
- `random-quick-start`) instead.
+ New code should use the ``standard_normal`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1397,8 +1397,8 @@ cdef class RandomState:
unique distribution [2]_.
.. note::
- New code should use ``default_rng().normal`` (see
- `random-quick-start`) instead.
+ New code should use the ``normal`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1497,8 +1497,8 @@ cdef class RandomState:
shape (sometimes designated "k") and scale=1.
.. note::
- New code should use ``default_rng().standard_gamma`` (see
- `random-quick-start`) instead.
+ New code should use the ``standard_gamma`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1578,8 +1578,8 @@ cdef class RandomState:
"theta"), where both parameters are > 0.
.. note::
- New code should use ``default_rng().gamma`` (see
- `random-quick-start`) instead.
+ New code should use the ``gamma`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1667,8 +1667,8 @@ cdef class RandomState:
variates.
.. note::
- New code should use ``default_rng().f`` (see
- `random-quick-start`) instead.
+ New code should use the ``f`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1755,8 +1755,8 @@ cdef class RandomState:
`nonc` is the non-centrality parameter.
.. note::
- New code should use ``default_rng().noncentral_f`` (see
- `random-quick-start`) instead.
+ New code should use the ``noncentral_f`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1840,8 +1840,8 @@ cdef class RandomState:
is often used in hypothesis testing.
.. note::
- New code should use ``default_rng().chisquare`` (see
- `random-quick-start`) instead.
+ New code should use the ``chisquare`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1913,8 +1913,8 @@ cdef class RandomState:
the :math:`\\chi^2` distribution.
.. note::
- New code should use ``default_rng().noncentral_chisquare`` (see
- `random-quick-start`) instead.
+ New code should use the ``noncentral_chisquare`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -1999,8 +1999,8 @@ cdef class RandomState:
Also known as the Lorentz distribution.
.. note::
- New code should use ``default_rng().standard_cauchy`` (see
- `random-quick-start`) instead.
+ New code should use the ``standard_cauchy`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2075,8 +2075,8 @@ cdef class RandomState:
distribution (`standard_normal`).
.. note::
- New code should use ``default_rng().standard_t`` (see
- `random-quick-start`) instead.
+ New code should use the ``standard_t`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2180,8 +2180,8 @@ cdef class RandomState:
distribution.
.. note::
- New code should use ``default_rng().vonmises`` (see
- `random-quick-start`) instead.
+ New code should use the ``vonmises`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2278,8 +2278,8 @@ cdef class RandomState:
remaining 80 percent of the range.
.. note::
- New code should use ``default_rng().pareto`` (see
- `random-quick-start`) instead.
+ New code should use the ``pareto`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2372,8 +2372,8 @@ cdef class RandomState:
:math:`\\lambda` is just :math:`X = \\lambda(-ln(U))^{1/a}`.
.. note::
- New code should use ``default_rng().weibull`` (see
- `random-quick-start`) instead.
+ New code should use the ``weibull`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2468,8 +2468,8 @@ cdef class RandomState:
Also known as the power function distribution.
.. note::
- New code should use ``default_rng().power`` (see
- `random-quick-start`) instead.
+ New code should use the ``power`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2579,8 +2579,8 @@ cdef class RandomState:
random variables.
.. note::
- New code should use ``default_rng().laplace`` (see
- `random-quick-start`) instead.
+ New code should use the ``laplace`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2670,8 +2670,8 @@ cdef class RandomState:
Notes and References below.
.. note::
- New code should use ``default_rng().gumbel`` (see
- `random-quick-start`) instead.
+ New code should use the ``gumbel`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2792,8 +2792,8 @@ cdef class RandomState:
parameters, loc (location or mean, also median), and scale (>0).
.. note::
- New code should use ``default_rng().logistic`` (see
- `random-quick-start`) instead.
+ New code should use the ``logistic`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2879,8 +2879,8 @@ cdef class RandomState:
underlying normal distribution it is derived from.
.. note::
- New code should use ``default_rng().lognormal`` (see
- `random-quick-start`) instead.
+ New code should use the ``lognormal`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -2992,8 +2992,8 @@ cdef class RandomState:
Rayleigh.
.. note::
- New code should use ``default_rng().rayleigh`` (see
- `random-quick-start`) instead.
+ New code should use the ``rayleigh`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3074,8 +3074,8 @@ cdef class RandomState:
unit distance and distance covered in unit time.
.. note::
- New code should use ``default_rng().wald`` (see
- `random-quick-start`) instead.
+ New code should use the ``wald`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3147,8 +3147,8 @@ cdef class RandomState:
directly define the shape of the pdf.
.. note::
- New code should use ``default_rng().triangular`` (see
- `random-quick-start`) instead.
+ New code should use the ``triangular`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3254,8 +3254,8 @@ cdef class RandomState:
input as a float, but it is truncated to an integer in use)
.. note::
- New code should use ``default_rng().binomial`` (see
- `random-quick-start`) instead.
+ New code should use the ``binomial`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3404,8 +3404,8 @@ cdef class RandomState:
is > 0 and `p` is in the interval [0, 1].
.. note::
- New code should use ``default_rng().negative_binomial`` (see
- `random-quick-start`) instead.
+ New code should use the ``negative_binomial`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3489,8 +3489,8 @@ cdef class RandomState:
for large N.
.. note::
- New code should use ``default_rng().poisson`` (see
- `random-quick-start`) instead.
+ New code should use the ``poisson`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3575,8 +3575,8 @@ cdef class RandomState:
frequency table.
.. note::
- New code should use ``default_rng().zipf`` (see
- `random-quick-start`) instead.
+ New code should use the ``zipf`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3665,8 +3665,8 @@ cdef class RandomState:
where `p` is the probability of success of an individual trial.
.. note::
- New code should use ``default_rng().geometric`` (see
- `random-quick-start`) instead.
+ New code should use the ``geometric`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3719,8 +3719,8 @@ cdef class RandomState:
than or equal to the sum ``ngood + nbad``).
.. note::
- New code should use ``default_rng().hypergeometric`` (see
- `random-quick-start`) instead.
+ New code should use the ``hypergeometric`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3850,8 +3850,8 @@ cdef class RandomState:
shape parameter, 0 < ``p`` < 1.
.. note::
- New code should use ``default_rng().logseries`` (see
- `random-quick-start`) instead.
+ New code should use the ``logseries`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -3943,8 +3943,8 @@ cdef class RandomState:
squared) of the one-dimensional normal distribution.
.. note::
- New code should use ``default_rng().multivariate_normal`` (see
- `random-quick-start`) instead.
+ New code should use the ``multivariate_normal`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -4117,8 +4117,8 @@ cdef class RandomState:
outcome was ``i``.
.. note::
- New code should use ``default_rng().multinomial`` (see
- `random-quick-start`) instead.
+ New code should use the ``multinomial`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -4235,8 +4235,8 @@ cdef class RandomState:
inference.
.. note::
- New code should use ``default_rng().dirichlet`` (see
- `random-quick-start`) instead.
+ New code should use the ``dirichlet`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -4380,8 +4380,8 @@ cdef class RandomState:
their contents remains the same.
.. note::
- New code should use ``default_rng().shuffle`` (see
- `random-quick-start`) instead.
+ New code should use the ``shuffle`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------
@@ -4475,8 +4475,8 @@ cdef class RandomState:
first index.
.. note::
- New code should use ``default_rng().permutation`` (see
- `random-quick-start`) instead.
+ New code should use the ``permutation`` method of a ``default_rng()``
+ instance instead; see `random-quick-start`.
Parameters
----------