pyspark.sql.functions.regr_r2

pyspark.sql.functions.regr_r2(y: ColumnOrName, x: ColumnOrName) → pyspark.sql.column.Column

Aggregate function: returns the coefficient of determination for non-null pairs in a group, where y is the dependent variable and x is the independent variable.

New in version 3.5.0.

Parameters

yColumn or str

the dependent variable.

xColumn or str

the independent variable.

Returns

Column

the coefficient of determination for non-null pairs in a group.

Examples

>>> x = (col("id") % 3).alias("x")
>>> y = (randn(42) + x * 10).alias("y")
>>> df = spark.range(0, 1000, 1, 1).select(x, y)
>>> df.select(regr_r2("y", "x")).first()
Row(regr_r2(y, x)=0.9851908293645436)

previous

pyspark.sql.functions.regr_intercept

next

pyspark.sql.functions.regr_slope