pyarrow.compute.ModeOptions

class pyarrow.compute.ModeOptions(n=1, *, skip_nulls=True, min_count=0)

Bases: _ModeOptions

Options for the mode function.

Parameters:

nint, default 1

Number of distinct most-common values to return.

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.

__init__(self, n=1, *, skip_nulls=True, min_count=0)

Methods

__init__(self[, n, skip_nulls, min_count])
deserialize(buf)	Deserialize options for a function.
serialize(self)

static deserialize(buf)

Deserialize options for a function.

Parameters:

bufBuffer

The buffer containing the data to deserialize.

serialize(self)