nz.ac.waikato.mcennis.rat.graph.algorithm.evaluation
Class PearsonCorrelation

java.lang.Object
  extended by nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      extended by nz.ac.waikato.mcennis.rat.graph.algorithm.evaluation.PearsonCorrelation
All Implemented Interfaces:
java.io.Serializable, Component, Algorithm, Model

public class PearsonCorrelation
extends ModelShell
implements Algorithm

Utilizes Given(user->artist) as ground truth and Derived(user->artist) as predictions. Calcualtes the Pearsons Correlation between two sets of recommendation with correlations made only if links are present in both sets. Herlocker, J., J. Konstan, L. Terveen, J. Reidl. 2004. Evaluating collaborative filtering recommender systems. ACM Transactions on Information Systems 22(1):5-53

See Also:
Serialized Form

Field Summary
 
Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell
listener
 
Constructor Summary
PearsonCorrelation()
          Creates a new instance of Evaluation
 
Method Summary
 void execute(Graph g)
          Calculate all the evaluation metrics against the given graph.
 InputDescriptor[] getInputType()
          The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
 OutputDescriptor[] getOutputType()
          The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
 Parameter[] getParameter()
          List of all parameters this component accepts.
 Parameter getParameter(java.lang.String param)
          Returns the specific parameter identified by its key-name.
 SettableParameter[] getSettableParameter()
          Returns settable (i.e.
 SettableParameter getSettableParameter(java.lang.String param)
          Return the settable parameter namede by this key-name.
 void init(java.util.Properties map)
          Parameters to be initialized 'name' - name of this instance of this algorithm.
protected  void pearsonsCorrelation(Graph g)
           
 
Methods inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell
addListener, fireChange
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model
addListener
 

Constructor Detail

PearsonCorrelation

public PearsonCorrelation()
Creates a new instance of Evaluation

Method Detail

execute

public void execute(Graph g)
Calculate all the evaluation metrics against the given graph. TODO: add F-measure stastic

Specified by:
execute in interface Algorithm
Parameters:
g - graph to be modified

pearsonsCorrelation

protected void pearsonsCorrelation(Graph g)

getInputType

public InputDescriptor[] getInputType()
Description copied from interface: Component
The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object. This result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no input.

Specified by:
getInputType in interface Component
Returns:
InputDescriptor array for this component
See Also:
InputDescriptor

getOutputType

public OutputDescriptor[] getOutputType()
Description copied from interface: Component
The output type describes all the different kinds of graph objects that are created during the execution of this algorithm. The result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no output.

Specified by:
getOutputType in interface Component
Returns:
OutputDescriptor array for this component
See Also:
OutputDescriptor

getParameter

public Parameter[] getParameter()
Description copied from interface: Component
List of all parameters this component accepts. Each parameter also has a distinct key-name used when initializing the object using the init method. If there are no parameters, null is returned.

Specified by:
getParameter in interface Component
Returns:
read-only array of Parameters

getParameter

public Parameter getParameter(java.lang.String param)
Description copied from interface: Component
Returns the specific parameter identified by its key-name. If no parameter is found with this key-name, null is returned.

Specified by:
getParameter in interface Component
Parameters:
param - key-name of the parameter
Returns:
named parameter

getSettableParameter

public SettableParameter[] getSettableParameter()
Description copied from interface: Component
Returns settable (i.e. editable while running) parameters. If none exist, null is returned.

Specified by:
getSettableParameter in interface Component
Returns:
array of settable parameters

getSettableParameter

public SettableParameter getSettableParameter(java.lang.String param)
Description copied from interface: Component
Return the settable parameter namede by this key-name. If this parameter is not found or is not settable, null is returned.

Specified by:
getSettableParameter in interface Component
Parameters:
param - key-name of the parameter
Returns:
named settable parameter

init

public void init(java.util.Properties map)
Parameters to be initialized
  1. 'name' - name of this instance of this algorithm. Deafult 'Evaluation'
  2. 'relationGroundTruth' - type (relation) of link that describes ground truth relations between two actor types (modes). Default 'Given'
  3. 'relationDerived' - type (relation) of link that describes calculated references to be evaluated between two modes. Deafult 'Derived'.
  4. 'propertyPrefix' - prefix for the property names generated. Default 'Evaluation '.


Input 1 - Link
Input 2 - Link
Output 1-12 - Graph Property

Specified by:
init in interface Component
Parameters:
map - map of the given properties naming parameters and their values in a string