diff options
| author | Sebastian Berg <sebastianb@nvidia.com> | 2023-04-28 10:09:53 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-28 10:09:53 +0200 |
| commit | de702b37336781b504d5b13d720cb4ebbbbc97db (patch) | |
| tree | 9fd229437f13a662eaabaab089ef21a3387a2430 /numpy/lib/function_base.py | |
| parent | 1c9532bb8857551d163517bf0028441c7cd544c8 (diff) | |
| parent | 1947415e4d4f4cb75989e194e052431068dbd772 (diff) | |
| download | numpy-de702b37336781b504d5b13d720cb4ebbbbc97db.tar.gz | |
Merge pull request #23529 from lorentzenchr/doc_quantile
DOC: quantile parameter q is a probability
Diffstat (limited to 'numpy/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 277ae3dc4..22371a038 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -3980,8 +3980,8 @@ def percentile(a, a : array_like of real numbers Input array or object that can be converted to an array. q : array_like of float - Percentile or sequence of percentiles to compute, which must be between - 0 and 100 inclusive. + Percentage or sequence of percentages for the percentiles to compute. + Values must be between 0 and 100 inclusive. axis : {int, tuple of int, None}, optional Axis or axes along which the percentiles are computed. The default is to compute the percentile(s) along a flattened @@ -4280,8 +4280,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. @@ -4335,8 +4335,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 |