org.apache.spark.ml.feature

Class IDF

java.lang.Object

org.apache.spark.ml.PipelineStage

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

org.apache.spark.ml.feature.IDF

All Implemented Interfaces:

java.io.Serializable, 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(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	$(Param<T> param)
static Params	clear(Param<?> param)
IDF	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
protected static <T extends Params> T	copyValues(T to, ParamMap extra)
protected static <T extends Params> ParamMap	copyValues$default$2()
protected static <T extends Params> T	defaultCopy(ParamMap extra)
static java.lang.String	explainParam(Param<?> param)
static java.lang.String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
IDFModel	fit(Dataset<?> dataset) Fits a model to the input data.
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static java.lang.String	getInputCol()
java.lang.String	getInputCol()
static int	getMinDocFreq()
int	getMinDocFreq()
static <T> T	getOrDefault(Param<T> param)
static java.lang.String	getOutputCol()
java.lang.String	getOutputCol()
static Param<java.lang.Object>	getParam(java.lang.String paramName)
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(java.lang.String paramName)
protected static void	initializeLogIfNecessary(boolean isInterpreter)
static Param<java.lang.String>	inputCol()
Param<java.lang.String>	inputCol() Param for input column name.
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
protected static boolean	isTraceEnabled()
static IDF	load(java.lang.String path)
protected static org.slf4j.Logger	log()
protected static void	logDebug(scala.Function0<java.lang.String> msg)
protected static void	logDebug(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logError(scala.Function0<java.lang.String> msg)
protected static void	logError(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logInfo(scala.Function0<java.lang.String> msg)
protected static void	logInfo(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static java.lang.String	logName()
protected static void	logTrace(scala.Function0<java.lang.String> msg)
protected static void	logTrace(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logWarning(scala.Function0<java.lang.String> msg)
protected static void	logWarning(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
static IntParam	minDocFreq()
IntParam	minDocFreq() The minimum of documents in which a term should appear.
static Param<java.lang.String>	outputCol()
Param<java.lang.String>	outputCol() Param for output column name.
static Param<?>[]	params()
static void	save(java.lang.String path)
static <T> Params	set(Param<T> param, T value)
protected static Params	set(ParamPair<?> paramPair)
protected static Params	set(java.lang.String param, java.lang.Object value)
protected static <T> Params	setDefault(Param<T> param, T value)
protected static Params	setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)
IDF	setInputCol(java.lang.String value)
IDF	setMinDocFreq(int value)
IDF	setOutputCol(java.lang.String value)
static java.lang.String	toString()
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
protected static StructType	validateAndTransformSchema(StructType schema)
StructType	validateAndTransformSchema(StructType schema) Validate and transform the input schema.
static void	validateParams()
static MLWriter	write()

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

fit, fit, fit, fit

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

Constructor Detail

IDF

public IDF(java.lang.String uid)

IDF

public IDF()

Method Detail

load

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

toString

public static java.lang.String toString()

params

public static Param<?>[] params()

validateParams

public static void validateParams()

explainParam

public static java.lang.String explainParam(Param<?> param)

explainParams

public static java.lang.String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(java.lang.String paramName)

getParam

public static Param<java.lang.Object> getParam(java.lang.String paramName)

set

public static final <T> Params set(Param<T> param,
             T value)

set

protected static final Params set(java.lang.String param,
         java.lang.Object value)

set

protected static final Params set(ParamPair<?> paramPair)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

$

protected static final <T> T $(Param<T> param)

setDefault

protected static final <T> Params setDefault(Param<T> param,
                    T value)

setDefault

protected static final Params setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

defaultCopy

protected static final <T extends Params> T defaultCopy(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

copyValues

protected static <T extends Params> T copyValues(T to,
                              ParamMap extra)

copyValues$default$2

protected static <T extends Params> ParamMap copyValues$default$2()

logName

protected static java.lang.String logName()

log

protected static org.slf4j.Logger log()

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg)

logError

protected static void logError(scala.Function0<java.lang.String> msg)

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg,
           java.lang.Throwable throwable)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg,
              java.lang.Throwable throwable)

logError

protected static void logError(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

isTraceEnabled

protected static boolean isTraceEnabled()

initializeLogIfNecessary

protected static void initializeLogIfNecessary(boolean isInterpreter)

inputCol

public static final Param<java.lang.String> inputCol()

getInputCol

public static final java.lang.String getInputCol()

outputCol

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

getOutputCol

public static final java.lang.String getOutputCol()

minDocFreq

public static final IntParam minDocFreq()

getMinDocFreq

public static int getMinDocFreq()

validateAndTransformSchema

protected static StructType validateAndTransformSchema(StructType schema)

save

public static void save(java.lang.String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

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

setOutputCol

public IDF setOutputCol(java.lang.String value)

setMinDocFreq

public IDF setMinDocFreq(int value)

fit

public IDFModel fit(Dataset<?> 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<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()