org.apache.spark.ml.feature

Class IDFModel

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

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

org.apache.spark.ml.feature.IDFModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable, MLWritable

public class IDFModel
extends Model<IDFModel>
implements MLWritable

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
IDFModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
java.lang.String	getInputCol()
int	getMinDocFreq()
java.lang.String	getOutputCol()
Vector	idf()
Param<java.lang.String>	inputCol() Param for input column name.
static IDFModel	load(java.lang.String path)
IntParam	minDocFreq() The minimum of documents in which a term should appear.
Param<java.lang.String>	outputCol() Param for output column name.
static MLReader<IDFModel>	read()
IDFModel	setInputCol(java.lang.String value)
IDFModel	setOutputCol(java.lang.String value)
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema) Validate and transform the input schema.
MLWriter	write() Returns an MLWriter instance for this ML instance.

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

hasParent, parent, setParent

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

transform, transform, transform

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

transformSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, 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.ml.util.MLWritable

save

Methods inherited from interface org.apache.spark.Logging

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

Method Detail

read

public static MLReader<IDFModel> read()

load

public static IDFModel load(java.lang.String path)

uid

public java.lang.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 IDFModel setInputCol(java.lang.String value)

setOutputCol

public IDFModel setOutputCol(java.lang.String value)

transform

public DataFrame transform(DataFrame dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

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 IDFModel 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 Model<IDFModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

idf

public Vector idf()

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

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<java.lang.String> inputCol()

Param for input column name.

Returns:

(undocumented)

getInputCol

public java.lang.String getInputCol()

outputCol

public Param<java.lang.String> outputCol()

Param for output column name.

Returns:

(undocumented)

getOutputCol

public java.lang.String getOutputCol()