/*
* 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.chunker;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Map;
import java.util.Properties;
import opennlp.tools.ml.BeamSearch;
import opennlp.tools.ml.model.AbstractModel;
import opennlp.tools.ml.model.BinaryFileDataReader;
import opennlp.tools.ml.model.GenericModelReader;
import opennlp.tools.ml.model.MaxentModel;
import opennlp.tools.ml.model.SequenceClassificationModel;
import opennlp.tools.namefind.NameFinderME;
import opennlp.tools.util.BaseToolFactory;
import opennlp.tools.util.InvalidFormatException;
import opennlp.tools.util.model.BaseModel;
/**
* The {@link ChunkerModel} is the model used
* by a learnable {@link Chunker}.
*
* @see ChunkerME
*/
public class ChunkerModel extends BaseModel {
private static final String COMPONENT_NAME = "ChunkerME";
private static final String CHUNKER_MODEL_ENTRY_NAME = "chunker.model";
/**
* @deprecated Use
* {@link #ChunkerModel(String, MaxentModel, Map, ChunkerFactory)}
* instead.
*/
public ChunkerModel(String languageCode, MaxentModel chunkerModel, Map<String, String> manifestInfoEntries) {
this(languageCode, chunkerModel, ChunkerME.DEFAULT_BEAM_SIZE, manifestInfoEntries, new ChunkerFactory());
}
public ChunkerModel(String languageCode, SequenceClassificationModel<String> chunkerModel,
Map<String, String> manifestInfoEntries, ChunkerFactory factory) {
super(COMPONENT_NAME, languageCode, manifestInfoEntries, factory);
artifactMap.put(CHUNKER_MODEL_ENTRY_NAME, chunkerModel);
checkArtifactMap();
}
public ChunkerModel(String languageCode, MaxentModel chunkerModel,
Map<String, String> manifestInfoEntries, ChunkerFactory factory) {
this(languageCode, chunkerModel, ChunkerME.DEFAULT_BEAM_SIZE, manifestInfoEntries, factory);
}
public ChunkerModel(String languageCode, MaxentModel chunkerModel, int beamSize,
Map<String, String> manifestInfoEntries, ChunkerFactory factory) {
super(COMPONENT_NAME, languageCode, manifestInfoEntries, factory);
artifactMap.put(CHUNKER_MODEL_ENTRY_NAME, chunkerModel);
Properties manifest = (Properties) artifactMap.get(MANIFEST_ENTRY);
manifest.put(BeamSearch.BEAM_SIZE_PARAMETER, Integer.toString(beamSize));
checkArtifactMap();
}
/**
* @deprecated Use
* {@link #ChunkerModel(String, MaxentModel, ChunkerFactory)
* instead.}
*/
public ChunkerModel(String languageCode, MaxentModel chunkerModel) {
this(languageCode, chunkerModel, null, new ChunkerFactory());
}
public ChunkerModel(String languageCode, MaxentModel chunkerModel, ChunkerFactory factory) {
this(languageCode, chunkerModel, null, factory);
}
public ChunkerModel(InputStream in) throws IOException, InvalidFormatException {
super(COMPONENT_NAME, in);
}
public ChunkerModel(File modelFile) throws IOException, InvalidFormatException {
super(COMPONENT_NAME, modelFile);
}
public ChunkerModel(URL modelURL) throws IOException, InvalidFormatException {
super(COMPONENT_NAME, modelURL);
}
@Override
protected void validateArtifactMap() throws InvalidFormatException {
super.validateArtifactMap();
if (!(artifactMap.get(CHUNKER_MODEL_ENTRY_NAME) instanceof AbstractModel)) {
throw new InvalidFormatException("Chunker model is incomplete!");
}
}
/**
* @deprecated use getChunkerSequenceModel instead. This method will be removed soon.
*/
@Deprecated
public MaxentModel getChunkerModel() {
if (artifactMap.get(CHUNKER_MODEL_ENTRY_NAME) instanceof MaxentModel) {
return (MaxentModel) artifactMap.get(CHUNKER_MODEL_ENTRY_NAME);
}
else {
return null;
}
}
public SequenceClassificationModel<String> getChunkerSequenceModel() {
Properties manifest = (Properties) artifactMap.get(MANIFEST_ENTRY);
if (artifactMap.get(CHUNKER_MODEL_ENTRY_NAME) instanceof MaxentModel) {
String beamSizeString = manifest.getProperty(BeamSearch.BEAM_SIZE_PARAMETER);
int beamSize = NameFinderME.DEFAULT_BEAM_SIZE;
if (beamSizeString != null) {
beamSize = Integer.parseInt(beamSizeString);
}
return new BeamSearch<>(beamSize, (MaxentModel) artifactMap.get(CHUNKER_MODEL_ENTRY_NAME));
}
else if (artifactMap.get(CHUNKER_MODEL_ENTRY_NAME) instanceof SequenceClassificationModel) {
return (SequenceClassificationModel) artifactMap.get(CHUNKER_MODEL_ENTRY_NAME);
}
else {
return null;
}
}
@Override
protected Class<? extends BaseToolFactory> getDefaultFactory() {
return ChunkerFactory.class;
}
public ChunkerFactory getFactory() {
return (ChunkerFactory) this.toolFactory;
}
public static void main(String[] args) throws FileNotFoundException, IOException {
if (args.length != 4){
System.err.println("ChunkerModel -lang code packageName modelName");
System.exit(1);
}
String lang = args[1];
String packageName = args[2];
String modelName = args[3];
AbstractModel chunkerModel = new GenericModelReader(
new BinaryFileDataReader(new FileInputStream(modelName))).getModel();
ChunkerModel packageModel = new ChunkerModel(lang, chunkerModel);
packageModel.serialize(new FileOutputStream(packageName));
}
}