|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object opennlp.maxent.GISModel
public final class GISModel
A maximum entropy model which has been trained using the Generalized Iterative Scaling procedure (implemented in GIS.java).
Constructor Summary | |
---|---|
GISModel(Context[] params,
java.lang.String[] predLabels,
java.lang.String[] outcomeNames,
int correctionConstant,
double correctionParam)
Creates a new model with the specified parameters, outcome names, and predicate/feature labels. |
|
GISModel(Context[] params,
java.lang.String[] predLabels,
java.lang.String[] outcomeNames,
int correctionConstant,
double correctionParam,
Prior prior)
Creates a new model with the specified parameters, outcome names, and predicate/feature labels. |
Method Summary | |
---|---|
static double[] |
eval(int[] context,
double[] prior,
EvalParameters model)
Use this model to evaluate a context and return an array of the likelihood of each outcome given the specified context and the specified parameters. |
static double[] |
eval(int[] context,
float[] values,
double[] prior,
EvalParameters model)
Use this model to evaluate a context and return an array of the likelihood of each outcome given the specified context and the specified parameters. |
double[] |
eval(java.lang.String[] context)
Use this model to evaluate a context and return an array of the likelihood of each outcome given that context. |
double[] |
eval(java.lang.String[] context,
double[] outsums)
Evaluates a context. |
double[] |
eval(java.lang.String[] context,
float[] values)
Evaluates a contexts with the specified context values. |
double[] |
eval(java.lang.String[] context,
float[] values,
double[] outsums)
Use this model to evaluate a context and return an array of the likelihood of each outcome given that context. |
java.lang.String |
getAllOutcomes(double[] ocs)
Return a string matching all the outcome names with all the probabilities produced by the eval(String[] context)
method. |
java.lang.String |
getBestOutcome(double[] ocs)
Return the name of the outcome corresponding to the highest likelihood in the parameter ocs. |
java.lang.Object[] |
getDataStructures()
Provides the fundamental data structures which encode the maxent model information. |
int |
getIndex(java.lang.String outcome)
Gets the index associated with the String name of the given outcome. |
int |
getNumOutcomes()
Returns the number of outcomes for this model. |
java.lang.String |
getOutcome(int i)
Return the name of an outcome corresponding to an int id. |
static void |
main(java.lang.String[] args)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GISModel(Context[] params, java.lang.String[] predLabels, java.lang.String[] outcomeNames, int correctionConstant, double correctionParam)
params
- The parameters of the model.predLabels
- The names of the predicates used in this model.outcomeNames
- The names of the outcomes this model predicts.correctionConstant
- The maximum number of active features which occur in an event.correctionParam
- The parameter associated with the correction feature.public GISModel(Context[] params, java.lang.String[] predLabels, java.lang.String[] outcomeNames, int correctionConstant, double correctionParam, Prior prior)
params
- The parameters of the model.predLabels
- The names of the predicates used in this model.outcomeNames
- The names of the outcomes this model predicts.correctionConstant
- The maximum number of active features which occur in an event.correctionParam
- The parameter associated with the correction feature.prior
- The prior to be used with this model.Method Detail |
---|
public final double[] eval(java.lang.String[] context)
eval
in interface MaxentModel
context
- The names of the predicates which have been observed at
the present decision point.
public final double[] eval(java.lang.String[] context, float[] values)
MaxentModel
eval
in interface MaxentModel
context
- A list of String names of the contextual predicates
which are to be evaluated together.values
- The values associated with each context.
public static double[] eval(int[] context, double[] prior, EvalParameters model)
context
- The integer values of the predicates which have been observed at
the present decision point.prior
- The prior distribution for the specified context.model
- The set of parametes used in this computation.
public static double[] eval(int[] context, float[] values, double[] prior, EvalParameters model)
context
- The integer values of the predicates which have been observed at
the present decision point.values
- The values for each of the parameters.prior
- The prior distribution for the specified context.model
- The set of parametes used in this computation.
public final double[] eval(java.lang.String[] context, double[] outsums)
MaxentModel
eval
in interface MaxentModel
context
- A list of String names of the contextual predicates
which are to be evaluated together.outsums
- An array which is populated with the probabilities for each of the different
outcomes, all of which sum to 1.
public final double[] eval(java.lang.String[] context, float[] values, double[] outsums)
context
- The names of the predicates which have been observed at
the present decision point.outsums
- This is where the distribution is stored.
public final java.lang.String getBestOutcome(double[] ocs)
getBestOutcome
in interface MaxentModel
ocs
- A double[] as returned by the eval(String[] context)
method.
public final java.lang.String getAllOutcomes(double[] ocs)
eval(String[] context)
method.
getAllOutcomes
in interface MaxentModel
ocs
- A double[]
as returned by the
eval(String[] context)
method.
double[] ocs
)
for each one.public final java.lang.String getOutcome(int i)
getOutcome
in interface MaxentModel
i
- An outcome id.
public int getIndex(java.lang.String outcome)
getIndex
in interface MaxentModel
outcome
- the String name of the outcome for which the
index is desired
public int getNumOutcomes()
MaxentModel
getNumOutcomes
in interface MaxentModel
public final java.lang.Object[] getDataStructures()
getDataStructures
in interface MaxentModel
public static void main(java.lang.String[] args) throws java.io.IOException
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |