Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %DeepSee.PMML.Model.AbstractModel
Private  Storage   

%DeepSee.PMML.Model.AbstractModel


abstract class %DeepSee.PMML.Model.AbstractModel extends
%RegisteredObject

This class represents a PMML model as defined in the PMML XData block of a %DeepSee.PMML.Definition class.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 3 21


Summary


Properties
Tracing

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %ExecuteModel
%ExecuteModelDeepSee %Extends %GetDataClassName %GetInputClassName
%GetInputObject %GetName %GetOutputClassName %GetParameter
%GetPredictedField %GetPredictedFieldInfo %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject

Subclasses
%DeepSee.PMML.Model.Clustering %DeepSee.PMML.Model.Composite %DeepSee.PMML.Model.GeneralRegression
%DeepSee.PMML.Model.NaiveBayes %DeepSee.PMML.Model.NeuralNetwork %DeepSee.PMML.Model.Regression
%DeepSee.PMML.Model.RuleSet %DeepSee.PMML.Model.SVM %DeepSee.PMML.Model.Text
%DeepSee.PMML.Model.Tree

Parameters


• parameter DATACLASS;
The name of the root %DeepSee.PMML.Data class for this model's PMML definition
• parameter INPUTCLASS;
The name of the %DeepSee.PMML.ModelInput class for this model
• parameter MODELNAME;
The name of this model as defined in the PMML definition
• parameter OUTPUTCLASS;
The name of the %DeepSee.PMML.ModelOutput class for this model
• parameter PREDICTEDFIELD;
The field in DATACLASS predicted by this model.

Properties


• property Tracing as %Boolean [ InitialExpression = 0 ];
Whether or not to generate trace information in the output object.

Methods


• final method %ExecuteModel(ByRef pData As %DeepSee.PMML.Data, Output pOutput As %DeepSee.PMML.ModelOutput) as %Status

Executes this model for a given %DeepSee.PMML.Data data object. As an alternative to providing the actual Data Class (or model input class) for this model, it is also possible to supply a simple array containing the data field values indexed by field name.

See also %DeepSee.PMML.Utils for details about running a model against a whole set of records at once, writing the corresponding results to a table.

• final method %ExecuteModelDeepSee(pFactId As %Integer, Output pOutput As %DeepSee.PMML.ModelOutput, pDataSource As %String = "") as %Status
This method runs the model against a fact from the DeepSee fact table of a cube for which an <X-DeepSeeDataSource> element defines a mapping from the cube's measures and dimensions to the Data Fields in the PMML definition. If pDataSource is null, the first DataSource of the model definition is expected to contain this DeepSee-to-PMML mapping.

• final classmethod %GetDataClassName() as %String
• final classmethod %GetInputClassName() as %String
• final classmethod %GetInputObject(pData As %DeepSee.PMML.Data) as %DeepSee.PMML.ModelInput
Builds a %DeepSee.PMML.ModelInput object based on the root %DeepSee.PMML.Data for this PMML definition.
• final classmethod %GetName() as %String
Returns the name of this model (similar to MODELNAME)
• final classmethod %GetOutputClassName() as %String
• final classmethod %GetPredictedField() as %String
• classmethod %GetPredictedFieldInfo(Output pFieldName As %String, Output pDataType As %String, Output pOpType As %String) as %Status
Returns basic info about the data field predicted by this model.