weka.classifiers.pmml.consumer

Class GeneralRegression

java.lang.Object

weka.classifiers.Classifier

weka.classifiers.pmml.consumer.PMMLClassifier

weka.classifiers.pmml.consumer.GeneralRegression

All Implemented Interfaces:

Serializable, Cloneable, CapabilitiesHandler, OptionHandler, PMMLModel, RevisionHandler

public class GeneralRegression
extends PMMLClassifier
implements Serializable

Class implementing import of PMML General Regression model. Can be used as a Weka classifier for prediction (buildClassifier() raises an Exception).

Version:

$Revision: 5562 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_algorithmName
protected ArrayList<weka.classifiers.pmml.consumer.GeneralRegression.Predictor>	m_covariateList
protected weka.classifiers.pmml.consumer.GeneralRegression.CumulativeLinkFunction	m_cumulativeLinkFunction
protected double	m_distParameter
protected weka.classifiers.pmml.consumer.GeneralRegression.Distribution	m_distribution
protected ArrayList<weka.classifiers.pmml.consumer.GeneralRegression.Predictor>	m_factorList
protected int	m_functionType
protected weka.classifiers.pmml.consumer.GeneralRegression.LinkFunction	m_linkFunction
protected double	m_linkParameter
protected String	m_modelName
protected weka.classifiers.pmml.consumer.GeneralRegression.ModelType	m_modelType
protected double	m_offsetValue
protected String	m_offsetVariable
protected ArrayList<weka.classifiers.pmml.consumer.GeneralRegression.Parameter>	m_parameterList
protected weka.classifiers.pmml.consumer.GeneralRegression.PCell[][]	m_paramMatrix
protected weka.classifiers.pmml.consumer.GeneralRegression.PPCell[][]	m_ppMatrix
protected double	m_trialsValue
protected String	m_trialsVariable

Fields inherited from class weka.classifiers.pmml.consumer.PMMLClassifier

m_creatorApplication, m_dataDictionary, m_fieldsMap, m_initialized, m_log, m_miningSchema, m_pmmlVersion

Fields inherited from class weka.classifiers.Classifier

m_Debug

Constructor Summary

Constructors

Constructor and Description
GeneralRegression(Element model, Instances dataDictionary, MiningSchema miningSchema) Constructs a GeneralRegression classifier.

Method Summary

Modifier and Type	Method and Description
double[]	distributionForInstance(Instance inst) Classifies the given test instance.
String	getRevision() Returns the revision string.
protected void	printParameterMatrix(StringBuffer buff) Format and print the parameter matrix to the supplied StringBuffer.
protected void	printPPMatrix(StringBuffer buff) Format and print the PPMatrix to the supplied StringBuffer.
protected void	readFactorsAndCovariates(Element model, String factorOrCovariate) Read the lists of factors and covariates.
protected void	readParameterList(Element model) Read the list of parameters.
protected void	readPPMatrix(Element model) Read the PPMatrix from the xml.
String	toString() Return a textual description of this general regression.

Methods inherited from class weka.classifiers.pmml.consumer.PMMLClassifier

buildClassifier, done, getCreatorApplication, getDataDictionary, getFieldsMappingString, getLog, getMiningSchema, getPMMLVersion, mapToMiningSchema, setCreatorApplication, setLog, setPMMLVersion

Methods inherited from class weka.classifiers.Classifier

classifyInstance, debugTipText, forName, getCapabilities, getDebug, getOptions, listOptions, makeCopies, makeCopy, runClassifier, setDebug, setOptions

Methods inherited from class java.lang.Object

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

Field Detail

m_modelType

protected weka.classifiers.pmml.consumer.GeneralRegression.ModelType m_modelType

m_modelName

protected String m_modelName

m_algorithmName

protected String m_algorithmName

m_functionType

protected int m_functionType

m_cumulativeLinkFunction

protected weka.classifiers.pmml.consumer.GeneralRegression.CumulativeLinkFunction m_cumulativeLinkFunction

m_linkFunction

protected weka.classifiers.pmml.consumer.GeneralRegression.LinkFunction m_linkFunction

m_linkParameter

protected double m_linkParameter

m_trialsVariable

protected String m_trialsVariable

m_trialsValue

protected double m_trialsValue

m_distribution

protected weka.classifiers.pmml.consumer.GeneralRegression.Distribution m_distribution

m_distParameter

protected double m_distParameter

m_offsetVariable

protected String m_offsetVariable

m_offsetValue

protected double m_offsetValue

m_parameterList

protected ArrayList<weka.classifiers.pmml.consumer.GeneralRegression.Parameter> m_parameterList

m_factorList

protected ArrayList<weka.classifiers.pmml.consumer.GeneralRegression.Predictor> m_factorList

m_covariateList

protected ArrayList<weka.classifiers.pmml.consumer.GeneralRegression.Predictor> m_covariateList

m_ppMatrix

protected weka.classifiers.pmml.consumer.GeneralRegression.PPCell[][] m_ppMatrix

m_paramMatrix

protected weka.classifiers.pmml.consumer.GeneralRegression.PCell[][] m_paramMatrix

Constructor Detail

GeneralRegression

public GeneralRegression(Element model,
                         Instances dataDictionary,
                         MiningSchema miningSchema)
                  throws Exception

Constructs a GeneralRegression classifier.

Parameters:

model - the Element that holds the model definition

dataDictionary - the data dictionary as a set of Instances

miningSchema - the mining schema

Throws:

Exception - if there is a problem constructing the general regression object from the PMML.

Method Detail

readParameterList

protected void readParameterList(Element model)
                          throws Exception

Read the list of parameters.

Parameters:

model - the Element that contains the model

Throws:

Exception - if there is some problem with extracting the parameters.

readFactorsAndCovariates

protected void readFactorsAndCovariates(Element model,
                                        String factorOrCovariate)
                                 throws Exception

Read the lists of factors and covariates.

Parameters:

model - the Element that contains the model

factorOrCovariate - holds the String "FactorList" or "CovariateList"

Throws:

Exception - if there is a factor or covariate listed that isn't in the mining schema

readPPMatrix

protected void readPPMatrix(Element model)
                     throws Exception

Read the PPMatrix from the xml. Does not handle multiple PPMatrixes yet.

Parameters:

model - the Element that contains the model

Throws:

Exception - if there is a problem parsing cell values.

toString

public String toString()

Return a textual description of this general regression.

Overrides:

toString in class Object

Returns:

a description of this general regression

printPPMatrix

protected void printPPMatrix(StringBuffer buff)

Format and print the PPMatrix to the supplied StringBuffer.

Parameters:

buff - the StringBuffer to append to

printParameterMatrix

protected void printParameterMatrix(StringBuffer buff)

Format and print the parameter matrix to the supplied StringBuffer.

Parameters:

buff - the StringBuffer to append to

distributionForInstance

public double[] distributionForInstance(Instance inst)
                                 throws Exception

Classifies the given test instance. The instance has to belong to a dataset when it's being classified.

Overrides:

distributionForInstance in class Classifier

Parameters:

inst - the instance to be classified

Returns:

the predicted most likely class for the instance or Instance.missingValue() if no prediction is made

Throws:

Exception - if an error occurred during the prediction

getRevision

public String getRevision()

Description copied from class: Classifier

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Classifier

Returns:

the revision