org.maltparser.ml.lib

Class Lib

java.lang.Object

org.maltparser.ml.lib.Lib

All Implemented Interfaces:

LearningMethod

Direct Known Subclasses:

LibLinear, LibSvm

public abstract class Lib
extends java.lang.Object
implements LearningMethod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Lib.Verbostity

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatureMap	featureMap
protected MaltLibModel	model
protected Lib.Verbostity	verbosity

Fields inherited from interface org.maltparser.ml.LearningMethod

BATCH, CLASSIFY

Constructor Summary

Constructors

Constructor and Description
Lib(InstanceModel owner, java.lang.Integer learnerMode, java.lang.String learningMethodName) Constructs a Lib learner.

Method Summary

Modifier and Type	Method and Description
void	addInstance(SingleDecision decision, FeatureVector featureVector)
protected int	binariesInstance(java.lang.String line, FeatureList featureList)
protected void	binariesInstances2SVMFileFormat(java.io.InputStreamReader isr, java.io.OutputStreamWriter osw)
protected void	closeInstanceWriter()
void	decreaseNumberOfInstances()
protected void	finalize()
void	finalizeSentence(DependencyStructure dependencyGraph)
abstract java.lang.String	getAllowedLibOptionFlags()
protected java.lang.Object	getConfigFileEntryObject(java.lang.String suffix)
DependencyParserConfig	getConfiguration() Returns the current configuration
abstract java.util.LinkedHashMap<java.lang.String,java.lang.String>	getDefaultLibOptions()
protected java.io.File	getFile(java.lang.String suffix)
protected java.io.InputStream	getInputStreamFromConfigFileEntry(java.lang.String suffix)
protected java.io.InputStreamReader	getInstanceInputStreamReader(java.lang.String suffix)
protected java.io.OutputStreamWriter	getInstanceOutputStreamWriter(java.lang.String suffix)
java.io.BufferedWriter	getInstanceWriter()
int	getLearnerMode()
java.lang.String	getLearningMethodName()
java.lang.String[]	getLibParamStringArray(java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions)
int	getNumberOfInstances()
InstanceModel	getOwner()
void	increaseNumberOfInstances()
protected FeatureMap	loadFeatureMap(java.io.InputStream is)
void	moveAllInstances(LearningMethod method, FeatureFunction divideFeature, java.util.ArrayList<java.lang.Integer> divideFeatureIndexVector)
void	noMoreInstances()
void	parseParameters(java.lang.String paramstring, java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions, java.lang.String allowedLibOptionFlags)
boolean	predict(FeatureVector featureVector, SingleDecision decision)
protected void	saveFeatureMap(java.io.OutputStream os, FeatureMap map)
protected void	setNumberOfInstances(int numberOfInstances)
void	terminate()
java.lang.String	toString()
void	train()
protected abstract void	trainExternal(java.lang.String pathExternalTrain, java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions)
protected abstract void	trainInternal(java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

verbosity

protected final Lib.Verbostity verbosity

featureMap

protected final FeatureMap featureMap

model

protected MaltLibModel model

Constructor Detail

Lib

public Lib(InstanceModel owner,
           java.lang.Integer learnerMode,
           java.lang.String learningMethodName)
    throws MaltChainedException

Constructs a Lib learner.

Parameters:

owner - the guide model owner

learnerMode - the mode of the learner BATCH or CLASSIFY

Throws:

MaltChainedException

Method Detail

addInstance

public void addInstance(SingleDecision decision,
                        FeatureVector featureVector)
                 throws MaltChainedException

Specified by:

addInstance in interface LearningMethod

Throws:

MaltChainedException

finalizeSentence

public void finalizeSentence(DependencyStructure dependencyGraph)
                      throws MaltChainedException

Specified by:

finalizeSentence in interface LearningMethod

Throws:

MaltChainedException

moveAllInstances

public void moveAllInstances(LearningMethod method,
                             FeatureFunction divideFeature,
                             java.util.ArrayList<java.lang.Integer> divideFeatureIndexVector)
                      throws MaltChainedException

Specified by:

moveAllInstances in interface LearningMethod

Throws:

MaltChainedException

noMoreInstances

public void noMoreInstances()
                     throws MaltChainedException

Specified by:

noMoreInstances in interface LearningMethod

Throws:

MaltChainedException

predict

public boolean predict(FeatureVector featureVector,
                       SingleDecision decision)
                throws MaltChainedException

Specified by:

predict in interface LearningMethod

Throws:

MaltChainedException

train

public void train()
           throws MaltChainedException

Specified by:

train in interface LearningMethod

Throws:

MaltChainedException

trainExternal

protected abstract void trainExternal(java.lang.String pathExternalTrain,
                                      java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions)
                               throws MaltChainedException

Throws:

MaltChainedException

trainInternal

protected abstract void trainInternal(java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions)
                               throws MaltChainedException

Throws:

MaltChainedException

terminate

public void terminate()
               throws MaltChainedException

Specified by:

terminate in interface LearningMethod

Throws:

MaltChainedException

getInstanceWriter

public java.io.BufferedWriter getInstanceWriter()

Specified by:

getInstanceWriter in interface LearningMethod

closeInstanceWriter

protected void closeInstanceWriter()
                            throws MaltChainedException

Throws:

MaltChainedException

getOwner

public InstanceModel getOwner()

getLearnerMode

public int getLearnerMode()

getLearningMethodName

public java.lang.String getLearningMethodName()

getConfiguration

public DependencyParserConfig getConfiguration()
                                        throws MaltChainedException

Returns the current configuration

Returns:

the current configuration

Throws:

MaltChainedException

getNumberOfInstances

public int getNumberOfInstances()
                         throws MaltChainedException

Throws:

MaltChainedException

increaseNumberOfInstances

public void increaseNumberOfInstances()

Specified by:

increaseNumberOfInstances in interface LearningMethod

decreaseNumberOfInstances

public void decreaseNumberOfInstances()

Specified by:

decreaseNumberOfInstances in interface LearningMethod

setNumberOfInstances

protected void setNumberOfInstances(int numberOfInstances)

getInstanceOutputStreamWriter

protected java.io.OutputStreamWriter getInstanceOutputStreamWriter(java.lang.String suffix)
                                                            throws MaltChainedException

Throws:

MaltChainedException

getInstanceInputStreamReader

protected java.io.InputStreamReader getInstanceInputStreamReader(java.lang.String suffix)
                                                          throws MaltChainedException

Throws:

MaltChainedException

getInputStreamFromConfigFileEntry

protected java.io.InputStream getInputStreamFromConfigFileEntry(java.lang.String suffix)
                                                         throws MaltChainedException

Throws:

MaltChainedException

getFile

protected java.io.File getFile(java.lang.String suffix)
                        throws MaltChainedException

Throws:

MaltChainedException

getConfigFileEntryObject

protected java.lang.Object getConfigFileEntryObject(java.lang.String suffix)
                                             throws MaltChainedException

Throws:

MaltChainedException

getLibParamStringArray

public java.lang.String[] getLibParamStringArray(java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions)

getDefaultLibOptions

public abstract java.util.LinkedHashMap<java.lang.String,java.lang.String> getDefaultLibOptions()

getAllowedLibOptionFlags

public abstract java.lang.String getAllowedLibOptionFlags()

parseParameters

public void parseParameters(java.lang.String paramstring,
                            java.util.LinkedHashMap<java.lang.String,java.lang.String> libOptions,
                            java.lang.String allowedLibOptionFlags)
                     throws MaltChainedException

Throws:

MaltChainedException

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

binariesInstance

protected int binariesInstance(java.lang.String line,
                               FeatureList featureList)
                        throws MaltChainedException

Throws:

MaltChainedException

binariesInstances2SVMFileFormat

protected void binariesInstances2SVMFileFormat(java.io.InputStreamReader isr,
                                               java.io.OutputStreamWriter osw)
                                        throws MaltChainedException

Throws:

MaltChainedException

saveFeatureMap

protected void saveFeatureMap(java.io.OutputStream os,
                              FeatureMap map)
                       throws MaltChainedException

Throws:

MaltChainedException

loadFeatureMap

protected FeatureMap loadFeatureMap(java.io.InputStream is)
                             throws MaltChainedException

Throws:

MaltChainedException