dragon.ml.seqmodel.crf

Interface Trainer

All Known Implementing Classes:

AbstractTrainer, CollinsBasicTrainer, CollinsSegmentTrainer, LBFGSBasicTrainer, LBFGSSegmentTrainer

public interface Trainer

Interface of CRF trainer

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

Modifier and Type	Method and Description
FeatureGenerator	getFeatureGenerator() Gets the feature generator
int	getMaxIteration() Gets the number of maximum iterations
ModelGraph	getModelGraph() Gets the model graph
double[]	getModelParameter() Gets the parameters of the CRF model
boolean	needScaling() Gets the scaling option.
boolean	saveModelParameter(String filename) Saves the parameters of the CRF model to a text file
void	setMaxIteration(int maxIteration) Sets the number of maximum iterations
void	setScalingOption(boolean option) Sets the scaling option
boolean	train(Dataset dataset) Trains the CRF model with labeled dataset

Method Detail

getModelGraph

ModelGraph getModelGraph()

Gets the model graph

Returns:

the model graph

getFeatureGenerator

FeatureGenerator getFeatureGenerator()

Gets the feature generator

Returns:

the feature generator

getModelParameter

double[] getModelParameter()

Gets the parameters of the CRF model

Returns:

the parameters of the CRF model

saveModelParameter

boolean saveModelParameter(String filename)

Saves the parameters of the CRF model to a text file

Parameters:

filename - the name of the file the model parameters will save to

Returns:

true if saving successfully

train

boolean train(Dataset dataset)

Trains the CRF model with labeled dataset

Parameters:

dataset - the dataset for training

Returns:

true if trained successfully

needScaling

boolean needScaling()

Gets the scaling option. The likelihood of the sequence may be too small. Thus it may be necessary to scale the likelihood

Returns:

true if the training needs scaling

setScalingOption

void setScalingOption(boolean option)

Sets the scaling option

Parameters:

option - the scaling option

getMaxIteration

int getMaxIteration()

Gets the number of maximum iterations

Returns:

the number of maximum iterations

setMaxIteration

void setMaxIteration(int maxIteration)

Sets the number of maximum iterations

Parameters:

maxIteration - the number of maximum iterations