Package org.languagetool.rules.spelling.suggestions

Class SuggestionsChanges

java.lang.Object

org.languagetool.rules.spelling.suggestions.SuggestionsChanges

public class SuggestionsChanges
extends Object

Helper class for SuggestionChangesTest, tracks experiment configuration and results Rules should use getInstance() != null -> getInstance().getCurrentExperiment() in constructors to fetch relevant parameters Use isRunningExperiment if no parameters are needed

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SuggestionsChanges.Report

Field Summary

Fields

Modifier and Type	Field	Description
private final ConcurrentMap<SuggestionChangesExperiment,Long>	computationTime
private final SuggestionChangesTestConfig	config
private final ConcurrentMap<SuggestionChangesExperiment,Integer>	correctSuggestions
private SuggestionChangesExperiment	currentExperiment
private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Long>	datasetComputationTime
private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer>	datasetCorrectSuggestions
private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer>	datasetNotFoundSuggestions
private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer>	datasetNumSamples
private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer>	datasetSuggestionPosSum
private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer>	datasetTextSize
private final List<SuggestionChangesExperiment>	experiments
private static SuggestionsChanges	instance
private final ConcurrentMap<SuggestionChangesExperiment,Integer>	notFoundSuggestions
private final ConcurrentMap<SuggestionChangesExperiment,Integer>	numSamples
private final ConcurrentMap<SuggestionChangesExperiment,Integer>	suggestionPosSum
private final ConcurrentMap<SuggestionChangesExperiment,Integer>	textSize

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SuggestionsChanges(SuggestionChangesTestConfig config, BufferedWriter reportWriter)

Method Summary

Modifier and Type	Method	Description
private List<SuggestionChangesExperiment>	generateExperiments(List<SuggestionChangesExperimentRuns> experimentSpecs)
SuggestionChangesTestConfig	getConfig()
@Nullable SuggestionChangesExperiment	getCurrentExperiment()
List<SuggestionChangesExperiment>	getExperiments()
static @Nullable SuggestionsChanges	getInstance()	null if nothing is configured, i.e.
private List<Map<String,Object>>	gridsearch(SortedMap<String,List<Object>> grid, List<Map<String,Object>> current)
(package private) static void	init(@NotNull SuggestionChangesTestConfig config, @Nullable BufferedWriter reportWriter)
static boolean	isRunningExperiment(String name)
void	setCurrentExperiment(@Nullable SuggestionChangesExperiment experiment)	For testing changes to suggestion ordering using a data corpus; iterate over experiments (including grid search for parameters) original behavior (for A/B testing) can be modeled by an experiment without parameters and an arbitrary name
void	trackExperimentResult(org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset> source, int position, int resultTextSize, long resultComputationTime)

Methods inherited from class java.lang.Object

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

Field Details

instance

private static SuggestionsChanges instance

config

private final SuggestionChangesTestConfig config

experiments

private final List<SuggestionChangesExperiment> experiments

correctSuggestions

private final ConcurrentMap<SuggestionChangesExperiment,Integer> correctSuggestions

notFoundSuggestions

private final ConcurrentMap<SuggestionChangesExperiment,Integer> notFoundSuggestions

suggestionPosSum

private final ConcurrentMap<SuggestionChangesExperiment,Integer> suggestionPosSum

textSize

private final ConcurrentMap<SuggestionChangesExperiment,Integer> textSize

computationTime

private final ConcurrentMap<SuggestionChangesExperiment,Long> computationTime

numSamples

private final ConcurrentMap<SuggestionChangesExperiment,Integer> numSamples

datasetCorrectSuggestions

private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer> datasetCorrectSuggestions

datasetNotFoundSuggestions

private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer> datasetNotFoundSuggestions

datasetSuggestionPosSum

private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer> datasetSuggestionPosSum

datasetNumSamples

private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer> datasetNumSamples

datasetTextSize

private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Integer> datasetTextSize

datasetComputationTime

private final ConcurrentMap<org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset>,Long> datasetComputationTime

currentExperiment

private SuggestionChangesExperiment currentExperiment

Constructor Details

SuggestionsChanges

private SuggestionsChanges(SuggestionChangesTestConfig config,
 BufferedWriter reportWriter)

Method Details

getInstance

@Nullable
public static @Nullable SuggestionsChanges getInstance()

null if nothing is configured, i.e. in most normal use cases

init

static void init(@NotNull
 @NotNull SuggestionChangesTestConfig config,
 @Nullable
 @Nullable BufferedWriter reportWriter)

gridsearch

private List<Map<String,Object>> gridsearch(SortedMap<String,List<Object>> grid,
 List<Map<String,Object>> current)

generateExperiments

private List<SuggestionChangesExperiment> generateExperiments(List<SuggestionChangesExperimentRuns> experimentSpecs)

getConfig

public SuggestionChangesTestConfig getConfig()

getCurrentExperiment

@Nullable
public @Nullable SuggestionChangesExperiment getCurrentExperiment()

setCurrentExperiment

public void setCurrentExperiment(@Nullable
 @Nullable SuggestionChangesExperiment experiment)

For testing changes to suggestion ordering using a data corpus; iterate over experiments (including grid search for parameters) original behavior (for A/B testing) can be modeled by an experiment without parameters and an arbitrary name

isRunningExperiment

public static boolean isRunningExperiment(String name)

trackExperimentResult

public void trackExperimentResult(org.apache.commons.lang3.tuple.Pair<SuggestionChangesExperiment,SuggestionChangesDataset> source,
 int position,
 int resultTextSize,
 long resultComputationTime)

getExperiments

public List<SuggestionChangesExperiment> getExperiments()