Class Reference
%ML.Provider
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%ML] >  [Provider]
Private  Storage

abstract class %ML.Provider extends %RegisteredObject

Base class for an ML provider

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 10


Summary

Methods
%AddToSaveSet %BeginTraining %ClassIsLatestVersion %ClassName
%ConstructClone %CreateProvider %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetDefaultSettings %GetName
%GetParameter %GetProvider %GetTrainStatement %IsA
%IsModified %New %NormalizeObject %ObjectModified
%OnClose %OnExit %OnInit %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject %WaitForTraining

Subclasses
%ML.AutoML.Provider %ML.DR.Provider %ML.H2O.Provider %ML.PMML.Provider

Parameters

• parameter DEFAULTPROVIDER = "AutoML";
Default provider name
• parameter PROVIDERNAME;
Provider name
• parameter SQLTYPE = "resultset";
Type of SQL TRAIN will operate on Options are "resutset" or "query" If the provider uses resultset, %Train is called with a resultset object for the query If the provider uses query, %TrainQyert is called with the SQL query text

Methods

• abstract method %BeginTraining(model As %ML.Model, data As %SQL.StatementResult, trainingrun As %ML.TrainingRun, ByRef name As %String = "", ByRef trainkey) as %Status
Train an ML model
• classmethod %CreateProvider(name As %String = "", ByRef provider As %ML.Provider) as %Status
Factory method to create an instance of an ML provider by name
• classmethod %GetDefaultSettings(ByRef settings As %DynamicObject)
Adds the default settings for the provider to the settings dynamic object
• method %GetName() as %String
Returns the provider name (the class name by default)
• classmethod %GetProvider(name As %String = "", ByRef class As %String) as %Boolean
Look up a provider proper name
• method %GetTrainStatement() as %SQL.Statement
Returns an instance of %SQL.Statement to be used for the training query
• method %OnClose() as %Status
Make sure we clean up
• method %OnExit() as %Status
Shutdown a provider
• method %OnInit() as %Status
Initialize a provider
• abstract method %WaitForTraining(ByRef trainkey, trainingrun As %ML.TrainingRun, ByRef trainedmodel As %ML.TrainedModel, timeoutMS As %Integer = -1) as %Status
Check for training complete


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.