%DeepSee.PMML.Definition

abstract class %DeepSee.PMML.Definition extends %ZEN.Component.page

This class represents a predictive model described in PMML (Predictive Modelling Markup Language), an XML standard managed by the Data Mining Group (www.dmg.orgOpens in a new tab) for describing Predictive Analytics models.

Subclasses of this class should provide this XML in an XData block named PMML, so it will be validated and interpreted upon compiling the class. Upon compilation, additional helper classes will be automatically generated:

• A single %DeepSee.PMML.Data class representing the data fields required by this model.
• A class for each model described in this PMML fragment (can be more than one), with dedicated code to execute this model.
• %DeepSee.PMML.ModelInput and %DeepSee.PMML.ModelOutput classes for each model, which are instantiated and managed automatically by the model class.

In addition to the generated classes, subclasses of this class are also available as Zen pages so the models they define can be run from a User Interface.

Use this class' %GetModelClassName() to retrieve the model class for a named model in the PMML definition and then invoke its %Execute* methods as desired. See also the %DeepSee.PMML.Model.AbstractModel class reference for more information about these execution options, or %DeepSee.PMML.Utils for executing the model against a batch of records at once.

Method Inventory

• %GetDataClassName()
• %GetModelClassName()
• %GetModelInstance()
• %OnAfterCreatePage()
• disableUnusedFields()
• onChangeModel()
• onloadHandler()
• reset()
• update()

Parameters

parameter DOMAIN = PMML;

Inherited description: Localization domain

Methods

classmethod %GetDataClassName() as %String

Returns the name of the %DeepSee.PMML.Data class generated upon compiling this PMML definiton.

classmethod %GetModelClassName(ByRef pModelName As %String = "") as %String

Returns the class name of the model identified by pModelName in PMML. If left blank, returns the class name of the first model in the model definition, setting pModelName to its logical name at the same time.

classmethod %GetModelInstance(ByRef pModelName As %String = "", ByRef pModel As %DeepSee.PMML.Model.AbstractModel) as %Status

This method returns a %DeepSee.PMML.Model.AbstractModel instance for the model in this definition corresponding to pModelName.

method %OnAfterCreatePage() as %Status

Populates the properties and models on this Zen page according to the contents of PMML

clientmethod disableUnusedFields() [ Language = javascript ]

clientmethod onChangeModel(model) [ Language = javascript ]

Invoked when selecting a model in the GUI

clientmethod onloadHandler() [ Language = javascript ]

Inherited description: This client event, if present, is fired when the page is loaded.

clientmethod reset() [ Language = javascript ]

clientmethod update(id, value) [ Language = javascript ]

Update test page contents based on user input