%ML.TrainingRun

persistent class %ML.TrainingRun extends %Library.Persistent

SQL Table Name: %ML.TrainingRun

A model training run

Property Inventory

Method Inventory

Properties

property CompletedAt as %TimeStamp;
Time completed (UTC)
Property methods: CompletedAtDisplayToLogical(), CompletedAtGet(), CompletedAtGetStored(), CompletedAtIsValid(), CompletedAtLogicalToDisplay(), CompletedAtNormalize(), CompletedAtOdbcToLogical(), CompletedAtSet()
property Configuration as %SYS.ML.Configuration;
ML Configuration for this training run
Property methods: ConfigurationGet(), ConfigurationGetObject(), ConfigurationGetObjectId(), ConfigurationGetStored(), ConfigurationGetSwizzled(), ConfigurationIsValid(), ConfigurationNewObject(), ConfigurationSet(), ConfigurationSetObject(), ConfigurationSetObjectId(), ConfigurationUnSwizzle()
property Log as %Stream.GlobalCharacter;
Training log output
Property methods: LogDelete(), LogGet(), LogGetObject(), LogGetObjectId(), LogGetStored(), LogGetSwizzled(), LogIsValid(), LogMsg(), LogNewObject(), LogOid(), LogOpen(), LogSet(), LogSetObject(), LogSetObjectId(), LogUnSwizzle()
property Model as %ML.Model [ Required ];
Model we are training with
Property methods: ModelGet(), ModelGetObject(), ModelGetObjectId(), ModelGetStored(), ModelGetSwizzled(), ModelIsValid(), ModelNewObject(), ModelSet(), ModelSetObject(), ModelSetObjectId(), ModelUnSwizzle()
property Name as %String (MAXLEN = 275) [ Required ];
Training Run name, same as the name for the cooresponding Trained Model
Property methods: NameCompute(), NameDisplayToLogical(), NameGet(), NameGetStored(), NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSQLCompute(), NameSet(), NameSetT()
property PID as %String [ InitialExpression = $job ];
IRIS Process ID that performed the training
Property methods: PIDDisplayToLogical(), PIDGet(), PIDGetStored(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property Provider as %String (MAXLEN = 128) [ Required ];
ML Provider that did the training
Property methods: ProviderDisplayToLogical(), ProviderGet(), ProviderGetStored(), ProviderIsValid(), ProviderLogicalToDisplay(), ProviderLogicalToOdbc(), ProviderNormalize(), ProviderSet()
property RunStatus as %String (DISPLAYLIST = ",Training,Completed,Failed", VALUELIST = ",training,completed,failed") [ InitialExpression = "training" ];
Training status
Property methods: RunStatusDisplayToLogical(), RunStatusGet(), RunStatusGetStored(), RunStatusIsValid(), RunStatusLogicalToDisplay(), RunStatusLogicalToOdbc(), RunStatusNormalize(), RunStatusSet()
property Settings as %Library.DynamicObject;
Settings for this training run
Property methods: SettingsGet(), SettingsGetObject(), SettingsGetObjectId(), SettingsGetStored(), SettingsGetSwizzled(), SettingsIsValid(), SettingsNewObject(), SettingsSet(), SettingsSetObject(), SettingsSetObjectId(), SettingsUnSwizzle()
property StartedAt as %TimeStamp [ InitialExpression = $ZDATETIME($ZTIMESTAMP,3,1,3) , Required ];
Time started (UTC)
Property methods: StartedAtDisplayToLogical(), StartedAtGet(), StartedAtGetStored(), StartedAtIsValid(), StartedAtLogicalToDisplay(), StartedAtNormalize(), StartedAtOdbcToLogical(), StartedAtSet()
property StatusCode as %Status [ InitialExpression = $$$OK ];
Training error (if encountered)
Property methods: StatusCodeGet(), StatusCodeGetStored(), StatusCodeIsValid(), StatusCodeLogicalToOdbc(), StatusCodeSet()
property TrainingDuration as %Numeric [ Transient ];
Training duration (in seconds)
Property methods: TrainingDurationCompute(), TrainingDurationDisplayToLogical(), TrainingDurationGet(), TrainingDurationIsValid(), TrainingDurationLogicalToDisplay(), TrainingDurationNormalize(), TrainingDurationSQLCompute(), TrainingDurationSet(), TrainingDurationSetT()
property TrainingQuery as %String (MAXLEN = 32000);
Training query
Property methods: TrainingQueryDisplayToLogical(), TrainingQueryGet(), TrainingQueryGetStored(), TrainingQueryIsValid(), TrainingQueryLogicalToDisplay(), TrainingQueryLogicalToOdbc(), TrainingQueryNormalize(), TrainingQuerySet()

Methods

method %Dump() as %Status [ Language = objectscript ]
Helper method for debugging etc.
classmethod GetInterval(start As %TimeStamp, end As %TimeStamp) as %Numeric [ Language = objectscript ]
Compute the difference in seconds between two timestamps
classmethod GetTrainingRunName(Model As %BigInt) as %String [ Language = objectscript ]
Compute the default name for this training run // Model is the Oid of a Model
method LogMsg(msg As %String) as %Status [ Language = objectscript ]
Log a timestamped message to the training log

Indexes

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (NameIndex on Name) [Unique];
Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (%ML.TrainingRun)

^IRIS.ML.TrainingRunD(ID,"Settings")
=
Settings

Storage Model: Storage (%ML.TrainingRun)

^IRIS.ML.TrainingRunD(ID)
=
%%CLASSNAME
Model
Provider
StartedAt
CompletedAt
TrainingDuration
RunStatus
StatusCode
Log
TrainingQuery
Name
Configuration
PID
Feedback