Package org.languagetool.rules.neuralnetwork

Class NeuralNetworkRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.neuralnetwork.NeuralNetworkRule

public class NeuralNetworkRule
extends Rule

Field Summary

Fields

Modifier and Type	Field	Description
private final Classifier	classifier
private static final int	CONTEXT_LENGTH
private static final boolean	DEBUG
private final List<Optional<String>>	descriptions
private final String	id
private double	minScore
private final List<String>	subjects

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
NeuralNetworkRule(ResourceBundle messages, Language language, ScoredConfusionSet confusionSet, Classifier classifier)
NeuralNetworkRule(ResourceBundle messages, Language language, ScoredConfusionSet confusionSet, Word2VecModel word2VecModel)

Method Summary

Modifier and Type	Method	Description
private @NotNull String	createId(Language language)
private @NotNull RuleMatch	createRuleMatch(AnalyzedTokenReadings token, Suggestion suggestion, float[] y, AnalyzedSentence sentence)
private @NotNull String[]	getContext(AnalyzedTokenReadings[] tokens, int center)
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId()	A string used to identify the rule in e.g.
private @NotNull String	getMessage(Suggestion suggestion, float[] y)
protected double	getMinScore()
List<String>	getSubjects()
private Suggestion	getSuggestion(float[] y)
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.
private static String	safeGetToken(AnalyzedTokenReadings[] arr, int i)
void	setMinScore(double minScore)
private InputStream	streamFor(File path, String filename)

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, estimateContextForSureMatch, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT_LENGTH

private static final int CONTEXT_LENGTH

See Also:

• Constant Field Values

DEBUG

private static final boolean DEBUG

See Also:

• Constant Field Values

subjects

private final List<String> subjects

descriptions

private final List<Optional<String>> descriptions

id

private final String id

classifier

private final Classifier classifier

minScore

private double minScore

Constructor Details

NeuralNetworkRule

public NeuralNetworkRule(ResourceBundle messages,
 Language language,
 ScoredConfusionSet confusionSet,
 Word2VecModel word2VecModel)
                  throws IOException

Throws:

IOException

NeuralNetworkRule

public NeuralNetworkRule(ResourceBundle messages,
 Language language,
 ScoredConfusionSet confusionSet,
 Classifier classifier)

Method Details

createId

@NotNull
private @NotNull String createId(Language language)

streamFor

private InputStream streamFor(File path,
 String filename)
                       throws FileNotFoundException

Throws:

FileNotFoundException

getSubjects

public List<String> getSubjects()

getMinScore

protected double getMinScore()

setMinScore

public void setMinScore(double minScore)

getId

public String getId()

Description copied from class: Rule

A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class Rule

getDescription

public String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class Rule

getSuggestion

private Suggestion getSuggestion(float[] y)

match

public RuleMatch[] match(AnalyzedSentence sentence)
                  throws IOException

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different than the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example).

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

getContext

@NotNull
private @NotNull String[] getContext(AnalyzedTokenReadings[] tokens,
 int center)

safeGetToken

private static String safeGetToken(AnalyzedTokenReadings[] arr,
 int i)

createRuleMatch

@NotNull
private @NotNull RuleMatch createRuleMatch(AnalyzedTokenReadings token,
 Suggestion suggestion,
 float[] y,
 AnalyzedSentence sentence)

getMessage

@NotNull
private @NotNull String getMessage(Suggestion suggestion,
 float[] y)