diff options
author | Christian Lorentzen <lorentzen.ch@gmail.com> | 2023-04-04 23:39:14 +0200 |
---|---|---|
committer | Christian Lorentzen <lorentzen.ch@gmail.com> | 2023-04-04 23:39:14 +0200 |
commit | 819d92116bd08a3732becd9895d48618588be3ba (patch) | |
tree | 2b9a3ea917fe60c6be8eb73c013563ff57054486 /numpy/lib/function_base.py | |
parent | ea0b1708b27e683201285da53c6afda24bc8ba74 (diff) | |
download | numpy-819d92116bd08a3732becd9895d48618588be3ba.tar.gz |
DOC quantile q is a probability
Diffstat (limited to 'numpy/lib/function_base.py')
-rw-r--r-- | numpy/lib/function_base.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 405790025..3a2d9b792 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -4237,8 +4237,8 @@ def quantile(a, a : array_like of real numbers Input array or object that can be converted to an array. q : array_like of float - Quantile or sequence of quantiles to compute, which must be between - 0 and 1 inclusive. + Probability or sequence of probabilities for the quantiles to compute. + Values must be between 0 and 1 inclusive. axis : {int, tuple of int, None}, optional Axis or axes along which the quantiles are computed. The default is to compute the quantile(s) along a flattened version of the array. @@ -4292,8 +4292,8 @@ def quantile(a, Returns ------- quantile : scalar or ndarray - If `q` is a single quantile and `axis=None`, then the result - is a scalar. If multiple quantiles are given, first axis of + If `q` is a single probability and `axis=None`, then the result + is a scalar. If multiple probabilies levels are given, first axis of the result corresponds to the quantiles. The other axes are the axes that remain after the reduction of `a`. If the input contains integers or floats smaller than ``float64``, the output |