StopWordsRemover (Spark 2.2.0 JavaDoc)

Object
- org.apache.spark.ml.PipelineStage
- - org.apache.spark.ml.Transformer
  - - org.apache.spark.ml.feature.StopWordsRemover

All Implemented Interfaces:

java.io.Serializable, Logging, Params, DefaultParamsWritable, Identifiable, MLWritable
```
public class StopWordsRemover
extends Transformer
implements DefaultParamsWritable
```
A feature transformer that filters out stop words from input.

See Also:

Stop words (Wikipedia), Serialized Form

Note:

null values from input array are preserved unless adding null to stopWords explicitly.

Constructor Summary

Constructors
Constructor and Description

StopWordsRemover()

StopWordsRemover(String uid)

Constructors
Constructor and Description
`StopWordsRemover()`
`StopWordsRemover(String uid)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BooleanParam`	`caseSensitive()` Whether to do a case sensitive comparison over the stop words.
`static Params`	`clear(Param<?> param)`
`StopWordsRemover`	`copy(ParamMap extra)` Creates a copy of this instance with the same UID and some extra params.
`static String`	`explainParam(Param<?> param)`
`static String`	`explainParams()`
`static ParamMap`	`extractParamMap()`
`static ParamMap`	`extractParamMap(ParamMap extra)`
`static <T> scala.Option<T>`	`get(Param<T> param)`
`boolean`	`getCaseSensitive()`
`static <T> scala.Option<T>`	`getDefault(Param<T> param)`
`static String`	`getInputCol()`
`static <T> T`	`getOrDefault(Param<T> param)`
`static String`	`getOutputCol()`
`static Param<Object>`	`getParam(String paramName)`
`String[]`	`getStopWords()`
`static <T> boolean`	`hasDefault(Param<T> param)`
`static boolean`	`hasParam(String paramName)`
`static Param<String>`	`inputCol()`
`static boolean`	`isDefined(Param<?> param)`
`static boolean`	`isSet(Param<?> param)`
`static StopWordsRemover`	`load(String path)`
`static String[]`	`loadDefaultStopWords(String language)` Loads the default stop words for the given language.
`static Param<String>`	`outputCol()`
`static Param<?>[]`	`params()`
`static void`	`save(String path)`
`static <T> Params`	`set(Param<T> param, T value)`
`StopWordsRemover`	`setCaseSensitive(boolean value)`
`StopWordsRemover`	`setInputCol(String value)`
`StopWordsRemover`	`setOutputCol(String value)`
`StopWordsRemover`	`setStopWords(String[] value)`
`StringArrayParam`	`stopWords()` The words to be filtered out.
`static String`	`toString()`
`Dataset<Row>`	`transform(Dataset<?> dataset)` Transforms the input dataset.
`StructType`	`transformSchema(StructType schema)` :: DeveloperApi ::
`String`	`uid()` An immutable unique ID for the object and its derivatives.
`static MLWriter`	`write()`

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.util.DefaultParamsWritable
write

Methods inherited from interface org.apache.spark.ml.util.MLWritable
save

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

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

Methods inherited from interface org.apache.spark.internal.Logging
initializeLogging, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

- Constructor Detail
  - StopWordsRemover
```
public StopWordsRemover(String uid)
```
  - StopWordsRemover
```
public StopWordsRemover()
```
- Method Detail
  - load
```
public static StopWordsRemover load(String path)
```
  - loadDefaultStopWords
```
public static String[] loadDefaultStopWords(String language)
```
    Loads the default stop words for the given language. Supported languages: danish, dutch, english, finnish, french, german, hungarian, italian, norwegian, portuguese, russian, spanish, swedish, turkish
    
    Parameters:
    
    language - (undocumented)
    
    Returns:
    
    (undocumented)
    
    See Also:
    
    here
  - toString
```
public static String toString()
```
  - params
```
public static Param<?>[] params()
```
  - explainParam
```
public static String explainParam(Param<?> param)
```
  - explainParams
```
public static String explainParams()
```
  - isSet
```
public static final boolean isSet(Param<?> param)
```
  - isDefined
```
public static final boolean isDefined(Param<?> param)
```
  - hasParam
```
public static boolean hasParam(String paramName)
```
  - getParam
```
public static Param<Object> getParam(String paramName)
```
  - set
```
public static final <T> Params set(Param<T> param,
                                   T value)
```
  - 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)
```
  - getDefault
```
public static final <T> scala.Option<T> getDefault(Param<T> param)
```
  - hasDefault
```
public static final <T> boolean hasDefault(Param<T> param)
```
  - extractParamMap
```
public static final ParamMap extractParamMap(ParamMap extra)
```
  - extractParamMap
```
public static final ParamMap extractParamMap()
```
  - inputCol
```
public static final Param<String> inputCol()
```
  - getInputCol
```
public static final String getInputCol()
```
  - outputCol
```
public static final Param<String> outputCol()
```
  - getOutputCol
```
public static final String getOutputCol()
```
  - save
```
public static void save(String path)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - write
```
public static MLWriter write()
```
  - 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 StopWordsRemover setInputCol(String value)
```
  - setOutputCol
```
public StopWordsRemover setOutputCol(String value)
```
  - stopWords
```
public StringArrayParam stopWords()
```
    The words to be filtered out. Default: English stop words
    
    Returns:
    
    (undocumented)
    
    See Also:
    
    StopWordsRemover.loadDefaultStopWords()
  - setStopWords
```
public StopWordsRemover setStopWords(String[] value)
```
  - getStopWords
```
public String[] getStopWords()
```
  - caseSensitive
```
public BooleanParam caseSensitive()
```
    Whether to do a case sensitive comparison over the stop words. Default: false
    
    Returns:
    
    (undocumented)
  - setCaseSensitive
```
public StopWordsRemover setCaseSensitive(boolean value)
```
  - getCaseSensitive
```
public boolean getCaseSensitive()
```
  - transform
```
public Dataset<Row> transform(Dataset<?> 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 ::
    Check transform validity and derive the output schema from the input schema.
    We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().
    Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.
    
    Specified by:
    
    transformSchema in class PipelineStage
    
    Parameters:
    
    schema - (undocumented)
    
    Returns:
    
    (undocumented)
  - copy
```
public StopWordsRemover 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. See defaultCopy().
    
    Specified by:
    
    copy in interface Params
    
    Specified by:
    
    copy in class Transformer
    
    Parameters:
    
    extra - (undocumented)
    
    Returns:
    
    (undocumented)

Class StopWordsRemover

Constructor Summary

Method Summary

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

Methods inherited from class Object

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

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

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

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

Methods inherited from interface org.apache.spark.internal.Logging

Constructor Detail

StopWordsRemover

StopWordsRemover

Method Detail

load

loadDefaultStopWords

toString

params

explainParam

explainParams

isSet

isDefined

hasParam

getParam

set

get

clear

getOrDefault

getDefault

hasDefault

extractParamMap

extractParamMap

inputCol

getInputCol

outputCol

getOutputCol

save

write

uid

setInputCol

setOutputCol

stopWords

setStopWords

getStopWords

caseSensitive

setCaseSensitive

getCaseSensitive

transform

transformSchema

copy