edu.illinois.cs.cogcomp.wsim.wordnet

Class WNSim

java.lang.Object

edu.illinois.cs.cogcomp.sim.StringMetric<String>

edu.illinois.cs.cogcomp.wsim.wordnet.WNSim

All Implemented Interfaces:

Metric<String>

public class WNSim
extends StringMetric<String>

Class to calculate Wordnet Pathfinder based similarity

Author:

John Wieting, mssammon, ngupta18, sgupta96

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
WNSim() default constructor: expects all resources to be defaults, and will look for them on classpath
WNSim(ResourceManager rm) Constructor

Method Summary

Modifier and Type	Method and Description
MetricResponse	compare(edu.illinois.cs.cogcomp.sim.MetricWord arg1, edu.illinois.cs.cogcomp.sim.MetricWord arg2) Calculates similarity between two words, using POS tags if provided.
MetricResponse	compare(String firstWord, String secondWord) Calculates similarity between word1 and word2
String	getName() returns the name of this metric.
static void	main(String[] args) Contains sample invocation
protected String	wrapStringArgument(String word) construct a T instance from just a String to allow the StringMetric.compareStringValues(Map) to interact with .compare

Methods inherited from class edu.illinois.cs.cogcomp.sim.StringMetric

compareStringValues

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Constructor Detail

WNSim

public WNSim()
      throws IOException

default constructor: expects all resources to be defaults, and will look for them on classpath

Throws:

IOException

WNSim

public WNSim(ResourceManager rm)
      throws IOException

Constructor

Parameters:

rm - ResourceManager containing non-default config options, including path to the local Wordnet resource

Throws:

IOException

Method Detail

main

public static void main(String[] args)
                 throws IOException

Contains sample invocation

Parameters:

args - optional: config file containing path to the wordnet resource, as in config/sampleConfig.txt

Throws:

IOException

compare

public MetricResponse compare(String firstWord,
                              String secondWord)

Calculates similarity between word1 and word2

Parameters:

firstWord - 1st word

secondWord - 2nd word

Returns:

similarity score between word1 and word2 plus a "reason"

getName

public String getName()

returns the name of this metric. Used as the reason by the default StringMetric.compareStringValues(java.util.Map<java.lang.String, java.lang.String>) method.

Specified by:

getName in class StringMetric<String>

Returns:

the name of this metric.

wrapStringArgument

protected String wrapStringArgument(String word)

construct a T instance from just a String to allow the StringMetric.compareStringValues(Map) to interact with .compare

Specified by:

wrapStringArgument in class StringMetric<String>

Parameters:

word - the word to wrap

Returns:

the corresponding object of type T specified by the implementor

compare

public MetricResponse compare(edu.illinois.cs.cogcomp.sim.MetricWord arg1,
                              edu.illinois.cs.cogcomp.sim.MetricWord arg2)
                       throws IllegalArgumentException

Calculates similarity between two words, using POS tags if provided. Currently ignores POS.

Parameters:

arg1 - 1st word

arg2 - 2nd word

Returns:

similarity score between arg1 and arg2 plus a "reason"

Throws:

IllegalArgumentException