public class BooleanPerceptronClassifier extends Object implements Classifier<Boolean>
http://en.wikipedia.org/wiki/Perceptron
) based
Boolean
Classifier
. The
weights are calculated using
TermsEnum.totalTermFreq()
both on a per field
and a per document basis and then a corresponding
FST
is used for class assignment.Constructor and Description |
---|
BooleanPerceptronClassifier(IndexReader indexReader,
Analyzer analyzer,
Query query,
Integer batchSize,
Double threshold,
String classFieldName,
String textFieldName)
Creates a
BooleanPerceptronClassifier |
Modifier and Type | Method and Description |
---|---|
ClassificationResult<Boolean> |
assignClass(String text)
Assign a class (with score) to the given text String
|
List<ClassificationResult<Boolean>> |
getClasses(String text)
Get all the classes (sorted by score, descending) assigned to the given text String.
|
List<ClassificationResult<Boolean>> |
getClasses(String text,
int max)
Get the first
max classes (sorted by score, descending) assigned to the given text String. |
public BooleanPerceptronClassifier(IndexReader indexReader, Analyzer analyzer, Query query, Integer batchSize, Double threshold, String classFieldName, String textFieldName) throws IOException
BooleanPerceptronClassifier
indexReader
- the reader on the index to be used for classificationanalyzer
- an Analyzer
used to analyze unseen textquery
- a Query
to eventually filter the docs used for training the classifier, or null
if all the indexed docs should be usedbatchSize
- the size of the batch of docs to use for updating the perceptron weightsthreshold
- the threshold used for class separationclassFieldName
- the name of the field used as the output for the classifiertextFieldName
- the name of the field used as input for the classifierIOException
- if the building of the underlying FST
fails and / or TermsEnum
for the text field
cannot be foundpublic ClassificationResult<Boolean> assignClass(String text) throws IOException
assignClass
in interface Classifier<Boolean>
text
- a String containing text to be classifiedClassificationResult
holding assigned class of type T
and scoreIOException
- If there is a low-level I/O error.public List<ClassificationResult<Boolean>> getClasses(String text) throws IOException
getClasses
in interface Classifier<Boolean>
text
- a String containing text to be classifiedClassificationResult
, the classes and scores. Returns null
if the classifier can't make lists.IOException
- If there is a low-level I/O error.public List<ClassificationResult<Boolean>> getClasses(String text, int max) throws IOException
max
classes (sorted by score, descending) assigned to the given text String.getClasses
in interface Classifier<Boolean>
text
- a String containing text to be classifiedmax
- the number of return list elementsClassificationResult
, the classes and scores. Cut for "max" number of elements. Returns null
if the classifier can't make lists.IOException
- If there is a low-level I/O error.Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.