org.cleartk.ml.crfsuite.CrfSuiteStringOutcomeClassifierBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleartk-ml-crfsuite Show documentation
ClearTK wrapper for the CRFsuite
There is a newer version: 3.0.0
/** 
 * Copyright 2011-2012
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 * All rights reserved.
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * For a complete copy of the license please see the file LICENSE distributed 
 * with the cleartk-syntax-berkeley project or visit 
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE. 
 */
package org.cleartk.ml.crfsuite;

import java.io.DataInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.jar.JarInputStream;
import java.util.jar.JarOutputStream;

import org.apache.uima.UIMAFramework;
import org.apache.uima.util.Level;
import org.apache.uima.util.Logger;
import org.cleartk.ml.encoder.features.NameNumber;
import org.cleartk.ml.jar.JarStreams;
import org.cleartk.ml.jar.SequenceClassifierBuilder_ImplBase;

/**
 * 
 * 
 * 

 * Copyright (c) 2011-2012, Technische Universität Darmstadt 

 * All rights reserved.
 * 
 * @author Martin Riedl
 */
public class CrfSuiteStringOutcomeClassifierBuilder
    extends

    SequenceClassifierBuilder_ImplBase, String, String> {
  public final String MODEL_NAME = "crfsuite.model";

  public final String TRAINING_NAME = "crfsuite.training";

  static Logger logger = UIMAFramework.getLogger(CrfSuiteStringOutcomeClassifierBuilder.class);

  @Override
  public File getTrainingDataFile(File dir) {
    return new File(dir, TRAINING_NAME);
  }

  @Override
  protected void packageClassifier(File dir, JarOutputStream modelStream) throws IOException {
    super.packageClassifier(dir, modelStream);
    JarStreams.putNextJarEntry(modelStream, MODEL_NAME, new File(dir, MODEL_NAME));
  }

  @Override
  public void trainClassifier(File dir, String... args) throws Exception {
    logger.log(Level.FINE, "Start learning CRFsuite classifier");
    CrfSuiteWrapper wrapper = new CrfSuiteWrapper();
    String model = new File(dir, MODEL_NAME).getPath();
    String trainingDataFile = getTrainingDataFile(dir).getPath();
    wrapper.trainClassifier(model, trainingDataFile, args);
    logger.log(Level.FINE, "Finished learning CRFsuite classifier");
  }

  private File modelFile = null;

  /**
   * As the filename of the model is not known the only solution is to write the model back to a
   * temporary file
   */
  @Override
  protected void unpackageClassifier(JarInputStream modelStream) throws IOException {
    super.unpackageClassifier(modelStream);
    JarStreams.getNextJarEntry(modelStream, MODEL_NAME);
    this.modelFile = File.createTempFile("model", ".crfsuite");
    this.modelFile.deleteOnExit();
    logger.log(Level.FINE, "Start writing model to " + modelFile.getAbsolutePath());

    InputStream inputStream = new DataInputStream(modelStream);
    OutputStream out = new FileOutputStream(modelFile);
    byte buf[] = new byte[1024];
    int len;
    while ((len = inputStream.read(buf)) > 0) {
      out.write(buf, 0, len);
    }
    out.close();
    inputStream.close();
    logger.log(Level.FINE, "Model is written to " + modelFile.getAbsolutePath());

  }

  @Override
  protected CrfSuiteStringOutcomeClassifier newClassifier() {
    return new CrfSuiteStringOutcomeClassifier(
        this.featuresEncoder,
        this.outcomeEncoder,
        this.modelFile);
  }

}