org.apache.spark.ml.feature

Class IDF

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<IDFModel>

org.apache.spark.ml.feature.IDF

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public final class IDF
extends Estimator<IDFModel>

:: Experimental :: Compute the Inverse Document Frequency (IDF) given a collection of documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IDF()
IDF(String uid)

Method Summary

Methods

Modifier and Type	Method and Description
IDF	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
IDFModel	fit(DataFrame dataset) Fits a model to the input data.
String	getInputCol()
int	getMinDocFreq()
String	getOutputCol()
Param<String>	inputCol() Param for input column name.
static IDF	load(String path)
IntParam	minDocFreq() The minimum of documents in which a term should appear.
Param<String>	outputCol() Param for output column name.
IDF	setInputCol(String value)
IDF	setMinDocFreq(int value)
IDF	setOutputCol(String value)
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema) Validate and transform the input schema.

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

IDF

public IDF(String uid)

IDF

public IDF()

Method Detail

load

public static IDF load(String path)

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

setInputCol

public IDF setInputCol(String value)

setOutputCol

public IDF setOutputCol(String value)

setMinDocFreq

public IDF setMinDocFreq(int value)

fit

public IDFModel fit(DataFrame dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<IDFModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public IDF copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly.

Specified by:

copy in interface Params

Specified by:

copy in class Estimator<IDFModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

minDocFreq

public IntParam minDocFreq()

The minimum of documents in which a term should appear. Default: 0

Returns:

(undocumented)

getMinDocFreq

public int getMinDocFreq()

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema)

Validate and transform the input schema.

Parameters:

schema - (undocumented)

Returns:

(undocumented)

inputCol

public Param<String> inputCol()

Param for input column name.

Returns:

(undocumented)

getInputCol

public String getInputCol()

outputCol

public Param<String> outputCol()

Param for output column name.

Returns:

(undocumented)

getOutputCol

public String getOutputCol()