edu.ucla.sspace.wordsi

Interface AssignmentReporter

All Known Implementing Classes:

PseudoWordReporter, SemEvalReporter

public interface AssignmentReporter

An interface for reporting the results of a Wordsi run. Reports can take several forms, such as the number of times each word was assigned to each cluster or something similar to the SenseEval/SemEval word sense induction output, which requires a cluster labeling for each word context generated.

Author:

Keith Stevens

Method Summary

Methods

Modifier and Type	Method and Description
void	assignContextToKey(String primaryKey, String secondaryKey, int contextId) Records a contexts identifier for an instance of primaryKey.
String[]	contextLabels(String primaryKey) Returns the secondary keys assigned to this primaryKey based on their associated context ids.
void	finalizeReport() Finalizes the assignment report.
void	updateAssignment(String primaryKey, String secondaryKey, int clusterId) Updates the assignment report with the knowledge that primaryKey and secondaryKey were associated with clusterId once.

Method Detail

updateAssignment

void updateAssignment(String primaryKey,
                    String secondaryKey,
                    int clusterId)

Updates the assignment report with the knowledge that primaryKey and secondaryKey were associated with clusterId once.

finalizeReport

void finalizeReport()

Finalizes the assignment report. Any output streams must be closed and any unreported data must be reported.

assignContextToKey

void assignContextToKey(String primaryKey,
                      String secondaryKey,
                      int contextId)

Records a contexts identifier for an instance of primaryKey. The identifies recorded aresecondaryKey and contextId. secondaryKey can be any string. contextId can should be between 0 and the total number of contexts that will be observed, i.e. contexts for a single primaryKey simply get idsj based on the order in which they are processed.

contextLabels

String[] contextLabels(String primaryKey)

Returns the secondary keys assigned to this primaryKey based on their associated context ids. This list can be used if a Wordsi algorithm needs to report it's clustering assignments. Reporting SenseEval/SemEval or Pseudo Word Disambiguation assignments are two good use cases which require this functionality.