%ML.DataRobot.TrainedModel

persistent class %ML.DataRobot.TrainedModel extends %ML.TrainedModel

SQL Table Name: %ML_DataRobot.TrainedModel

Class for a trained DataRobot model instance

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property DataRobotKey as %String (MAXLEN = 512);
DataRobot-Key
Property methods: DataRobotKeyDisplayToLogical(), DataRobotKeyGet(), DataRobotKeyGetStored(), DataRobotKeyIsValid(), DataRobotKeyLogicalToDisplay(), DataRobotKeyLogicalToOdbc(), DataRobotKeyNormalize(), DataRobotKeySet()
property DeploymentId as %String (MAXLEN = 1024);
Deployment Id
Property methods: DeploymentIdDisplayToLogical(), DeploymentIdGet(), DeploymentIdGetStored(), DeploymentIdIsValid(), DeploymentIdLogicalToDisplay(), DeploymentIdLogicalToOdbc(), DeploymentIdNormalize(), DeploymentIdSet()
property PredictionURL as %String (MAXLEN = 2048);
Prediction Server
Property methods: PredictionURLDisplayToLogical(), PredictionURLGet(), PredictionURLGetStored(), PredictionURLIsValid(), PredictionURLLogicalToDisplay(), PredictionURLLogicalToOdbc(), PredictionURLNormalize(), PredictionURLSet()
property ProjectId as %String (MAXLEN = 512);
Project Id
Property methods: ProjectIdDisplayToLogical(), ProjectIdGet(), ProjectIdGetStored(), ProjectIdIsValid(), ProjectIdLogicalToDisplay(), ProjectIdLogicalToOdbc(), ProjectIdNormalize(), ProjectIdSet()
property TrainedModelId as %String (MAXLEN = 512);
Trained model Id
Property methods: TrainedModelIdDisplayToLogical(), TrainedModelIdGet(), TrainedModelIdGetStored(), TrainedModelIdIsValid(), TrainedModelIdLogicalToDisplay(), TrainedModelIdLogicalToOdbc(), TrainedModelIdNormalize(), TrainedModelIdSet()

Methods

method %Begin() as %Status [ Language = objectscript ]
Begin trained model operations
classmethod %CreateTrainedModel(provider As %ML.DataRobot.Provider, trainingrun As %ML.TrainingRun, projectid As %String, modelid As %String, ByRef trainedmodel As %ML.DataRobot.TrainedModel) as %Status [ Language = objectscript ]
Factory method to create a trained model
method %End() as %Status [ Language = objectscript ]
End trained model operations
method %Predict(data As %List, ByRef results As %List) as %Status [ Language = objectscript ]
Predict on an ML model
method %PredictAll(tfn As %Integer, argspos As %List, predpos As %List, probpos As %List = "", expr As %String = "") as %Status [ Language = objectscript ]
Bulk Predict arguments: 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(expr As %String = 1, data As %List, ByRef results As %List) as %Status [ Language = objectscript ]
Predict probability on an ML model Arguments: expr: The argument of PROBABILITY's FOR clause, defaults to 1 data: $List of WITH clause values results: PBR, return value
method %predictallshim(data As %List, predict As %Boolean, ByRef results As %List, expr As %String = "") as %Status [ Language = objectscript ]
Helper method to run a single row PREDICT() or PROBABILITY() in terms of %PredictAll()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%ML.TrainedModel)

^IRIS.ML.TrainedModelD(ID,"ModelInfo",n)
=
ModelInfo(n)

Storage Model: Storage (%ML.TrainedModel)

^IRIS.ML.TrainedModelD(ID)
=
%%CLASSNAME
Model
Provider
TrainingRun
TrainedAt
ModelName
ModelType

Storage Model: Storage (%ML.DataRobot.TrainedModel)

^IRIS.ML.TrainedModelD(ID,"TrainedModel")
=
ProjectId
TrainedModelId
DeploymentId
PredictionURL
DataRobotKey
WithColumnNames
Feedback