persistent class %ML.Model
extends %Persistent
Definition of a ML model
• property CreatedAt
as %TimeStamp [ InitialExpression = $ZDATETIME($ZTIMESTAMP,3,1,3),Required ];
Timestamp for when the model was created (UTC)
• property DateTimeColumn
as %String(MAXLEN=128);
What is the datetime column for a timeseries model?
• property DefaultIDColumnFound
as %Boolean [ InitialExpression = 0,Required ];
Have we found an ID column that would otherwise be trained on by default if we did not exclude it
• property DefaultParameters
as array of %String(MAXLEN=1024);
Model parameters
• property DefaultTrainedModel
as %ML.TrainedModel;
Default trained model
• property DefaultTrainingQuery
as %String(MAXLEN=32000);
Default training query (SQL)
• property Description
as %String(MAXLEN=8192);
Model description
• property Forward
as %Integer;
How far forward are we predicting? Important for validation.
• property ForwardResponse
as %String(MAXLEN=128);
What is the calculated forward window? (DataRobot Exclusive)
• property Name
as %String(MAXLEN=256) [ Required ];
Name of the model
• property PredictingColumnNames
as list of %String(MAXLEN=128) [ Required ];
Column Name(s) we're predicting
• property PredictingColumnTypes
as list of %String(MAXLEN=128) [ Required ];
Column Types(s) we're predicting
• property TimeSeries
as %Boolean [ InitialExpression = 0,Required ];
Is this a timeseries model?
• property TimeStep
as %String(MAXLEN=128);
What time step size was returned (DataRobot Exclusive)
• property WithColumnNames
as list of %String(MAXLEN=128) [ Required ];
Columns names we're predicting using
• property WithColumnText
as list of %String(MAXLEN=512) [ Required ];
Columns text we're predicting using, text from SQL query or with expression
• property WithColumnTypes
as list of %String(MAXLEN=128) [ Required ];
Columns types we're predicting using
• method %Predict(rowdata As %List, ByRef result As %Double, contextitem As %RawString)
as %Status
Predict
• classmethod %PredictAll(modelname As %String, trainedmodelname As %String = "", tfn As %Integer, argspos As %List, predpos As %List = "", probpos As %List = "", expr As %String = 1, mtorder As %List, mtunary As %List)
as %Status
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(...)
• method %Probability(rowdata As %List, ByRef result As %Double, ByRef trainedmodel As %ML.TrainedModel = "", expr As %String = 1)
as %Status
Probability
• method %Purge(days=0)
as %Status
Purge all trained models
• method %Train(data As %SQL.StatementResult, ByRef trainedmodelname As %String, ByRef trainedmodel As %ML.TrainedModel, ByRef trainingrun As %ML.TrainingRun, using As %DynamicObject = $$$NULLOREF, notdefault As %Boolean = 0)
as %Status
Train an ML model (synchronously)
•index (NameIndex on Name) [Data = Name,PrimaryKey,Type = index,Unique];
Index on the model name
•trigger DeleteTrigger
(BEFORE event DELETE)When deleting a model, also delete any %ML.ValidationRun, %ML.ValidationMetric,
%ML.TrainingRun and %ML.TrainedModel objects for this Model
