pyspark.sql.functions.vector_avg

pyspark.sql.functions.vector_avg(col)

Aggregate function: returns the element-wise mean of float vectors in a group. All vectors must have the same dimension.

Added in version 4.3.0.

Parameters:

colColumn or column name

input vector column.

Returns:

Column

the element-wise average vector as an array of floats.

Examples

>>> from pyspark.sql import functions as sf
>>> from pyspark.sql.types import ArrayType, FloatType, StructType, StructField
>>> schema = StructType([StructField('v', ArrayType(FloatType()))])
>>> df = spark.createDataFrame([([1.0, 2.0],), ([3.0, 4.0],)], schema)
>>> df.select(sf.vector_avg('v')).first()[0]
[2.0, 3.0]