opennlp.tools.util

Class TrainingParameters

java.lang.Object

opennlp.tools.util.TrainingParameters

public class TrainingParameters
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALGORITHM_PARAM
static java.lang.String	CUTOFF_PARAM
static java.lang.String	ITERATIONS_PARAM
static java.lang.String	TRAINER_TYPE_PARAM

Constructor Summary

Constructors

Constructor and Description
TrainingParameters()
TrainingParameters(java.io.InputStream in)

Method Summary

Modifier and Type	Method and Description
java.lang.String	algorithm() Retrieves the training algorithm name.
java.lang.String	algorithm(java.lang.String namespace) Retrieves the training algorithm name for a given name space.
static TrainingParameters	defaultParams()
TrainingParameters	getParameters(java.lang.String namespace)
java.util.Map<java.lang.String,java.lang.String>	getSettings() Retrieves all parameters without a name space.
java.util.Map<java.lang.String,java.lang.String>	getSettings(java.lang.String namespace) Retrieves a map with the training parameters which have the passed name space.
void	put(java.lang.String key, java.lang.String value)
void	put(java.lang.String namespace, java.lang.String key, java.lang.String value)
void	serialize(java.io.OutputStream out)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALGORITHM_PARAM

public static final java.lang.String ALGORITHM_PARAM

See Also:

Constant Field Values

TRAINER_TYPE_PARAM

public static final java.lang.String TRAINER_TYPE_PARAM

See Also:

Constant Field Values

ITERATIONS_PARAM

public static final java.lang.String ITERATIONS_PARAM

See Also:

Constant Field Values

CUTOFF_PARAM

public static final java.lang.String CUTOFF_PARAM

See Also:

Constant Field Values

Constructor Detail

TrainingParameters

public TrainingParameters()

TrainingParameters

public TrainingParameters(java.io.InputStream in)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

algorithm

public java.lang.String algorithm(java.lang.String namespace)

Retrieves the training algorithm name for a given name space.

Returns:

the name or null if not set.

algorithm

public java.lang.String algorithm()

Retrieves the training algorithm name.

Returns:

the name or null if not set.

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings(java.lang.String namespace)

Retrieves a map with the training parameters which have the passed name space.

Parameters:

namespace -

Returns:

a parameter map which can be passed to the train and validate methods.

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings()

Retrieves all parameters without a name space.

Returns:

the settings map

getParameters

public TrainingParameters getParameters(java.lang.String namespace)

put

public void put(java.lang.String namespace,
                java.lang.String key,
                java.lang.String value)

put

public void put(java.lang.String key,
                java.lang.String value)

serialize

public void serialize(java.io.OutputStream out)
               throws java.io.IOException

Throws:

java.io.IOException

defaultParams

public static final TrainingParameters defaultParams()