This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %iKnow.Classification.IFindBuilder


class %iKnow.Classification.IFindBuilder extends %iKnow.Classification.Builder

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property CategoryColumn as %String (MAXLEN = 2000) [ ReadOnly ];
Property methods: CategoryColumnDisplayToLogical(), CategoryColumnGet(), CategoryColumnIsValid(), CategoryColumnLogicalToDisplay(), CategoryColumnLogicalToOdbc(), CategoryColumnNormalize()
property ClassName as %String (MAXLEN = 200) [ ReadOnly ];
Property methods: ClassNameDisplayToLogical(), ClassNameGet(), ClassNameIsValid(), ClassNameLogicalToDisplay(), ClassNameLogicalToOdbc(), ClassNameNormalize()
property IdColumn as %String (MAXLEN = 200) [ ReadOnly ];
Property methods: IdColumnDisplayToLogical(), IdColumnGet(), IdColumnIsValid(), IdColumnLogicalToDisplay(), IdColumnLogicalToOdbc(), IdColumnNormalize()
property IndexName as %String (MAXLEN = 200) [ ReadOnly ];
Property methods: IndexNameDisplayToLogical(), IndexNameGet(), IndexNameIsValid(), IndexNameLogicalToDisplay(), IndexNameLogicalToOdbc(), IndexNameNormalize()
property ProjectionBase as %String (MAXLEN = 250) [ Private , ReadOnly ];
Property methods: ProjectionBaseDisplayToLogical(), ProjectionBaseGet(), ProjectionBaseIsValid(), ProjectionBaseLogicalToDisplay(), ProjectionBaseLogicalToOdbc(), ProjectionBaseNormalize()
property TableName as %String (MAXLEN = 200) [ ReadOnly ];
Property methods: TableNameDisplayToLogical(), TableNameGet(), TableNameIsValid(), TableNameLogicalToDisplay(), TableNameLogicalToOdbc(), TableNameNormalize()
property TextColumn as %String (MAXLEN = 200) [ ReadOnly ];
Property methods: TextColumnDisplayToLogical(), TextColumnGet(), TextColumnIsValid(), TextColumnLogicalToDisplay(), TextColumnLogicalToOdbc(), TextColumnNormalize()
property TrainingSet as %String (MAXLEN = 2000) [ ReadOnly ];
Property methods: TrainingSetDisplayToLogical(), TrainingSetGet(), TrainingSetIsValid(), TrainingSetLogicalToDisplay(), TrainingSetLogicalToOdbc(), TrainingSetNormalize()

Methods (Including Private)

method %GetCategoryInfo(Output pCategories) as %Status
Returns all categories added so far: pCategories(n) = $lb([name], [record count])
method %GetRecordCount(Output pSC As %Status) as %Integer
method %LoadCategoriesFromColumn(pExpression As %String) as %Status
Loads categories based on the value of the supplied SQL expression. pExpression should either be the (SQL) name of a column on TableName, or a valid SQL expression that can be selected from that table (aliased as if required "t").
private method %OnCreateExportTable(pClassDef As %Dictionary.ClassDefinition, pVerbose As %Boolean) as %Status
Inherited description: Callback invoked by %ExportDataTable() when creating the export table definition.
private method %OnExportTable(pClassName As %String, pVerbose As %Boolean, pTracking As %Boolean) as %Status
Callback invoked by %ExportDataTable() to load the data into export table pClassName.
method %TestClassifier(pTestSet As %CacheString = "", Output pResult, Output pAccuracy As %Double, pCategorySpec As %String = "", pVerbose As %Boolean = 0) as %Status

Utility method to batch-test the classifier against a test set pTestSet, which can be supplied as a valid SQL WHERE clause to be queried against TableName. Per-record results are returned through pResult:
pResult(n) = $lb([record ID], [actual category], [predicted category])

pAccuracy will contain the raw accuracy (# of records predicted correctly) of the current model. Use %iKnow.Classificaton.Utils for more advanced model testing.

If the current model's category options were added through %AddCategory() without providing an appropriate category specification (again through a SQL WHERE clause), rather than through a call to %LoadCategoriesFromColumn (which sets CategoryColumn), supply a column name or SQL expression through pCategorySpec where the actual category values to test against can be found.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)