org.square.qa.algorithms
Interface AlgorithmInterface<TypeWID,TypeQ,TypeR>

All Known Subinterfaces:

ExtendedAlgorithmInterface<TypeWID,TypeQ,TypeR>

All Known Implementing Classes:

Models.BayesModel, Models.MajorityModel, Models.RaykarModel, Models.ZenModel

public interface AlgorithmInterface<TypeWID,TypeQ,TypeR>

Method Summary

Map<TypeQ,Pair<TypeR,Map<TypeR,Double>>>	getCombinedEstLabels() Get computed/partially-computed results
Map<TypeQ,TypeR>	getGoldStandard() Get ground truth question response pairs from the gold partition
TreeSet<TypeR>	getResponseCategories() Get valid response categories
Map<TypeQ,TypeR>	getTuneGT() Get ground truth question response pairs from the tune partition
Map<TypeWID,workersDataStruct<TypeQ,TypeR>>	getWorkersMap() Get all responses stored for each worker
Map<TypeWID,workersDataStruct<TypeQ,TypeR>>	getWorkersMapGold() Get worker responses from the Gold partition
Map<TypeWID,workersDataStruct<TypeQ,TypeR>>	getWorkersMapTune() Get worker responses from the Tune partition
boolean	hasCombinedEstLabels() Checks if results are computed
boolean	hasGoldStandard() Checks if gold standard is used by the algorithm (supervised)
boolean	hasResponseCategories() Checks for presence of response categories
boolean	hasTuneGT() Checks if ground truth for tune partition is used by the algorithm (lightly-supervised)
boolean	hasWorkersMap() Checks for presence of worker responses from the evaluation partition
boolean	hasWorkersMapGold() Checks for presence of worker responses from the gold partition
boolean	hasWorkersMapTune() Checks for presence of worker responses from the tune partition
void	setCombinedEstLabels(Map<TypeQ,Pair<TypeR,Map<TypeR,Double>>> combinedEstLabels) Load computed/partially-computed results
void	setGoldStandard(Map<TypeQ,TypeR> goldStandard) Set ground truth question response pairs from the gold partition
void	setResponseCategories(TreeSet<TypeR> responseCategories) Set response categories
void	setTuneGT(Map<TypeQ,TypeR> tuneGT) Set ground truth question response pairs from the tune partition
void	setWorkersMap(Map<TypeWID,workersDataStruct<TypeQ,TypeR>> workersMap) Set responses to questions for each worker
void	setWorkersMapGold(Map<TypeWID,workersDataStruct<TypeQ,TypeR>> workersMapGold) Set worker responses from the Gold partition
void	setWorkersMapTune(Map<TypeWID,workersDataStruct<TypeQ,TypeR>> workersMapTune) Set worker responses from the Tune partition

Method Detail

getWorkersMap

Map<TypeWID,workersDataStruct<TypeQ,TypeR>> getWorkersMap()

Get all responses stored for each worker

Returns:

a Map from Worker ID to a worker object holding questions and responses

setWorkersMap

void setWorkersMap(Map<TypeWID,workersDataStruct<TypeQ,TypeR>> workersMap)

Set responses to questions for each worker

Parameters:

workersMap - is a Map from Worker ID to a worker object holding questions and responses

getResponseCategories

TreeSet<TypeR> getResponseCategories()

Get valid response categories

Returns:

is a sorted set of response categories

setResponseCategories

void setResponseCategories(TreeSet<TypeR> responseCategories)

Set response categories

Parameters:

responseCategories - is a TreeSet of TypeR

getWorkersMapTune

Map<TypeWID,workersDataStruct<TypeQ,TypeR>> getWorkersMapTune()

Get worker responses from the Tune partition

Returns:

a Map from workers to objects containing worker questions and responses

setWorkersMapTune

void setWorkersMapTune(Map<TypeWID,workersDataStruct<TypeQ,TypeR>> workersMapTune)

Set worker responses from the Tune partition

Parameters:

workersMapTune - is a Map from workers to objects containing worker questions and responses

getWorkersMapGold

Map<TypeWID,workersDataStruct<TypeQ,TypeR>> getWorkersMapGold()

Get worker responses from the Gold partition

Returns:

a Map from workers to objects containing worker questions and responses

setWorkersMapGold

void setWorkersMapGold(Map<TypeWID,workersDataStruct<TypeQ,TypeR>> workersMapGold)

Set worker responses from the Gold partition

Parameters:

workersMapGold - is a Map from workers to objects containing worker questions and responses

getTuneGT

Map<TypeQ,TypeR> getTuneGT()

Get ground truth question response pairs from the tune partition

Returns:

is a Map from questions to responses

setTuneGT

void setTuneGT(Map<TypeQ,TypeR> tuneGT)

Set ground truth question response pairs from the tune partition

Parameters:

tuneGT - is a Map from questions to responses

getGoldStandard

Map<TypeQ,TypeR> getGoldStandard()

Get ground truth question response pairs from the gold partition

Returns:

is a Map from questions to responses

setGoldStandard

void setGoldStandard(Map<TypeQ,TypeR> goldStandard)

Set ground truth question response pairs from the gold partition

Parameters:

goldStandard - is a Map from questions to responses

hasWorkersMap

boolean hasWorkersMap()

Checks for presence of worker responses from the evaluation partition

Returns:

true if workers responses are loaded

hasWorkersMapTune

boolean hasWorkersMapTune()

Checks for presence of worker responses from the tune partition

Returns:

true if workers responses are loaded

hasWorkersMapGold

boolean hasWorkersMapGold()

Checks for presence of worker responses from the gold partition

Returns:

true if workers responses are loaded

hasResponseCategories

boolean hasResponseCategories()

Checks for presence of response categories

Returns:

true if response categories are loaded

hasGoldStandard

boolean hasGoldStandard()

Checks if gold standard is used by the algorithm (supervised)

Returns:

true if gold standard is available

hasTuneGT

boolean hasTuneGT()

Checks if ground truth for tune partition is used by the algorithm (lightly-supervised)

Returns:

true if ground truth for tune partition is available

getCombinedEstLabels

Map<TypeQ,Pair<TypeR,Map<TypeR,Double>>> getCombinedEstLabels()

Get computed/partially-computed results

Returns:

a Map from questions to Pair of predicted response and response probabilities

hasCombinedEstLabels

boolean hasCombinedEstLabels()

Checks if results are computed

Returns:

true if results have been computed

setCombinedEstLabels

void setCombinedEstLabels(Map<TypeQ,Pair<TypeR,Map<TypeR,Double>>> combinedEstLabels)

Load computed/partially-computed results

Parameters:

combinedEstLabels - is a Map from questions to Pair of predicted response and response probabilities