This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.PMML.Model.AbstractModel

%DeepSee.PMML.Model.AbstractModel

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

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

Property Inventory (Including Private)

Method Inventory (Including Private)

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 (Including Private)

property Tracing as %Boolean [ InitialExpression = 0 ];
Whether or not to generate trace information in the output object.
Property methods: TracingDisplayToLogical(), TracingGet(), TracingIsValid(), TracingLogicalToDisplay(), TracingNormalize(), TracingSet()

Methods (Including Private)

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.

abstract private method %ExecuteModelInternal(ByRef pInput As %DeepSee.PMML.ModelInput, Output pOutput As %DeepSee.PMML.ModelOutput) as %Status
To be implemented by subclasses
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.

Inherited Members

Inherited Methods (Including Private)

Subclasses

FeedbackOpens in a new window