org.apache.spark.ml.feature
Class HashingTF

Object
  extended by org.apache.spark.ml.PipelineStage
      extended by org.apache.spark.ml.Transformer
          extended by org.apache.spark.ml.feature.HashingTF
All Implemented Interfaces:
java.io.Serializable, Logging, Params

public class HashingTF
extends Transformer

:: Experimental :: Maps a sequence of terms to their term frequencies using the hashing trick.

See Also:
Serialized Form

Constructor Summary
HashingTF()
           
HashingTF(String uid)
           
 
Method Summary
 HashingTF copy(ParamMap extra)
          Creates a copy of this instance with the same UID and some extra params.
 int getNumFeatures()
           
 IntParam numFeatures()
          Number of features.
 HashingTF setInputCol(String value)
           
 HashingTF setNumFeatures(int value)
           
 HashingTF setOutputCol(String value)
           
 DataFrame transform(DataFrame dataset)
          Transforms the input dataset.
 StructType transformSchema(StructType schema)
          :: DeveloperApi ::
 String uid()
           
 
Methods inherited from class org.apache.spark.ml.Transformer
transform, transform, transform
 
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, setDefault, shouldOwn, validateParams
 
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

HashingTF

public HashingTF(String uid)

HashingTF

public HashingTF()
Method Detail

uid

public String uid()

setInputCol

public HashingTF setInputCol(String value)

setOutputCol

public HashingTF setOutputCol(String value)

numFeatures

public IntParam numFeatures()
Number of features. Should be > 0. (default = 2^18^)

Returns:
(undocumented)

getNumFeatures

public int getNumFeatures()

setNumFeatures

public HashingTF setNumFeatures(int 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 HashingTF 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 Transformer
Parameters:
extra - (undocumented)
Returns:
(undocumented)
See Also:
defaultCopy()