emolib.classifier.machinelearning
Class OrdinalLogReg

java.lang.Object
  emolib.util.proc.TextDataProcessor
      emolib.classifier.Classifier
          emolib.classifier.machinelearning.OrdinalLogReg

All Implemented Interfaces:

Configurable, DataProcessor

public class OrdinalLogReg
extends Classifier

The OrdinalLogReg class is an Ordinal Logistic Regression classifier.

Its implementation is based on the theory appearing in the SPSS book (Zagumny, 2001), optimised with a Stochastic Gradient Descent procedure (Carpenter, 2008). The same term weighting schemes as the ones used in the ARN-R are considered.

--
(Zagumny, 2001) Zagumny, M., "The SPSS Book: A Student Guide to the Statistical Package for the Social Sciences", Lincoln: iUniverse.com, Inc., ISBN: 978-0595189137
(Carpenter, 2008) Carpenter, B., "Lazy Sparse Stochastic Gradient Descent for Regularized Multinomial Logistic Regression", 2008.

Author:

Alexandre Trilla (atrilla@salle.url.edu)

See Also:

ARNReduced

Constructor Summary

OrdinalLogReg()
Main constructor of this logistic regression classifier.

Method Summary

java.lang.String	getCategory(FeatureBox inputFeatures) The function that decides the most appropriate emotional category.
void	load(java.lang.String path) Generic function to load a previously saved classifier.
void	resetExamples() Method to reset the classifier and flush the training examples.
void	save(java.lang.String path) Generic method to save the fully fledged classifier into a given file path.
void	setCOF(boolean cof) Method to consider bigram frequencies.
void	setEmotionDims(boolean emodims) Method to consider emotion dimensions.
void	setIntercept(boolean intercept) Method to consider the intercept feature.
void	setNegation(boolean neg) Method to consider negations.
void	setPOS(boolean pos) Method to consider POS tags.
void	setStemming(boolean stems) Method to consider stems.
void	setSynonyms(boolean syns) Method to consider synonyms.
void	setTermWeighingMeasure(java.lang.String twm) Method to set the TW method.
void	trainingProcedure() Training method based on the Stochastic Gradient Descent.

Methods inherited from class emolib.classifier.Classifier

applyClassification, getData, getListOfExampleCategories, getListOfExampleFeatures, initialize, inputTrainingExample, newProperties, register, train

Methods inherited from class emolib.util.proc.TextDataProcessor

flush, getName, getPredecessor, setPredecessor, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrdinalLogReg

public OrdinalLogReg()

Main constructor of this logistic regression classifier.

Method Detail

getCategory

public java.lang.String getCategory(FeatureBox inputFeatures)

Description copied from class: Classifier

The function that decides the most appropriate emotional category. This is required for any classifier. The classifier in question has to previously run any training algorithm in order to provide the required prediction.

Specified by:

getCategory in class Classifier

Parameters:

inputFeatures - The input emotional features.

Returns:

The most appropriate emotional category.

trainingProcedure

public void trainingProcedure()

Training method based on the Stochastic Gradient Descent.

Specified by:

trainingProcedure in class Classifier

setTermWeighingMeasure

public void setTermWeighingMeasure(java.lang.String twm)

Method to set the TW method.

Parameters:

twm - The TW method.

setCOF

public void setCOF(boolean cof)

Method to consider bigram frequencies.

Parameters:

cof - The COF flag.

setPOS

public void setPOS(boolean pos)

Method to consider POS tags.

Parameters:

pos - The POS flag.

setStemming

public void setStemming(boolean stems)

Method to consider stems.

Parameters:

stems - The stemming flag.

setIntercept

public void setIntercept(boolean intercept)

Method to consider the intercept feature.

Parameters:

intercept - The intercept flag.

setSynonyms

public void setSynonyms(boolean syns)

Method to consider synonyms.

Parameters:

syns - The synonyms flag.

setEmotionDims

public void setEmotionDims(boolean emodims)

Method to consider emotion dimensions.

Parameters:

emodims - The emotion dimensions flag.

setNegation

public void setNegation(boolean neg)

Method to consider negations.

Parameters:

neg - The negation flag.

save

public void save(java.lang.String path)

Description copied from class: Classifier

Generic method to save the fully fledged classifier into a given file path. It is recommended to use a plain text file (such as XML) to save the classifier's configuration since it's readable directly.

Specified by:

save in class Classifier

Parameters:

path - The file path to save the classifier.

load

public void load(java.lang.String path)

Description copied from class: Classifier

Generic function to load a previously saved classifier. This function should be consistent with the design followed in the saving procedure.

Specified by:

load in class Classifier

Parameters:

path - The path of the file which contains the previously saved classifier.

resetExamples

public void resetExamples()

Description copied from class: Classifier

Method to reset the classifier and flush the training examples. This method only makes sense if the classifier in question is trainable and already has some training examples.

Overrides:

resetExamples in class Classifier