bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / quantile
_ArrayFunctionDispatcher
numpy:quantile
source: /dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/lib/_function_base_impl.py :4246
Signature
def quantile ( a , q , axis = None , out = None , overwrite_input = False , method = linear , keepdims = False , * , weights = None ) Summary
Compute the q-th quantile of the data along the specified axis.
Parameters
a: array_like of real numbersInput array or object that can be converted to an array.
q: array_like of floatProbability or sequence of probabilities of the quantiles to compute. Values must be between 0 and 1 inclusive.
axis: {int, tuple of int, None}, optionalAxis or axes along which the quantiles are computed. The default is to compute the quantile(s) along a flattened version of the array.
out: ndarray, optionalAlternative output array in which to place the result. It must have the same shape and buffer length as the expected output, but the type (of the output) will be cast if necessary.
overwrite_input: bool, optionalIf True, then allow the input array
ato be modified by intermediate calculations, to save memory. In this case, the contents of the inputaafter this function completes is undefined.method: str, optionalThis parameter specifies the method to use for estimating the quantile. There are many different methods, some unique to NumPy. The recommended options, numbered as they appear in [1], are:
'inverted_cdf'
'averaged_inverted_cdf'
'closest_observation'
'interpolated_inverted_cdf'
'hazen'
'weibull'
'linear' (default)
'median_unbiased'
'normal_unbiased'
The first three methods are discontinuous. For backward compatibility with previous versions of NumPy, the following discontinuous variations of the default 'linear' (7.) option are available:
'lower'
'higher',
'midpoint'
'nearest'
See Notes for details.
keepdims: bool, optionalIf this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original array
a.weights: array_like, optionalAn array of weights associated with the values in
a. Each value inacontributes to the quantile according to its associated weight. The weights array can either be 1-D (in which case its length must be the size ofaalong the given axis) or of the same shape asa. Ifweights=None, then all data inaare assumed to have a weight equal to one. Onlymethod="inverted_cdf"supports weights. See the notes for more details.
Returns
quantile: scalar or ndarrayIf
qis a single probability andaxis=None, then the result is a scalar. If multiple probability levels are given, first axis of the result corresponds to the quantiles. The other axes are the axes that remain after the reduction ofa. If the input contains integers or floats smaller thanfloat64, the output data-type isfloat64. Otherwise, the output data-type is the same as that of the input. Ifoutis specified, that array is returned instead.
Notes
Given a sample a from an underlying distribution, quantile provides a nonparametric estimate of the inverse cumulative distribution function.
By default, this is done by interpolating between adjacent elements in y, a sorted copy of a:
(1-g)*y[j] + g*y[j+1]where the index j and coefficient g are the integral and fractional components of q * (n-1), and n is the number of elements in the sample.
This is a special case of Equation 1 of H&F [1]. More generally,
j = (q*n + m - 1) // 1, andg = (q*n + m - 1) % 1,
where m may be defined according to several different conventions. The preferred convention may be selected using the method parameter:
=============================== =============== =============== ``method`` number in H&F ``m`` =============================== =============== =============== ``interpolated_inverted_cdf`` 4 ``0`` ``hazen`` 5 ``1/2`` ``weibull`` 6 ``q`` ``linear`` (default) 7 ``1 - q`` ``median_unbiased`` 8 ``q/3 + 1/3`` ``normal_unbiased`` 9 ``q/4 + 3/8`` =============================== =============== ===============
Note that indices j and j + 1 are clipped to the range 0 to n - 1 when the results of the formula would be outside the allowed range of non-negative indices. The - 1 in the formulas for j and g accounts for Python's 0-based indexing.
The table above includes only the estimators from H&F that are continuous functions of probability q (estimators 4-9). NumPy also provides the three discontinuous estimators from H&F (estimators 1-3), where j is defined as above, m is defined as follows, and g is a function of the real-valued index = q*n + m - 1 and j.
inverted_cdf:m = 0andg = int(index - j > 0)averaged_inverted_cdf:m = 0andg = (1 + int(index - j > 0)) / 2closest_observation:m = -1/2andg = 1 - int((index == j) & (j%2 == 1))
For backward compatibility with previous versions of NumPy, quantile provides four additional discontinuous estimators. Like method='linear', all have m = 1 - q so that j = q*(n-1) // 1, but g is defined as follows.
lower:g = 0midpoint:g = 0.5higher:g = 1nearest:g = (q*(n-1) % 1) > 0.5
Weighted quantiles: More formally, the quantile at probability level of a cumulative distribution function with probability measure is defined as any number that fulfills the coverage conditions
with random variable . Sample quantiles, the result of quantile, provide nonparametric estimation of the underlying population counterparts, represented by the unknown , given a data vector a of length n.
Some of the estimators above arise when one considers as the empirical distribution function of the data, i.e. . Then, different methods correspond to different choices of that fulfill the above coverage conditions. Methods that follow this approach are inverted_cdf and averaged_inverted_cdf.
For weighted quantiles, the coverage conditions still hold. The empirical cumulative distribution is simply replaced by its weighted version, i.e. . Only method="inverted_cdf" supports weights.
Examples
import numpy as np a = np.array([[10, 7, 4], [3, 2, 1]]) a✓
np.quantile(a, 0.5)
✗np.quantile(a, 0.5, axis=0)
✓np.quantile(a, 0.5, axis=1)
✗np.quantile(a, 0.5, axis=1, keepdims=True) m = np.quantile(a, 0.5, axis=0) out = np.zeros_like(m) np.quantile(a, 0.5, axis=0, out=out) m b = a.copy()✓
np.quantile(b, 0.5, axis=1, overwrite_input=True)
✗assert not np.all(a == b)
✓See also
- mean
- median
equivalent to
quantile(..., 0.5)- nanquantile
- percentile
equivalent to quantile, but with q in the range [0, 100].
Aliases
-
numpy.quantile