weka.filters.unsupervised.attribute

Class Dl4jStringToWordEmbeddings

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.Dl4jStringToWordEmbeddings

All Implemented Interfaces:

java.io.Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler

Direct Known Subclasses:

Dl4jStringToWord2Vec

public abstract class Dl4jStringToWordEmbeddings
extends weka.filters.SimpleBatchFilter

An abstract attribute filter that calculates word embeddings on a String attribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Dl4jStringToWordEmbeddings()

Method Summary

Modifier and Type	Method and Description
weka.filters.unsupervised.attribute.Dl4jStringToWordEmbeddings.Action	getAction()
weka.core.Capabilities	getCapabilities()
int	getConcat_words()
int	getConcatWords()
java.lang.String	getEmbedding_prefix()
int	getEpochs()
int	getIterations()
int	getLayerSize()
int	getMinWordFrequency()
java.lang.String[]	getOptions()
TokenPreProcess	getPreProcessor()
int	getSeed()
Dl4jAbstractStopwords	getStopWordsHandler()
int	getTextIndex()
TokenizerFactory	getTokenizerFactory()
int	getWindowSize()
int	getWorkers()
java.util.Enumeration<weka.core.Option>	listOptions()
void	setAction(weka.filters.unsupervised.attribute.Dl4jStringToWordEmbeddings.Action action)
void	setConcat_words(int m_concat_words)
void	setConcatWords(int concatWords)
void	setEmbedding_prefix(java.lang.String embeddingPrefix)
void	setEpochs(int m_epochs)
void	setIterations(int iterations)
void	setLayerSize(int layerSize)
void	setMinWordFrequency(int minWordFrequency)
void	setOptions(java.lang.String[] options) Parses the options for this object.
void	setPreProcessor(TokenPreProcess value) Sets the preprocessor action.
void	setSeed(int m_seed)
void	setStopWordsHandler(Dl4jAbstractStopwords m_stopWordsHandler)
void	setTextIndex(int textIndex) Set the attribute's index with the string to process.
void	setTokenizerFactory(TokenizerFactory m_tokenizerFactory)
void	setWindowSize(int windowSize)
void	setWorkers(int m_workers)

Methods inherited from class weka.filters.SimpleBatchFilter

allowAccessToFullInputFormat, batchFinished, input, input

Methods inherited from class weka.filters.SimpleFilter

globalInfo, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, getRevision, isFirstBatchDone, isNewBatch, isOutputFormatDefined, main, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

Dl4jStringToWordEmbeddings

public Dl4jStringToWordEmbeddings()

Method Detail

listOptions

public java.util.Enumeration<weka.core.Option> listOptions()

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class weka.filters.Filter

getOptions

public java.lang.String[] getOptions()

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class weka.filters.Filter

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses the options for this object.

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.filters.Filter

Parameters:

options - the options to use

Throws:

java.lang.Exception - if setting of options fails

getCapabilities

public weka.core.Capabilities getCapabilities()

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.filters.Filter

getConcatWords

public int getConcatWords()

setConcatWords

public void setConcatWords(int concatWords)

getAction

@OptionMetadata(displayName="action",
                description="The action to perform on the embeddings: 1) report embeddings (WORD_VECTOR), 2) Average embeddings of the input string (DOC_VECTOR_AVERAGE),3) Add embeddings of the input string (DOC_VECTOR_ADD), 4) Concatenate the first *concat_words* embeddings of  the input string (DOC_VECTOR_CONCAT), (default WORD_VECTOR).",
                commandLineParamName="action",
                commandLineParamSynopsis="-level <speficiation>",
                displayOrder=1)
public weka.filters.unsupervised.attribute.Dl4jStringToWordEmbeddings.Action getAction()

setAction

public void setAction(weka.filters.unsupervised.attribute.Dl4jStringToWordEmbeddings.Action action)

getConcat_words

@OptionMetadata(displayName="concat_words",
                description="Number of stopWords (from left to right) of the tweet whose embeddings will be concatenated.This parameter only applies if action=DOC_VECTOR_CONCAT (default = 15).",
                commandLineParamName="concat_words",
                commandLineParamSynopsis="-concat_words <int>",
                displayOrder=2)
public int getConcat_words()

setConcat_words

public void setConcat_words(int m_concat_words)

getStopWordsHandler

@OptionMetadata(displayName="stopWordsHandler",
                description="The stopWordsHandler. Dl4j Null means no stop stopWords are used.",
                commandLineParamName="stopWordsHandler",
                commandLineParamSynopsis="-stopWordsHandler <String>",
                displayOrder=3)
public Dl4jAbstractStopwords getStopWordsHandler()

setStopWordsHandler

public void setStopWordsHandler(Dl4jAbstractStopwords m_stopWordsHandler)

getTokenizerFactory

@OptionMetadata(displayName="tokenizerFactory",
                description="The tokenizer factory to use on the strings. Default: DefaultTokenizer.",
                commandLineParamName="tokenizerFactory",
                commandLineParamSynopsis="-tokenizerFactory <String>",
                displayOrder=4)
public TokenizerFactory getTokenizerFactory()

setTokenizerFactory

public void setTokenizerFactory(TokenizerFactory m_tokenizerFactory)

getPreProcessor

@OptionMetadata(displayName="preprocessor",
                description="The token Preprocessor for preprocessing the Strings. Default: CommonPreProcessor.",
                commandLineParamName="preprocessor",
                commandLineParamSynopsis="-preprocessor <String>",
                displayOrder=5)
public TokenPreProcess getPreProcessor()

setPreProcessor

public void setPreProcessor(TokenPreProcess value)

Sets the preprocessor action.

Parameters:

value - the action type

getTextIndex

@OptionMetadata(displayName="attribute string index",
                description="The attribute string index (starting from 1) to process (default = 1).",
                commandLineParamName="index",
                commandLineParamSynopsis="-index <int>",
                displayOrder=6)
public int getTextIndex()

setTextIndex

public void setTextIndex(int textIndex)

Set the attribute's index with the string to process.

Parameters:

textIndex - the index value name

getMinWordFrequency

@OptionMetadata(displayName="minWordFrequency",
                description="The minimum word frequency (default = 5).",
                commandLineParamName="minWordFrequency",
                commandLineParamSynopsis="-minWordFrequency <int>",
                displayOrder=7)
public int getMinWordFrequency()

setMinWordFrequency

public void setMinWordFrequency(int minWordFrequency)

getLayerSize

@OptionMetadata(displayName="layerSize",
                description="The size of the word vectors (default = 100).",
                commandLineParamName="layerSize",
                commandLineParamSynopsis="-layerSize <int>",
                displayOrder=8)
public int getLayerSize()

setLayerSize

public void setLayerSize(int layerSize)

getIterations

@OptionMetadata(displayName="iterations",
                description="The number of iterations (default = 1).",
                commandLineParamName="iterations",
                commandLineParamSynopsis="-iterations <int>",
                displayOrder=9)
public int getIterations()

setIterations

public void setIterations(int iterations)

getWindowSize

@OptionMetadata(displayName="windowSize",
                description="The size of the window (default = 5).",
                commandLineParamName="windowSize",
                commandLineParamSynopsis="-windowSize <int>",
                displayOrder=10)
public int getWindowSize()

setWindowSize

public void setWindowSize(int windowSize)

getEpochs

@OptionMetadata(displayName="epochs",
                description="The number of epochs (iterations over whole training corpus) for training (default = 1).",
                commandLineParamName="epochs",
                commandLineParamSynopsis="-epochs <int>",
                displayOrder=11)
public int getEpochs()

setEpochs

public void setEpochs(int m_epochs)

getWorkers

@OptionMetadata(displayName="workers",
                description="The maximum number of concurrent threads available for training.",
                commandLineParamName="workers",
                commandLineParamSynopsis="-workers <int>",
                displayOrder=12)
public int getWorkers()

setWorkers

public void setWorkers(int m_workers)

getSeed

@OptionMetadata(displayName="seed",
                description="The random number seed to be used. (default = 1).",
                commandLineParamName="seed",
                commandLineParamSynopsis="-seed <int>",
                displayOrder=13)
public int getSeed()

setSeed

public void setSeed(int m_seed)

getEmbedding_prefix

@OptionMetadata(displayName="embedding_prefix",
                description="The prefix for each embedding attribute. Default: \"embedding-\".",
                commandLineParamName="embedding_prefix",
                commandLineParamSynopsis="-embedding_prefix <String>",
                displayOrder=14)
public java.lang.String getEmbedding_prefix()

setEmbedding_prefix

public void setEmbedding_prefix(java.lang.String embeddingPrefix)