pyspark.sql.functions.regr_intercept#

pyspark.sql.functions.regr_intercept(y, x)[source]#

Aggregate function: returns the intercept of the univariate linear regression line 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 intercept of the univariate linear regression line for non-null pairs in a group.

Examples

>>> from pyspark.sql import functions as sf
>>> x = (sf.col("id") % 3).alias("x")
>>> y = (sf.randn(42) + x * 10).alias("y")
>>> spark.range(0, 1000, 1, 1).select(x, y).select(
...     sf.regr_intercept("y", "x")
... ).show()
+--------------------+
|regr_intercept(y, x)|
+--------------------+
|-0.04961745990969568|
+--------------------+