|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DistributionTrainerContext
A context within a group of DistributionTrainers can be trained together.
Method Summary | |
---|---|
void |
addCount(Distribution dist,
Symbol sym,
double times)
Registers that sym was counted in this state. |
void |
clearCounts()
Clears all of the counts to zero. |
double |
getCount(Distribution dist,
Symbol sym)
Return the number of counts of a particular symbol which will be used to train the specified distribution. |
double |
getNullModelWeight()
Return the number of pseudocounts added to the distribution when training. |
DistributionTrainer |
getTrainer(Distribution dist)
Return the Distribution trainer object from the current context. |
void |
registerDistribution(Distribution dist)
Register a distribution object with this context. |
void |
registerTrainer(Distribution dist,
DistributionTrainer trainer)
Register a Distribution and an associated DistributionTrainer object. |
void |
setNullModelWeight(double weight)
Set the number of pseudocounts to add when training the distribution. |
void |
train()
Trains the Distribution, given a null model. |
Method Detail |
---|
double getNullModelWeight()
void setNullModelWeight(double weight)
weight
- the new null model weightvoid registerDistribution(Distribution dist)
Register a distribution object with this context.
This method is a request to the context to register dist. If dist is already registered then this method should do nothing. If it is not registered, then it should invoke dist.registerWithTrainer
dist
- the Distribution to registervoid registerTrainer(Distribution dist, DistributionTrainer trainer)
Register a Distribution and an associated DistributionTrainer object.
In the registerWithTrainer method of a Distribution, it should associate itself with a trainer using this method.
dist
- the distribution to be registered.trainer
- the distribution's trainer object to be registered.DistributionTrainer getTrainer(Distribution dist)
dist
- the Distribution whose trainer is required
void addCount(Distribution dist, Symbol sym, double times) throws IllegalSymbolException
Registers that sym was counted in this state.
This method may be called multiple times with the same symbol. In this case, the times should be summed.
dist
- the Distribution that the symbol was associated withsym
- the Symbol seentimes
- the number of times to add
IllegalSymbolException
- if sym is not recognised by distdouble getCount(Distribution dist, Symbol sym) throws IllegalSymbolException
dist
- the Distribution to return counts forsym
- the symbol to get the count for
IllegalSymbolException
- if the symbol is not accepted by the
distributionvoid train() throws ChangeVetoException
Trains the Distribution, given a null model.
This will use the information collected with multiple addCount calls, and the null model to generate the new weights.
ChangeVetoException
- if any of the distributions can't be trainedvoid clearCounts()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |