pyarrow.compute.tdigest#

pyarrow.compute.tdigest(array, /, q=0.5, *, delta=100, buffer_size=500, skip_nulls=True, min_count=0, options=None, memory_pool=None)#

Approximate quantiles of a numeric array with T-Digest algorithm.

By default, 0.5 quantile (median) is returned. Nulls and NaNs are ignored. An array of nulls is returned if there is no valid data point.

Parameters:

arrayArray-like

Argument to compute function.

qdouble or sequence of double, default 0.5

Probability levels of the quantiles to approximate. All values must be in [0, 1].

deltaint, default 100

Compression parameter for the T-digest algorithm.

buffer_sizeint, default 500

Buffer size for the T-digest algorithm.

skip_nullsbool, default True

Whether to skip (ignore) nulls in the input. If False, any null in the input forces the output to null.

min_countint, default 0

Minimum number of non-null values in the input. If the number of non-null values is below min_count, the output is null.

optionspyarrow.compute.TDigestOptions, optional

Alternative way of passing options.

memory_poolpyarrow.MemoryPool, optional

If not passed, will allocate memory from the default memory pool.