IRISLIB database
Model Class Reference

Definition of a ML model. More...

Inheritance diagram for Model:
Collaboration diagram for Model:

Public Attributes

 CreatedAt
 Timestamp for when the model was created (UTC) More...
 
 DateTimeColumn
 What is the datetime column for a timeseries model? More...
 
 DefaultIDColumnFound
 Have we found an ID column that would otherwise be trained on by default if we did not exclude it. More...
 
 DefaultParameters
 Model parameters. More...
 
 DefaultTrainedModel
 Default trained model. More...
 
 DefaultTrainingQuery
 Default training query (SQL) More...
 
 Description
 Model description. More...
 
 Forward
 How far forward are we predicting? Important for validation. More...
 
 ForwardResponse
 What is the calculated forward window? (DataRobot Exclusive) More...
 
 Name
 Name of the model. More...
 
 PredictingColumnNames
 Column Name(s) we're predicting. More...
 
 PredictingColumnTypes
 Column Types(s) we're predicting. More...
 
 TimeSeries
 Is this a timeseries model? More...
 
 TimeStep
 What time step size was returned (DataRobot Exclusive) More...
 
 WithColumnNames
 Columns names we're predicting using. More...
 
 WithColumnText
 Columns text we're predicting using, text from SQL query or with expression. More...
 
 WithColumnTypes
 Columns types we're predicting using. More...
 

Private Member Functions

_.Library.Status Predict (_.Library.List rowdata, _.Library.Double result, _.Library.RawString contextitem)
 Predict.
 
_.Library.Status Probability (_.Library.List rowdata, _.Library.Double result, _.ML.TrainedModel trainedmodel, _.Library.String expr)
 Probability.
 
_.Library.Status Purge (days)
 Purge all trained models.
 
_.Library.Status Train (_.SQL.StatementResult data, _.Library.String trainedmodelname, _.ML.TrainedModel trainedmodel, _.ML.TrainingRun trainingrun, _.Library.DynamicObject using, _.Library.Boolean notdefault)
 Train an ML model (synchronously)
 

Static Private Member Functions

_.Library.Status PredictAll (_.Library.String modelname, _.Library.String trainedmodelname, _.Library.Integer tfn, _.Library.List argspos, _.Library.List predpos, _.Library.List probpos, _.Library.String expr, _.Library.List mtorder, _.Library.List mtunary)
 Bulk Predict. More...
 

Additional Inherited Members

- Public Member Functions inherited from Persistent
_.Library.Status AcquireLock (_.Library.String locktype)
 Acquires a lock for the current instance. More...
 
_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status OnAfterSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnReload ()
 This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
 
_.Library.Status OnRollBack ()
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status ReleaseLock (_.Library.String locktype)
 Releases a lock for the current instance. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 
- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Member Functions inherited from Persistent
_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 This method is normally generated by the storage class for persistent classes using. More...
 
_.Library.Status KillExtentData (_.Library.Boolean killstreams)
 KillExtentData() - kills extent data in storage. More...
 
_.Library.Status OnAfterBuildIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnAfterDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
_.Library.Status OnAfterPurgeIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnBeforeBuildIndices (_.Library.String indexlist)
 
_.Library.Status OnBeforePurgeIndices (_.Library.String indexlist)
 
_.Library.Status OnDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
- Static Public Attributes inherited from Persistent
 XCOMPACTANCESTRY
 XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
 
 DATALOCATIONGLOBAL = None
 Global name containing master map data for this class. More...
 
 DEFAULTGLOBAL = None
 
 DSCONDITION = None
 DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
 
 DSINTERVAL = None
 DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
 
 DSTIME = None
 If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
 
 EXTENTQUERYSPEC = None
 The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
 
 EXTENTSIZE = None
 The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
 
 GUIDENABLED = None
 If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
 
 IDENTIFIEDBY = None
 The IDENTIFIEDBY parameter can optionally be set to the name. More...
 
 MANAGEDEXTENT = None
 The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
 
 READONLY = None
 READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
 
 ROWLEVELSECURITY = None
 ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
 
 SQLPREVENTFULLSCAN = None
 SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
 
 STORAGEDEFAULT = None
 STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
 
 USEEXTENTSET = None
 
 VERSIONCLIENTNAME = None
 VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
 
 VERSIONPROPERTY = None
 VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

Definition of a ML model.

Member Function Documentation

◆ PredictAll()

_.Library.Status PredictAll ( _.Library.String  modelname,
_.Library.String  trainedmodelname,
_.Library.Integer  tfn,
_.Library.List  argspos,
_.Library.List  predpos,
_.Library.List  probpos,
_.Library.String  expr,
_.Library.List  mtorder,
_.Library.List  mtunary 
)
staticprivate

Bulk Predict.

arguments: modelname - model name trainedmodelname - name of ML.TrainedModel, might be different from the DefaultTrainedModel tfn - tempfile index argspos - Positions of the WithColumns in the temp rows, $list(column-positions) predpos - Position of the predicted value, $list(result-column-positions) probpos - Position of the probability value, $list(result-column-positions) expr - expression for probability returns: $$$OK on success, otherwise a $$$ERROR(...)

Member Data Documentation

◆ CreatedAt

CreatedAt

Timestamp for when the model was created (UTC)

 

◆ DateTimeColumn

DateTimeColumn

What is the datetime column for a timeseries model?

 

◆ DefaultIDColumnFound

DefaultIDColumnFound

Have we found an ID column that would otherwise be trained on by default if we did not exclude it.

 

◆ DefaultParameters

DefaultParameters

Model parameters.

 

◆ DefaultTrainedModel

DefaultTrainedModel

Default trained model.

 

◆ DefaultTrainingQuery

DefaultTrainingQuery

Default training query (SQL)

 

◆ Description

Description

Model description.

 

◆ Forward

Forward

How far forward are we predicting? Important for validation.

 

◆ ForwardResponse

ForwardResponse

What is the calculated forward window? (DataRobot Exclusive)

 

◆ Name

Name

Name of the model.

 

◆ PredictingColumnNames

PredictingColumnNames

Column Name(s) we're predicting.

 

◆ PredictingColumnTypes

PredictingColumnTypes

Column Types(s) we're predicting.

 

◆ TimeSeries

TimeSeries

Is this a timeseries model?

 

◆ TimeStep

TimeStep

What time step size was returned (DataRobot Exclusive)

 

◆ WithColumnNames

WithColumnNames

Columns names we're predicting using.

 

◆ WithColumnText

WithColumnText

Columns text we're predicting using, text from SQL query or with expression.

 

◆ WithColumnTypes

WithColumnTypes

Columns types we're predicting using.