Utils Class Reference

This class bundles a number of utility methods for running PMML models and managing their results. More...

Static Public Member Functions
_.Library.Status	CreateFromFile (_.Library.String pFile, _.Library.String pClassName, _.Library.Boolean pOverwrite, _.Library.Boolean pCompile, _.Library.Boolean pVerbose)
	Creates a PMML definition class (<class>DeepSee.PMML.Definition</class>) based on the. More...
_.Library.Status	CreateFromStream (_.Stream.Object pStream, _.Library.String pClassName, _.Library.Boolean pOverwrite, _.Library.Boolean pCompile, _.Library.Boolean pVerbose)
	Creates a PMML definition class (<class>DeepSee.PMML.Definition</class>) based on the. More...
_.Library.Status	CreateFromString (_.Library.String pString, _.Library.String pClassName, _.Library.Boolean pOverwrite, _.Library.Boolean pCompile, _.Library.Boolean pVerbose)
	Creates a PMML definition class (<class>DeepSee.PMML.Definition</class>) based on the. More...

Static Private Member Functions
_.Library.Status	DropAllResults ()
	This class bundles a number of utility methods for running PMML models and managing their results. More...
_.Library.Status	DropResults (_.Library.Integer pTestId)
	Drops all results for a given test ID from the <class>DeepSee.PMML.Utils.TempResult</class> More...
_.Library.Status	RunModel (_.Library.Integer pResultsId, _.Library.String pDefinitionClass, _.Library.String pModelName, _.Library.String pDataSource, _.Library.String pResultsClass, _.Library.Boolean pTracking)
_.Library.Status	RunModelFromPMMLRows (_.Library.Integer pResultsId, _.Library.String pDefinitionClass, _.Library.String pModelName, _.Library.String pResultsClass, _.Library.Boolean pTracking)
_.Library.Status	RunModelFromResultSet (_.Library.Integer pResultsId, _.Library.String pDefinitionClass, _.Library.String pModelName, _.Library.ResultSet pResultSet, pFieldMap, _.Library.String pResultsClass, _.Library.Boolean pTracking)
_.Library.Status	RunModelFromSQL (_.Library.Integer pResultsId, _.Library.String pDefinitionClass, _.Library.String pModelName, _.Library.String pSQL, pFieldMap, pSQLParams, _.Library.String pResultsClass, _.Library.Boolean pTracking)

Detailed Description

This class bundles a number of utility methods for running PMML models and managing their results.

Member Function Documentation

DropAllResults()

_.Library.Status DropAllResults ( )

staticprivate

This class bundles a number of utility methods for running PMML models and managing their results.

Drops all results for all test IDs from the <class>DeepSee.PMML.Utils.TempResult</class>

table.

DropResults()

_.Library.Status DropResults ( _.Library.Integer  pTestId )

staticprivate

Drops all results for a given test ID from the <class>DeepSee.PMML.Utils.TempResult</class>

table.

RunModel()

_.Library.Status RunModel ( _.Library.Integer  pResultsId, _.Library.String  pDefinitionClass, _.Library.String  pModelName, _.Library.String  pDataSource, _.Library.String  pResultsClass, _.Library.Boolean  pTracking  )

staticprivate

Test a DeepSee or SQL-linked PMML model by running the model against all records in the

Data Source pDatasource specified in the model definition, defaulting to the first datasource definition found in the model.

Use pResultsClass to define the class (subclass of <class>DeepSee.PMML.Utils.Result</class>) the results of this batch run will be written to. This defaults to <class>DeepSee.PMML.Utils.TempResult</class>, which stores its data in the Temp database and therefore gets purged upon restarting the instance.
Results will be stored with their TestId property set to the value of pResultsId if a nonzero, non-null value is provided, or call the GetNewTestId() method of pResultsClass to generate a new one.
If pTracking is true, progress information will be written to ^IRIS.Temp.PMML.BgrTask($job), so this method can be run in the background.

RunModelFromPMMLRows()

_.Library.Status RunModelFromPMMLRows ( _.Library.Integer  pResultsId, _.Library.String  pDefinitionClass, _.Library.String  pModelName, _.Library.String  pResultsClass, _.Library.Boolean  pTracking  )

staticprivate

Runs a PMML model against the <ModelVerification> records included in the PMML model

definition.

Use pResultsClass to define the class (subclass of <class>DeepSee.PMML.Utils.Result</class>) the results of this batch run will be written to. This defaults to <class>DeepSee.PMML.Utils.TempResult</class>, which stores its data in the Temp database and therefore gets purged upon restarting the instance.
Results will be stored with their TestId property set to the value of pResultsId if a nonzero, non-null value is provided, or call the GetNewTestId() method of pResultsClass to generate a new one.
If pTracking is true, progress information will be written to ^IRIS.Temp.PMML.BgrTask($job), so this method can be run in the background.

RunModelFromResultSet()

_.Library.Status RunModelFromResultSet ( _.Library.Integer  pResultsId, _.Library.String  pDefinitionClass, _.Library.String  pModelName, _.Library.ResultSet  pResultSet,   pFieldMap, _.Library.String  pResultsClass, _.Library.Boolean  pTracking  )

staticprivate

Runs a PMML model against all records returned by a user-supplied ResultSet object, looping

through all rows and checking the model outcome against the actual value found in the query result. pFieldMap is expected to contain a mapping from this model's <class>DeepSee.PMML.Data</class> class to the columns (by name) in the supplied result set. If no field map is specified, the resultset is expected to contain columns with names corresponding to the models data fields.

Use pResultsClass to define the class (subclass of <class>DeepSee.PMML.Utils.Result</class>) the results of this batch run will be written to. This defaults to <class>DeepSee.PMML.Utils.TempResult</class>, which stores its data in the Temp database and therefore gets purged upon restarting the instance.
Results will be stored with their TestId property set to the value of pResultsId if a nonzero, non-null value is provided, or call the GetNewTestId() method of pResultsClass to generate a new one.
If pTracking is true, progress information will be written to ^IRIS.Temp.PMML.BgrTask($job), so this method can be run in the background.

RunModelFromSQL()

_.Library.Status RunModelFromSQL ( _.Library.Integer  pResultsId, _.Library.String  pDefinitionClass, _.Library.String  pModelName, _.Library.String  pSQL,   pFieldMap,   pSQLParams, _.Library.String  pResultsClass, _.Library.Boolean  pTracking  )

staticprivate

Runs a PMML model against all records returned by a user-supplied SQL query, looping through

the rows and checking the model outcome against the actual value found in the query result. pFieldMap is expected to contain a mapping from this model's <class>DeepSee.PMML.Data</class> class to the columns (by name) in the supplied result set. If no field map is specified, the resultset is expected to contain columns with names corresponding to the models data fields.

Use pResultsClass to define the class (subclass of <class>DeepSee.PMML.Utils.Result</class>) the results of this batch run will be written to. This defaults to <class>DeepSee.PMML.Utils.TempResult</class>, which stores its data in the Temp database and therefore gets purged upon restarting the instance.
Results will be stored with their TestId property set to the value of pResultsId if a nonzero, non-null value is provided, or call the GetNewTestId() method of pResultsClass to generate a new one.
If pTracking is true, progress information will be written to ^IRIS.Temp.PMML.BgrTask($job), so this method can be run in the background.

CreateFromFile()

_.Library.Status CreateFromFile ( _.Library.String  pFile, _.Library.String  pClassName, _.Library.Boolean  pOverwrite, _.Library.Boolean  pCompile, _.Library.Boolean  pVerbose  )

static

Creates a PMML definition class (<class>DeepSee.PMML.Definition</class>) based on the.

PMML definition XML in the supplied pFile

CreateFromStream()

_.Library.Status CreateFromStream ( _.Stream.Object  pStream, _.Library.String  pClassName, _.Library.Boolean  pOverwrite, _.Library.Boolean  pCompile, _.Library.Boolean  pVerbose  )

static

Creates a PMML definition class (<class>DeepSee.PMML.Definition</class>) based on the.

PMML definition XML in the supplied pStream

CreateFromString()

_.Library.Status CreateFromString ( _.Library.String  pString, _.Library.String  pClassName, _.Library.Boolean  pOverwrite, _.Library.Boolean  pCompile, _.Library.Boolean  pVerbose  )

static

Creates a PMML definition class (<class>DeepSee.PMML.Definition</class>) based on the.

PMML definition XML in the supplied pString