/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package opennlp.tools.namefind;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import opennlp.tools.cmdline.PerformanceMonitor;
import opennlp.tools.util.InvalidFormatException;
import opennlp.tools.util.ObjectStream;
import opennlp.tools.util.PlainTextByLineStream;
import opennlp.tools.util.Span;
import opennlp.tools.util.eval.Evaluator;
import opennlp.tools.util.eval.FMeasure;
/**
* The {@link TokenNameFinderEvaluator} measures the performance
* of the given {@link TokenNameFinder} with the provided
* reference {@link NameSample}s.
*
* @see Evaluator
* @see TokenNameFinder
* @see NameSample
*/
public class TokenNameFinderEvaluator extends Evaluator<NameSample> {
private FMeasure fmeasure = new FMeasure();
/**
* The {@link TokenNameFinder} used to create the predicted
* {@link NameSample} objects.
*/
private TokenNameFinder nameFinder;
/**
* Initializes the current instance with the given
* {@link TokenNameFinder}.
*
* @param nameFinder the {@link TokenNameFinder} to evaluate.
* @param listeners evaluation sample listeners
*/
public TokenNameFinderEvaluator(TokenNameFinder nameFinder, TokenNameFinderEvaluationMonitor ... listeners) {
super(listeners);
this.nameFinder = nameFinder;
}
/**
* Evaluates the given reference {@link NameSample} object.
*
* This is done by finding the names with the
* {@link TokenNameFinder} in the sentence from the reference
* {@link NameSample}. The found names are then used to
* calculate and update the scores.
*
* @param reference the reference {@link NameSample}.
*
* @return the predicted {@link NameSample}.
*/
@Override
protected NameSample processSample(NameSample reference) {
if (reference.isClearAdaptiveDataSet()) {
nameFinder.clearAdaptiveData();
}
Span predictedNames[] = nameFinder.find(reference.getSentence());
Span references[] = reference.getNames();
fmeasure.updateScores(references, predictedNames);
return new NameSample(reference.getSentence(), predictedNames, reference.isClearAdaptiveDataSet());
}
public FMeasure getFMeasure() {
return fmeasure;
}
@Deprecated
public static void main(String[] args) throws IOException,
InvalidFormatException {
if (args.length == 4) {
System.out.println("Loading name finder model ...");
InputStream modelIn = new FileInputStream(args[3]);
TokenNameFinderModel model = new TokenNameFinderModel(modelIn);
TokenNameFinder nameFinder = new NameFinderME(model);
System.out.println("Performing evaluation ...");
TokenNameFinderEvaluator evaluator = new TokenNameFinderEvaluator(nameFinder);
final NameSampleDataStream sampleStream = new NameSampleDataStream(
new PlainTextByLineStream(new InputStreamReader(new FileInputStream(args[2]), args[1])));
final PerformanceMonitor monitor = new PerformanceMonitor("sent");
monitor.startAndPrintThroughput();
ObjectStream<NameSample> iterator = new ObjectStream<NameSample>() {
public NameSample read() throws IOException {
monitor.incrementCounter();
return sampleStream.read();
}
public void reset() throws IOException {
sampleStream.reset();
}
public void close() throws IOException {
sampleStream.close();
}
};
evaluator.evaluate(iterator);
monitor.stopAndPrintFinalResult();
System.out.println();
System.out.println("F-Measure: " + evaluator.getFMeasure().getFMeasure());
System.out.println("Recall: " + evaluator.getFMeasure().getRecallScore());
System.out.println("Precision: " + evaluator.getFMeasure().getPrecisionScore());
}
else {
// usage: -encoding code test.file model.file
}
}
}