Package org.apache.lucene.classification
Class BooleanPerceptronClassifier
- java.lang.Object
-
- org.apache.lucene.classification.BooleanPerceptronClassifier
-
- All Implemented Interfaces:
Classifier<Boolean>
public class BooleanPerceptronClassifier extends Object implements Classifier<Boolean>
A perceptron (seehttp://en.wikipedia.org/wiki/Perceptron) basedBooleanClassifier. The weights are calculated usingTermsEnum.totalTermFreq()both on a per field and a per document basis and then a correspondingFSTis used for class assignment.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description BooleanPerceptronClassifier(IndexReader indexReader, Analyzer analyzer, Query query, Integer batchSize, Double bias, String classFieldName, String textFieldName)Creates aBooleanPerceptronClassifier
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClassificationResult<Boolean>assignClass(String text)Assign a class (with score) to the given text StringList<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 firstmaxclasses (sorted by score, descending) assigned to the given text String.
-
-
-
Constructor Detail
-
BooleanPerceptronClassifier
public BooleanPerceptronClassifier(IndexReader indexReader, Analyzer analyzer, Query query, Integer batchSize, Double bias, String classFieldName, String textFieldName) throws IOException
Creates aBooleanPerceptronClassifier- Parameters:
indexReader- the reader on the index to be used for classificationanalyzer- anAnalyzerused to analyze unseen textquery- aQueryto eventually filter the docs used for training the classifier, ornullif all the indexed docs should be usedbatchSize- the size of the batch of docs to use for updating the perceptron weightsbias- the bias 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 classifier- Throws:
IOException- if the building of the underlyingFSTfails and / orTermsEnumfor the text field cannot be found
-
-
Method Detail
-
assignClass
public ClassificationResult<Boolean> assignClass(String text) throws IOException
Description copied from interface:ClassifierAssign a class (with score) to the given text String- Specified by:
assignClassin interfaceClassifier<Boolean>- Parameters:
text- a String containing text to be classified- Returns:
- a
ClassificationResultholding assigned class of typeTand score - Throws:
IOException- If there is a low-level I/O error.
-
getClasses
public List<ClassificationResult<Boolean>> getClasses(String text)
Description copied from interface:ClassifierGet all the classes (sorted by score, descending) assigned to the given text String.- Specified by:
getClassesin interfaceClassifier<Boolean>- Parameters:
text- a String containing text to be classified- Returns:
- the whole list of
ClassificationResult, the classes and scores. Returnsnullif the classifier can't make lists.
-
getClasses
public List<ClassificationResult<Boolean>> getClasses(String text, int max)
Description copied from interface:ClassifierGet the firstmaxclasses (sorted by score, descending) assigned to the given text String.- Specified by:
getClassesin interfaceClassifier<Boolean>- Parameters:
text- a String containing text to be classifiedmax- the number of return list elements- Returns:
- the whole list of
ClassificationResult, the classes and scores. Cut for "max" number of elements. Returnsnullif the classifier can't make lists.
-
-