%SYS.ML.Configuration
persistent class %SYS.ML.Configuration extends %Library.Persistent
SQL Table Name: %SYS_ML.Configuration
ML Configuration Definitions. This super class should be extended by different providers to allow for custom configurations. Any configuration settings common to all providers should be defined in this class.Property Inventory
Method Inventory
- %Create()
- %GetDefault()
- %GetProviderFromName()
- %GetSystemDefault()
- %GetUsingFromName()
- %Modify()
- %Remove()
- %SetDefault()
- %SetSystemDefault()
Parameters
parameter SQLPUBLICSECURITY = {"%GetDefault":"E"};
Properties
property Description as %String (MAXLEN = 256);
Description of this Configurtion
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Name as %String (MAXLEN = 256) [ Required ];
Configuration name
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Owner as %String (MAXLEN = 160);
Username/Rolename that is the owner of this ML Configuration
The owner will always implicitly have USE privilege for the configuration
Property methods: OwnerDisplayToLogical(), OwnerGet(), OwnerGetStored(), OwnerIsValid(), OwnerLogicalToDisplay(), OwnerLogicalToOdbc(), OwnerNormalize(), OwnerSet()
property Type as %EnumString (DISPLAYLIST = ",AutoML,H2O,DataRobot,PMML", VALUELIST = ",0,1,2,3") [ InitialExpression = 0 , Required ];
Provider
0 = AutoML, 1 = H2O, 2 = DataRobot, 3 = PMML
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeOdbcToLogical(), TypeSet()
property Using as %String (MAXLEN = 4096);
Default USING clause for the provider
Property methods: UsingDisplayToLogical(), UsingGet(), UsingGetStored(), UsingIsValid(), UsingLogicalToDisplay(), UsingLogicalToOdbc(), UsingNormalize(), UsingSet()
Methods
classmethod %Create(name As %String(MAXLEN=256), desc As %String(MAXLEN=256)="", using As %String(MAXLEN=4096)="", owner As %String(MAXLEN=160)="") as %Status
Create default ML configuration
name - Name of the configuration, required, must be unique. String with MAXLEN=256
desc - Optional description for the configuration
using - default USING clause for the configuration. This is a JSON string of key:value pairs (See CREATE MODEL for examples)
final classmethod %GetDefault() as %String [ SQLProc = %GetDefault ]
Projected as the stored procedure: %GetDefault
Returns the current process's default ML Configuration
Returns "" if an error or the ML Configuration no longer exists and there is no system default
Given the name of a ML Configuration, return the name of the provider
final classmethod %GetSystemDefault() as %String
Returns the system-wide default ML Configuration
if no system wide default is defined (which really should not happen), "" is returned
final classmethod %GetUsingFromName(name As %String(MAXLEN=256)) as %Library.DynamicObject
Given the name of a ML Configuration, return the using property value
"" returned upon error
classmethod %Modify(name As %String(MAXLEN=256), desc As %String(MAXLEN=256), using As %String(MAXLEN=4096), owner As %String(MAXLEN=160)) as %Status
Modify an ML configuration
name - Name of the configuration to modify
desc - Description for the configuration
using - default USING clause for the configuration. This is a JSON string of key:value pairs (See CREATE MODEL for examples)
owner - Username/Rolename that owns this ML Configuration
To change Description, Using, or Owner, supply a new value (including "" to set the new value to null).
To leave the value alone, don't pass any value for the parameter
Name and Type cannot be modified
Remove configuration
Sets the current process's default ML Configuration
Sets the system-wide default ML Configuration
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (NameIndex on Name) [PrimaryKey, Unique];
Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()
Triggers
trigger %NoSQLFiling (BEFORE event INSERT/UPDATE/DELETE);
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: Storage (%SYS.ML.Configuration)
^%SYS("ml","configuration","d")(ID) |
= | %%CLASSNAME
Name
Type
Using
Description
Owner
|