JarClassifierBuilder (ClearTK TimeML 2.0.0 API)

java.lang.Object
- org.cleartk.ml.jar.JarClassifierBuilder<CLASSIFIER_TYPE>

Direct Known Subclasses:

EncodingJarClassifierBuilder, SingleOutcomeClassifierBuilder, ViterbiClassifierBuilder
```
public abstract class JarClassifierBuilder<CLASSIFIER_TYPE>
extends Object
```
Superclass for builders which package classifiers as jar files. Saves a manifest from which new instances of this class can later be loaded. ClassifierBuilder subclasses that use feature or outcome encoders should instead subclass from EncodingJarClassifierBuilder. Subclasses will typically override:
- saveToTrainingDirectory(File) to add items to the model training directory
- packageClassifier(File, JarOutputStream) to copy items to the classifier jar
- unpackageClassifier(JarInputStream) to load items from the classifier jar
- newClassifier() to create a classifier from the loaded attributes
Copyright (c) 2011, Regents of the University of Colorado
All rights reserved.
Author:

Steven Bethard

Field Summary

Fields
Modifier and Type Field and Description

protected Manifest manifest
The manifest associated with this classifier builder.

Fields
Modifier and Type	Field and Description
`protected Manifest`	`manifest` The manifest associated with this classifier builder.

Constructor Summary

Constructors
Constructor and Description

JarClassifierBuilder()
Creates a new classifier builder with a default manifest.

Constructors
Constructor and Description
`JarClassifierBuilder()` Creates a new classifier builder with a default manifest.

Method Summary

Methods
Modifier and Type	Method and Description
`static JarClassifierBuilder<?>`	`fromManifest(Manifest manifest)` Loads a classifier builder from a manifest.
`static JarClassifierBuilder<?>`	`fromTrainingDirectory(File dir)` Loads a classifier builder from manifest in the training directory.
`static File`	`getModelJarFile(File dir)` Get the classifier jar file, as packaged by `packageClassifier(File)`.
`static File`	`getModelJarFile(String directoryName)`
`CLASSIFIER_TYPE`	`loadClassifier(InputStream inputStream)` Load a classifier packaged by `packageClassifier(File)` from an `InputStream`.
`CLASSIFIER_TYPE`	`loadClassifierFromTrainingDirectory(File dir)` Load a classifier packaged by `packageClassifier(File)` from the jar file in the training directory.
`protected abstract CLASSIFIER_TYPE`	`newClassifier()` Create a new classifier using the attributes loaded by `unpackageClassifier(JarInputStream)`.
`void`	`packageClassifier(File dir)` Create a classifier jar file from a directory where a classifier model was trained by `trainClassifier(File, String[])`.
`protected void`	`packageClassifier(File dir, JarOutputStream modelStream)` Add elements to a classifier jar.
`void`	`saveToTrainingDirectory(File dir)` Write all information stored in the classifier builder to the training directory.
`static void`	`trainAndPackage(File trainingDirectory, String... trainingArguments)` Loads a classifier builder from the training directory and invokes `trainClassifier(File, String...)` and `packageClassifier(File)`.
`abstract void`	`trainClassifier(File dir, String... args)` Train a classifier from a training directory, as prepared by `saveToTrainingDirectory(File)`.
`protected void`	`unpackageClassifier(JarInputStream modelStream)` Load classifier elements from a classifier jar.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - manifest
```
protected Manifest manifest
```
    The manifest associated with this classifier builder. The manifest will be saved to directories and jar files (via saveToTrainingDirectory(File) and packageClassifier(File) and can be used to load a new instance of the classifier builder (via loadClassifier(InputStream) and loadClassifierFromTrainingDirectory(File).
- Constructor Detail
  - JarClassifierBuilder
```
public JarClassifierBuilder()
```
    Creates a new classifier builder with a default manifest.
- Method Detail
  - fromManifest
```
public static JarClassifierBuilder<?> fromManifest(Manifest manifest)
```
    Loads a classifier builder from a manifest.
    
    Parameters:
    manifest - The classifier manifest, either from a training directory or from a classifier jar.
    
    Returns:
    A new classifier builder.
  - fromTrainingDirectory
```
public static JarClassifierBuilder<?> fromTrainingDirectory(File dir)
                                                     throws IOException
```
    Loads a classifier builder from manifest in the training directory.
    
    Parameters:
    dir - The training directory where the classifier builder was written by a call to saveToTrainingDirectory(File). This is typically the same directory as was used for DirectoryDataWriterFactory.PARAM_OUTPUT_DIRECTORY.
    
    Returns:
    A new classifier builder.
    
    Throws:
    
    IOException
  - getModelJarFile
```
public static File getModelJarFile(File dir)
```
    Get the classifier jar file, as packaged by packageClassifier(File).
    
    Parameters:
    dir - The directory where the classifier was packaged.
    
    Returns:
    The classifier jar file.
  - getModelJarFile
```
public static File getModelJarFile(String directoryName)
```
  - loadClassifier
```
public CLASSIFIER_TYPE loadClassifier(InputStream inputStream)
                               throws IOException
```
    Load a classifier packaged by packageClassifier(File) from an InputStream. This method should typically not be overridden by subclasses - use unpackageClassifier(JarInputStream) and newClassifier() instead.
    
    Parameters:
    inputStream - The classifier stream.
    
    Returns:
    The loaded classifier.
    
    Throws:
    
    IOException
  - loadClassifierFromTrainingDirectory
```
public CLASSIFIER_TYPE loadClassifierFromTrainingDirectory(File dir)
                                                    throws IOException
```
    Load a classifier packaged by packageClassifier(File) from the jar file in the training directory. This method should typically not be overridden by subclasses - use unpackageClassifier(JarInputStream) and newClassifier() instead.
    
    Parameters:
    dir - The directory where the classifier was trained and packaged.
    
    Returns:
    The loaded classifier.
    
    Throws:
    
    IOException
  - newClassifier
```
protected abstract CLASSIFIER_TYPE newClassifier()
```
    Create a new classifier using the attributes loaded by unpackageClassifier(JarInputStream).
    
    Returns:
    The loaded and initialized classifier.
  - packageClassifier
```
public void packageClassifier(File dir)
                       throws IOException
```
    Create a classifier jar file from a directory where a classifier model was trained by trainClassifier(File, String[]). This method should typically not be overridden by subclasses - use packageClassifier(File, JarOutputStream) instead.
    
    Parameters:
    dir - The directory where the classifier model was trained.
    
    Throws:
    
    IOException
  - packageClassifier
```
protected void packageClassifier(File dir,
                     JarOutputStream modelStream)
                          throws IOException
```
    Add elements to a classifier jar.
    
    Parameters:
    dir - The directory where the classifier model was trained.
    modelStream - The jar where the classifier is being written.
    
    Throws:
    
    IOException - For errors reading the directory or writing to the jar.
  - saveToTrainingDirectory
```
public void saveToTrainingDirectory(File dir)
                             throws IOException
```
    Write all information stored in the classifier builder to the training directory. Typically called by DataWriter.finish() or SequenceDataWriter.finish().
    
    Parameters:
    dir - The directory where classifier information should be written.
    
    Throws:
    
    IOException
  - trainAndPackage
```
public static void trainAndPackage(File trainingDirectory,
                   String... trainingArguments)
                            throws Exception
```
    Loads a classifier builder from the training directory and invokes trainClassifier(File, String...) and packageClassifier(File).
    
    Parameters:
    trainingDirectory - The directory where saveToTrainingDirectory(File) has saved the model training files.
    trainingArguments - Any additional arguments that should be passed to the classifier trainer via trainClassifier(File, String...).
    
    Throws:
    
    Exception
  - trainClassifier
```
public abstract void trainClassifier(File dir,
                   String... args)
                              throws Exception
```
    Train a classifier from a training directory, as prepared by saveToTrainingDirectory(File). Typically called at the command line by Train.main(String...).
    
    Parameters:
    dir - The directory where training data and other classifier information has been written and where the trained classifier should be stored.
    args - Additional command line arguments for the classifier trainer.
    
    Throws:
    
    Exception
  - unpackageClassifier
```
protected void unpackageClassifier(JarInputStream modelStream)
                            throws IOException
```
    Load classifier elements from a classifier jar. This will typically save such attributes as instance variables in preparation for a call to newClassifier().
    
    Parameters:
    modelStream - The classifier jar
    
    Throws:
    
    IOException - For errors reading from the jar.

Class JarClassifierBuilder<CLASSIFIER_TYPE>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

manifest

Constructor Detail

JarClassifierBuilder

Method Detail

fromManifest

fromTrainingDirectory

getModelJarFile

getModelJarFile

loadClassifier

loadClassifierFromTrainingDirectory

newClassifier

packageClassifier

packageClassifier

saveToTrainingDirectory

trainAndPackage

trainClassifier

unpackageClassifier