Class %ML.AutoML.TrainedModel

persistent class %ML.AutoML.TrainedModel extends %ML.TrainedModel

Class for a trained AutoML model instance

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	7	7

Summary

Properties
Model	ModelInfo	ModelName	ModelState	ModelType
Provider	TrainedAt	TrainingRun

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%Begin	%BuildIndicesAsync	%BuildIndicesAsyncResponse
%CheckConstraints	%CheckConstraintsForExtent	%ClassIsLatestVersion	%ClassName
%ComposeOid	%ConstructClone	%CreateTrainedModel	%Delete
%DeleteExtent	%DeleteId	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%End	%Exists	%ExistsId
%Extends	%GUID	%GUIDSet	%GetLock
%GetParameter	%GetSwizzleObject	%Id	%InsertBatch
%IsA	%IsModified	%IsNull	%KillExtent
%KillExtentData	%LoadFromMemory	%LoadModel	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectIsNull
%ObjectModified	%Oid	%OnBeforeAddToSync	%OnDeleteFinally
%OnDetermineClass	%OnOpenFinally	%OnSaveFinally	%Open
%OpenId	%OriginalNamespace	%PackageName	%PhysicalAddress
%Predict	%PredictAll	%Probability	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SaveIndices	%SerializeObject
%SetModified	%SortBegin	%SortEnd	%SyncObjectIn
%SyncTransport	%UnlockExtent	%UnlockId	%ValidateIndices
%ValidateObject	%ValidateTable

Properties

• property ModelState as %Stream.GlobalCharacter;

Serialized model state

Methods

• method %Begin() as %Status

Begin trained model operations

• classmethod %CreateTrainedModel(provider As %ML.AutoML.Provider, trainingrun As %ML.TrainingRun, ByRef trainedmodel As %ML.AutoML.TrainedModel) as %Status

Factory method to create a trained model

• method %End() as %Status

End trained model operations

• method %LoadModel() as %Status

Load a serialized model

• method %Predict(data As %List, ByRef results As %List) as %Status

Predict on an ML model

• method %PredictAll(tfn As %Integer, argspos As %List, predpos As %List, probpos As %List = "", expr As %String = "", mtorder As %List, mtunary As %List) as %Status

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

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search