pyspark.sql.functions.percent_rank#

pyspark.sql.functions.percent_rank()[source]#

Window function: returns the relative rank (i.e. percentile) of rows within a window partition.

New in version 1.6.0.

Changed in version 3.4.0: Supports Spark Connect.

Returns

Column: the column for calculating relative rank.

Examples

>>> from pyspark.sql import functions as sf
>>> from pyspark.sql import Window
>>> df = spark.createDataFrame([1, 1, 2, 3, 3, 4], "int")
>>> w = Window.orderBy("value")
>>> df.withColumn("pr", sf.percent_rank().over(w)).show()
+-----+---+
|value| pr|
+-----+---+
|    1|0.0|
|    1|0.0|
|    2|0.4|
|    3|0.6|
|    3|0.6|
|    4|1.0|
+-----+---+