Package weka.filters.unsupervised.attribute

Class TweetCentroid

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.TweetToFeatureVector

weka.filters.unsupervised.attribute.TweetCentroid

All Implemented Interfaces:

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

public class TweetCentroid
extends TweetToFeatureVector

A filter that creates word vectors from tweets using the Tweet Centroid Model. Each word is calculated as the average vector of the tweets in which it occurs.

Version:

$Revision: 1 $

Author:

Felipe Bravo-Marquez (fbravoma@waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	RESOURCES_FOLDER_NAME	Default path to where resources are stored.

Constructor Summary

Constructors

Constructor	Description
TweetCentroid()

Method Summary

Modifier and Type	Method	Description
it.unimi.dsi.fastutil.objects.Object2IntMap<java.lang.String>	calculateDocVec(java.util.List<java.lang.String> tokens)	Calculates tweet vectors from a list of tokens
void	computeWordVecsAndVoc(Instances inputFormat)	Calculates the vocabulary and the word vectors from an Instances object The vocabulary is only extracted the first time the filter is run.
int	getMinAttDocs()
int	getMinInstDocs()
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
java.io.File	getWordClustFile()
java.lang.String	globalInfo()
boolean	isCreateClustAtts()
boolean	isCreateWordAtts()
boolean	isFreqWeights()
boolean	isIncludeMetaData()
static void	main(java.lang.String[] args)	Main method for testing this class.
void	setCreateClustAtts(boolean createClustAtts)
void	setCreateWordAtts(boolean createWordAtts)
void	setFreqWeights(boolean freqWeights)
void	setIncludeMetaData(boolean includeMetaData)
void	setMinAttDocs(int minAttDocs)
void	setMinInstDocs(int minInstDocs)
void	setWordClustFile(java.io.File wordClustFile)

Methods inherited from class weka.filters.Filter

batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, getRevision, isFirstBatchDone, isNewBatch, isOutputFormatDefined, 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 class weka.filters.SimpleBatchFilter

batchFinished, input

Methods inherited from class weka.filters.SimpleFilter

setInputFormat

Methods inherited from class weka.filters.unsupervised.attribute.TweetToFeatureVector

allowAccessToFullInputFormat, getCapabilities, getOptions, getStemmer, getStopwordsHandler, getTextIndex, getTokenizer, isReduceRepeatedLetters, isStandarizeUrlsUsers, isToLowerCase, listOptions, setOptions, setReduceRepeatedLetters, setStandarizeUrlsUsers, setStemmer, setStopwordsHandler, setTextIndex, setTokenizer, setToLowerCase

Field Detail

RESOURCES_FOLDER_NAME

public static java.lang.String RESOURCES_FOLDER_NAME

Default path to where resources are stored.

Constructor Detail

TweetCentroid

public TweetCentroid()

Method Detail

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Returns:

the technical information about this class

globalInfo

public java.lang.String globalInfo()

Specified by:

globalInfo in class SimpleFilter

calculateDocVec

public it.unimi.dsi.fastutil.objects.Object2IntMap<java.lang.String> calculateDocVec(java.util.List<java.lang.String> tokens)

Calculates tweet vectors from a list of tokens

Parameters:

tokens - a tokenized tweet

Returns:

a mapping between attribute names and values

computeWordVecsAndVoc

public void computeWordVecsAndVoc(Instances inputFormat)

Calculates the vocabulary and the word vectors from an Instances object The vocabulary is only extracted the first time the filter is run.

Parameters:

inputFormat - the input Instances

getMinAttDocs

@OptionMetadata(displayName="minAttDocs",
                description="Minimum frequency of a sparse attribute to be considered in the attribute space.",
                commandLineParamName="M",
                commandLineParamSynopsis="-M <int>",
                displayOrder=6)
public int getMinAttDocs()

setMinAttDocs

public void setMinAttDocs(int minAttDocs)

getMinInstDocs

@OptionMetadata(displayName="minInstDocs",
                description="Minimum frequency of a word to be considered in the instance space.",
                commandLineParamName="N",
                commandLineParamSynopsis="-N <int>",
                displayOrder=7)
public int getMinInstDocs()

setMinInstDocs

public void setMinInstDocs(int minInstDocs)

isCreateWordAtts

@OptionMetadata(displayName="createWordAtts",
                description="True for creating unigram attributes.",
                commandLineParamIsFlag=true,
                commandLineParamName="W",
                commandLineParamSynopsis="-W",
                displayOrder=8)
public boolean isCreateWordAtts()

setCreateWordAtts

public void setCreateWordAtts(boolean createWordAtts)

setCreateClustAtts

@OptionMetadata(displayName="createClustAtts",
                description="True for creating attributes using word clusters",
                commandLineParamIsFlag=true,
                commandLineParamName="C",
                commandLineParamSynopsis="-C",
                displayOrder=9)
public void setCreateClustAtts(boolean createClustAtts)

isCreateClustAtts

public boolean isCreateClustAtts()

getWordClustFile

@OptionMetadata(displayName="wordClustFile",
                description="The file containing the word clusters.",
                commandLineParamName="H",
                commandLineParamSynopsis="-H <string>",
                displayOrder=10)
public java.io.File getWordClustFile()

setWordClustFile

public void setWordClustFile(java.io.File wordClustFile)

isIncludeMetaData

@OptionMetadata(displayName="considerNumericAtts",
                description="True for considering all numeric attributes in the original dataset in the averaged word vectors.",
                commandLineParamIsFlag=true,
                commandLineParamName="natt",
                commandLineParamSynopsis="-natt",
                displayOrder=11)
public boolean isIncludeMetaData()

setIncludeMetaData

public void setIncludeMetaData(boolean includeMetaData)

isFreqWeights

@OptionMetadata(displayName="freqWeights",
                description="True if the value of each feature is set to its frequency in the tweet. Boolean weights are used otherwise.",
                commandLineParamIsFlag=true,
                commandLineParamName="F",
                commandLineParamSynopsis="-F",
                displayOrder=12)
public boolean isFreqWeights()

setFreqWeights

public void setFreqWeights(boolean freqWeights)

main

public static void main(java.lang.String[] args)

Main method for testing this class.

Parameters:

args - should contain arguments to the filter: use -h for help