Package org.apache.spark.ml.stat

Class SummaryBuilder

Object

org.apache.spark.ml.stat.SummaryBuilder

public abstract class SummaryBuilder
extends Object

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 Summarizer.

Constructor Summary

Constructors

Constructor	Description
SummaryBuilder()

Method Summary

Modifier and Type	Method	Description
Column	summary(Column featuresCol)
abstract Column	summary(Column featuresCol, Column weightCol)	Returns an aggregate object that contains the summary of the column with the requested metrics.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SummaryBuilder

public SummaryBuilder()

Method Details

summary

public abstract Column summary(Column featuresCol,
 Column weightCol)

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

Parameters:

featuresCol - a column that contains features Vector object.

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

Returns:

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

summary

public Column summary(Column featuresCol)