pyspark.sql.functions.mode¶

pyspark.sql.functions.mode(col: ColumnOrName) → pyspark.sql.column.Column[source]¶

Returns the most frequent value in a group.

New in version 3.4.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

colColumn or str: target column to compute on.

Returns

Column: the most frequent value in a group.

Examples

>>> df = spark.createDataFrame([
...     ("Java", 2012, 20000), ("dotNET", 2012, 5000),
...     ("Java", 2012, 20000), ("dotNET", 2012, 5000),
...     ("dotNET", 2013, 48000), ("Java", 2013, 30000)],
...     schema=("course", "year", "earnings"))
>>> df.groupby("course").agg(mode("year")).show()
+------+----------+
|course|mode(year)|
+------+----------+
|  Java|      2012|
|dotNET|      2012|
+------+----------+

pyspark.sql.functions.min_by pyspark.sql.functions.percentile_approx