SummaryBuilder

class pyspark.ml.stat.SummaryBuilder(jSummaryBuilder: JavaObject)

A builder object that provides summary statistics about a given column.

Users should not directly create such builders, but instead use one of the methods in pyspark.ml.stat.Summarizer

Methods

summary(featuresCol[, weightCol])

Returns an aggregate object that contains the summary of the column with the requested metrics.

Methods Documentation

summary(featuresCol: pyspark.sql.column.Column, weightCol: Optional[pyspark.sql.column.Column] = None) → pyspark.sql.column.Column

Returns an aggregate object that contains the summary of the column with the requested metrics.

Parameters
featuresColstr

a column that contains features Vector object.

weightColstr, optional

a column that contains weight value. Default weight is 1.0.

Returns
pyspark.sql.Column

an aggregate column that contains the statistics. The exact content of this structure is determined during the creation of the builder.