/*
* 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.cmdline.doccat;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.LinkedList;
import java.util.List;
import opennlp.tools.cmdline.AbstractCrossValidatorTool;
import opennlp.tools.cmdline.ArgumentParser.OptionalParameter;
import opennlp.tools.cmdline.ArgumentParser.ParameterDescription;
import opennlp.tools.cmdline.CmdLineUtil;
import opennlp.tools.cmdline.TerminateToolException;
import opennlp.tools.cmdline.doccat.DoccatCrossValidatorTool.CVToolParams;
import opennlp.tools.cmdline.params.CVParams;
import opennlp.tools.doccat.DoccatCrossValidator;
import opennlp.tools.doccat.DoccatEvaluationMonitor;
import opennlp.tools.doccat.DoccatFactory;
import opennlp.tools.doccat.DocumentSample;
import opennlp.tools.doccat.FeatureGenerator;
import opennlp.tools.tokenize.Tokenizer;
import opennlp.tools.util.eval.EvaluationMonitor;
import opennlp.tools.util.model.ModelUtil;
public final class DoccatCrossValidatorTool extends
AbstractCrossValidatorTool<DocumentSample, CVToolParams> {
interface CVToolParams extends CVParams, TrainingParams {
@ParameterDescription(valueName = "outputFile", description = "the path of the fine-grained report file.")
@OptionalParameter
File getReportOutputFile();
}
public DoccatCrossValidatorTool() {
super(DocumentSample.class, CVToolParams.class);
}
public String getShortDescription() {
return "K-fold cross validator for the learnable Document Categorizer";
}
public void run(String format, String[] args) {
super.run(format, args);
mlParams = CmdLineUtil.loadTrainingParameters(params.getParams(), false);
if (mlParams == null) {
mlParams = ModelUtil.createDefaultTrainingParameters();
}
List<EvaluationMonitor<DocumentSample>> listeners = new LinkedList<EvaluationMonitor<DocumentSample>>();
if (params.getMisclassified()) {
listeners.add(new DoccatEvaluationErrorListener());
}
DoccatFineGrainedReportListener reportListener = null;
File reportFile = params.getReportOutputFile();
OutputStream reportOutputStream = null;
if (reportFile != null) {
CmdLineUtil.checkOutputFile("Report Output File", reportFile);
try {
reportOutputStream = new FileOutputStream(reportFile);
reportListener = new DoccatFineGrainedReportListener(reportOutputStream);
listeners.add(reportListener);
} catch (FileNotFoundException e) {
throw new TerminateToolException(-1,
"IO error while creating Doccat fine-grained report file: "
+ e.getMessage());
}
}
FeatureGenerator[] featureGenerators = DoccatTrainerTool
.createFeatureGenerators(params.getFeatureGenerators());
Tokenizer tokenizer = DoccatTrainerTool.createTokenizer(params
.getTokenizer());
DoccatEvaluationMonitor[] listenersArr = listeners
.toArray(new DoccatEvaluationMonitor[listeners.size()]);
DoccatCrossValidator validator;
try {
DoccatFactory factory = DoccatFactory.create(params.getFactory(),
tokenizer, featureGenerators);
validator = new DoccatCrossValidator(params.getLang(), mlParams,
factory, listenersArr);
validator.evaluate(sampleStream, params.getFolds());
} catch (IOException e) {
throw new TerminateToolException(-1,
"IO error while reading training data or indexing data: "
+ e.getMessage(), e);
} finally {
try {
sampleStream.close();
} catch (IOException e) {
// sorry that this can fail
}
}
System.out.println("done");
if (reportListener != null) {
System.out.println("Writing fine-grained report to "
+ params.getReportOutputFile().getAbsolutePath());
reportListener.writeReport();
try {
// TODO: is it a problem to close the stream now?
reportOutputStream.close();
} catch (IOException e) {
// nothing to do
}
}
System.out.println();
System.out.println("Accuracy: " + validator.getDocumentAccuracy() + "\n" +
"Number of documents: " + validator.getDocumentCount());
}
}