emolib.classifier.machinelearning
Class HierarchicalARNReduced

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

All Implemented Interfaces:

Configurable, DataProcessor

public class HierarchicalARNReduced
extends Classifier

The HierarchicalARNReduced is an ensemble of Reduced Associative Relational Networks considering the hierarchy of affect.

The HierarchicalARNReduced enhances a ARN-R classifier adding hierarchical classification steps according to the human difficulty to discern emotions/sentiments.

According to the chosen learning procedure, the structure of the hierarchy is built. The available schemes are listed as follows:

• "sentiment_hierarchical_cluster_analysis": the first classification level differentiates neutral from affective instances (textual features). If affect is detected, then a second level of analysis decides whether its orientation is positive or negative. Note that the training gold labels must be consistent with the N-P-neutral set.

Author:

Alexandre Trilla (atrilla@salle.url.edu)

See Also:

ARNReduced

Field Summary

static java.lang.String

PROP_EXTERNAL_FILE Property to indicate a pre-trained classifier.

Constructor Summary

HierarchicalARNReduced()
Main constructor of this classifier.

Method Summary

java.lang.String	getCategory(FeatureBox inputFeatures) The function that decides the most appropriate emotional category.
void	initialize() Method to initialize the Classifier.
void	load(java.lang.String path) Generic function to load a previously saved classifier.
void	newProperties(PropertySheet ps) This method is called when this configurable component has new data.
void	register(java.lang.String name, Registry registry) Register my properties.
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	setLearningProcedure(java.lang.String lproc) Method to set the learning procedure.
void	setTypeOfARN(java.lang.String type) Method to set the type of ARN to use.
void	trainingProcedure() Void method to train required by the Classifier class.

Methods inherited from class emolib.classifier.Classifier

applyClassification, getData, getListOfExampleCategories, getListOfExampleFeatures, inputTrainingExample, 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

Field Detail

PROP_EXTERNAL_FILE

public static final java.lang.String PROP_EXTERNAL_FILE

Property to indicate a pre-trained classifier.

See Also:

Constant Field Values

Constructor Detail

HierarchicalARNReduced

public HierarchicalARNReduced()

Main constructor of this classifier.

Method Detail

register

public void register(java.lang.String name,
                     Registry registry)
              throws PropertyException

Description copied from interface: Configurable

Register my properties. This method is called once early in the time of the component, shortly after the component is constructed. This component should register any configuration properties that it needs to register. If this configurable extends another configurable, super.register should also be called

Specified by:

register in interface Configurable

Overrides:

register in class Classifier

Parameters:

name - the name of the component

registry - the registry for this component

Throws:

PropertyException

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException

Description copied from interface: Configurable

This method is called when this configurable component has new data. The component should first validate the data. If it is bad the component should return false. If the data is good, the component should record the the data internally and return true.

Specified by:

newProperties in interface Configurable

Overrides:

newProperties in class Classifier

Parameters:

ps - a property sheet holding the new data

Throws:

PropertyException - if there is a problem with the properties.

initialize

public void initialize()

Method to initialize the Classifier.

Specified by:

initialize in interface DataProcessor

Overrides:

initialize in class Classifier

setLearningProcedure

public void setLearningProcedure(java.lang.String lproc)

Method to set the learning procedure.

Parameters:

lproc - The learning procedure.

setTypeOfARN

public void setTypeOfARN(java.lang.String type)

Method to set the type of ARN to use.

Parameters:

type - The type of ARN to use.

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()

Void method to train required by the Classifier class.

Specified by:

trainingProcedure in class Classifier

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