Skip to main content

%iKnow.Classification.Builder

Class %iKnow.Classification.Builder Extends %RegisteredObject [ Abstract, Deprecated, System = 4 ]

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

This is the framework class for building Text Categorization models, generating valid %iKnow.Classification.Classifier subclasses.
Here's an example using the %iKnow.Classification.IKnowBuilder:

// first initialize training and test sets set tDomainId = $system.iKnow.GetDomainId("Standalone Aviation demo") set tTrainingSet = ##class(%iKnow.Filters.SimpleMetadataFilter).%New(tDomainId, "Year", "<", 2007) set tTestSet = ##class(%iKnow.Filters.GroupFilter).%New(tDomainId, "AND", 1) // NOT filter do tTestSet.AddSubFilter(tTrainingSet) // Initialize Builder instance with domain name and test set set tBuilder = ##class(%iKnow.Classification.IKnowBuilder).%New("Standalone Aviation demo", tTrainingSet) // Configure it to use a Naive Bayes classifier set tBuilder.ClassificationMethod = "naiveBayes" // Load category info from metadata field "AircraftCategory" write tBuilder.%LoadMetadataCategories("AircraftCategory") // manually add a few terms write tBuilder.%AddEntity("ultralight vehicle") set tData(1) = "helicopter", tData(2) = "helicopters" write tBuilder.%AddEntity(.tData) write tBuilder.%AddEntity("balloon",, "partialCount") write tBuilder.%AddCooccurrence($lb("landed", "helicopter pad")) // or add them in bulk by letting the Builder instance decide write tBuilder.%PopulateTerms(50) // after populating the term dictionary, let the Builder generate a classifier class write tBuilder.%CreateClassifierClass("User.MyClassifier")

Properties​

MinimumSpread​

Property MinimumSpread As %Integer [ InitialExpression = 3 ];

The minimum number of records in the training set that should contain a term before it can get selected by %PopulateTerms. (Can be bypassed for specific terms by adding them through %AddTerm)

MinimumSpreadPercent​

Property MinimumSpreadPercent As %Double [ InitialExpression = 0.05 ];

The minimum fraction of records in the training set that should contain a term before it can get selected by %PopulateTerms, EXCEPT if it occurs in more than 50% of the records in at least one category. (Can be bypassed for specific terms by adding them through %AddTerm)

Description​

Property Description As %String;

Optional description for the Classifier

DocumentVectorLocalWeights​

Property DocumentVectorLocalWeights As %String(VALUELIST = ",binary,linear,logarithmic") [ InitialExpression = "linear" ];

Local Term Weights for the document vector to register in the ClassificationMethod element. This might be overruled for some classification methods (ie Naive Bayes, which always uses "binary")

DocumentVectorNormalization​

Property DocumentVectorNormalization As %String(VALUELIST = ",none,cosine") [ InitialExpression = "none" ];

Document vector normalization method to register in the Classification element This might be overruled for some classification methods (ie Naive Bayes, which always uses "none")

Terms​

Property Terms As list Of %iKnow.Classification.Definition.Term [ Internal ];

Categories​

Property Categories As list Of %List [ Internal ];

Categories.GetAt(i) = $lb("name", "spec", "description", "recordCount")

TermSelectionMetric​

Property TermSelectionMetric As %String [ Internal ];

The metric used for selecting terms for this classifier. This is for information purposes only.

ClassificationMethod​

Property ClassificationMethod As %String(VALUELIST = ",naiveBayes,linearRegression,euclideanDistance,cosineSimilarity,pmml,rules") [ InitialExpression = "naiveBayes" ];

The general method used for classification:

  • "naiveBayes" uses a probability-based approach based on the Naive Bayes theorem,
  • "rules" runs through a set of straightforward decision rules based on boolean expressions, each contributing to a single category's score if they fire. The category with the highest score wins.
  • "euclideanDistance" treats the per-category term weights as a vector in the same vector space as the document term vector and calculates the euclidean distance between these vectors and the query vector.
  • "cosineSimilarity" also treats the per-category term weights as a vector in the same vector space as the document term vector and looks at the (cosine of) the angle between these vectors.
  • "linearRegression" considers the per-category term weights to be coefficients in a linear regression formula for calculating a category score, with the highest value winning
  • "pmml" delegates the mathematical work to a predictive model defined in PMML. See also %iKnow.Classification.Methods.pmml

EntityRole​

Property EntityRole As %Integer [ InitialExpression = {$$$ENTTYPECONCEPT}, Internal ];

Used by some models to refine the terms selected and/or how their default score is calculated

MethodBuilder​

Property MethodBuilder As %iKnow.Classification.Methods.Base [ Internal, ReadOnly ];

This object will deliver the actual implementation of the classification method and is instantiated automatically through settting ClassificationMethod.

Methods​

%AddCategory​

Method %AddCategory(pName As %String, pSpec As %String, pRecordCount As %Integer = "", pDescription As %String = "") As %Status [ Final ]

Adds an optional category named pName for the classifier being built by this class. The meaning of pSpec depends on the actual builder implementation, but should allow the builder implementation to identify the records in the training set belonging to this category.

%GetCategoryInfo​

Method %GetCategoryInfo(Output pCategories) As %Status [ Abstract ]

Returns all categories added so far: pCategories(n) = $lb([name], [record count])

%GetCategoryPosition​

Method %GetCategoryPosition(pName As %String) As %Integer [ Internal ]

%GetTerms​

Method %GetTerms(Output pTerms) As %Status

Returns all terms added so far: pTerms(n) = $lb([string value], [type], [negation policy], [count policy])

%AddTerm​

Method %AddTerm(pValue As %String, pType As %String = "entity", ByRef pCustomWeights, pNegation As %String = "undefined") As %Status [ Deprecated, Final, Internal ]

Deprecated: use %AddEntity, %AddCRC or %AddCooccurrence instead

Adds a term whose presence or frequency is to be considered for categorizing by the classifier being built by this class.

%AddEntity​

Method %AddEntity(ByRef pValue As %String, pNegation As %String = "undefined", pCount As %String = "exactCount", Output pIndex As %Integer) As %Status [ Final ]

Adds one or more entities as a single term to the Text Categorization model's term dictionary. The term is to be counted only if it appears in the negation context defined by pNegation. If pCount = "exactCount", only exact occurrences of this entity will be counted to calculate its base score to be fed into the categorization algorithm. If it is set to "partialCount", both exact and partial matches will be considered and if set to "partialScore", the score of all exact and partial matches will be summed as this term's base score.

Multiple entities can be supplied either as a one-dimensional array or as a %List

.

%AddCRC​

Method %AddCRC(ByRef pCRC As %List, pNegation As %String = "undefined", pCount As %String = "exactCount", Output pIndex As %Integer) As %Status [ Final ]

Adds one or more CRCs as a single term to the Text Categorization model's term dictionary. The term is to be counted only if it appears in the negation context defined by pNegation. If pCount = "exactCount", only exact occurrences of this CRC will be counted to calculate its base score to be fed into the categorization algorithm. If it is set to "partialCount", both exact and partial matches will be considered and if set to "partialScore", the score of all exact and partial matches will be summed as this term's base score.

Multiple CRC can be supplied either as a one-dimensional array of 3-element-%Lists

.

%AddCooccurrence​

Method %AddCooccurrence(ByRef pValue As %List, pNegation As %String = "undefined", pCount As %String = "exactCount", Output pIndex As %Integer) As %Status [ Final ]

Adds one or more Cooccurrences as a single term to the Text Categorization model's term dictionary. The term is to be counted only if it appears in the negation context defined by pNegation. If pCount = "exactCount", only exact occurrences of this cooccurrence's entities will be counted to calculate its base score to be fed into the categorization algorithm. If it is set to "partialCount", both exact and partial matches will be considered and if set to "partialScore", the score of all exact and partial matches will be summed as this term's base score.

A single cooccurrence can be supplied as a one-dimensional array of strings or a %List. Multiple cooccurrences can be supplied either as a one-dimensional array of %Lists or as a two-dimensional array of strings

.

%AddTermInternal​

Method %AddTermInternal(pTerm As %iKnow.Classification.Definition.Term, Output pIndex As %Integer) As %Status [ Internal ]

Directly add a term object at the last index. (no existence checking!)

%GetTermPosition​

Method %GetTermPosition(pTerm As %iKnow.Classification.Definition.Term) As %Integer [ Internal ]

%RemoveTermAtIndex​

Method %RemoveTermAtIndex(pIndex As %Integer) As %Status

Removes the term at index pIndex. If the term at this position is a composite one, all its entries are dropped along.

%RemoveTermEntryAtIndex​

Method %RemoveTermEntryAtIndex(pValue As %String, pIndex As %Integer, Output pRemovedTerm As %Boolean) As %Status

Removes a specific entry pValue from the term at index pIndex.

%RemoveTerm​

Method %RemoveTerm(pValue As %String, pType As %String = "entity", pNegation As %String = "undefined", pCount As %String = "exactCount") As %Status

Removes pValue from the first term that contains it meeting the pType pNegation and pCount criteria. If this is the last entry for that term, remove the whole term.

%PopulateTerms​

Method %PopulateTerms(pCount As %Integer = 100, pType As %String = "entity", pMetric As %String = "NaiveBayes", pPerCategory As %Boolean = 0) As %Status

Adds pCount terms of type pType to this classifier's set of terms, selecting those terms that have a high relevance for the categorization task based on metric pMetric and/or the specifics of this builder implementation.

If pPerCategory is 1, (pCount \ [number of categories]) terms are selected using the specified metric as calculated within each category. This often gives better results, but might not be supported for every metric or builder.

Builder implementations should ensure these terms meet the conditions set forward by MinimumSpread and MinimumSpreadPercent. MinimumSpreadPercent can be ignored if pPerCategory = 1

This method implements a populate method for pMetric = "NaiveBayes", selecting terms based on their highest average per-category probability. In this case, the value of pPerCategory is ignored (automatically treated as 1). Implementations for other metrics can be provided by subclasses.

%Reset​

Method %Reset() As %Status [ Final ]

Resets the term and category lists for this classifier

%OnReset​

Method %OnReset() As %Status [ Private ]

%GenerateClassifier​

Method %GenerateClassifier(Output pDefinition As %iKnow.Classification.Definition.Classifier, pIncludeBuilderInfo As %Boolean = 0, pVerbose As %Boolean = 1) As %Status [ Final ]

Generates a %iKnow.Classification.Definition.Classifier XML tree based on the current set of categories and terms, with the appropriate weights and parameters calculated by the builder implementation (see %OnGenerateClassifier).

Use pIncludeBuilderInfo to include specifications of how this classifier was built so it can be "reloaded" from the classifier XML to retrain the model.

%OnGenerateClassifier​

Method %OnGenerateClassifier(ByRef pDefinition As %iKnow.Classification.Definition.Classifier, pVerbose As %Boolean = 1, pIncludeBuilderInfo As %Boolean = 0) As %Status [ Private ]

Appends the ClassificationMethod element for this type of classifier.

%CreateClassifierClass​

Method %CreateClassifierClass(pClassName As %String, pVerbose As %Boolean = 1, pIncludeBuilderInfo As %Boolean = 1, pOverwrite As %Boolean = 0, pCompile As %Boolean = 1) As %Status

Generates a classifier definition and saves it to a %iKnow.Classification.Classifier subclass named pClassName. This will overwrite any existing class with that name if pOverwrite is 1. See also %GenerateClassifier.

%LoadFromDefinition​

ClassMethod %LoadFromDefinition(pClassName As %String, Output pBuilder As %iKnow.Classification.Builder, pValidateFirst As %Boolean = 1) As %Status [ Final ]

Loads the categories and terms from an existing Classifier class pClassName.
Note: this does not load any (custom) weight information from the definition.

%LoadFromModel​

ClassMethod %LoadFromModel(pDefinition As %iKnow.Classification.Definition.Classifier, Output pBuilder As %iKnow.Classification.Builder) As %Status [ Final, Internal ]

%OnLoadFromDefinition​

Method %OnLoadFromDefinition(pDefinition As %iKnow.Classification.Definition.Classifier) As %Status [ Internal ]

%ExportDataTable​

Method %ExportDataTable(pClassName As %String, pOverwrite As %Boolean = 1, pVerbose As %Boolean = 1, pTracking As %Boolean = 0) As %Status [ Final ]

Exports the data in the training set to a new table pClassName, with columns containing the weighted score for each term.

GetColumnName​

ClassMethod GetColumnName(pTermId As %Integer) As %String [ Internal ]

%OnCreateExportTable​

Method %OnCreateExportTable(pClassDef As %Dictionary.ClassDefinition, pVerbose As %Boolean) As %Status [ Private ]

Callback invoked by %ExportDataTable when creating the export table definition.

%OnExportTable​

Method %OnExportTable(pClassName As %String, pVerbose As %Boolean, pTracking As %Boolean) As %Status [ Abstract, Private ]

Callback invoked by %ExportDataTable to load the data into export table pClassName.

%AddTermsFromSQL​

Method %AddTermsFromSQL(pSQL As %String, pType As %String = "entity", pNegationContext As %String = "undefined", pCount As %String = "exactCount") As %Status

Adds all terms selected by pSQL as pType, taking the string value from the column named "term" with negation context pNegationContext and count policy pCount. If there are columns named "type", "negation" or "count" selected by the query, any values in these columns will be used instead of the defaults supplied through the respective parameters.

When adding CRC or Cooccurrence terms, use colons to separate the composing entities.

%GetRecordCount​

Method %GetRecordCount(Output pSC As %Status) As %Integer [ Abstract ]

%GetTermInfo​

Method %GetTermInfo(Output pTermInfo, pIncludeCategoryDetails As %String = "") As %Status [ Internal ]

Returns an array for the current builder terms: pTermInfo(i, "spread") = [spread in training set] pTermInfo(i, "spread", j) = [spread in training set for category j] pTermInfo(i, "frequency", j) = [freq in training set for category j]

ClassificationMethodSet​

Method ClassificationMethodSet(pMethod As %String) As %Status [ Internal, ServerOnly = 1 ]

%DispatchSetProperty​

Method %DispatchSetProperty(Property As %String, Val) [ ServerOnly = 1 ]

Dispatch unknown property setters to MethodBuilder

%DispatchGetProperty​

Method %DispatchGetProperty(Property As %String) [ ServerOnly = 1 ]

Dispatch unknown property getters to MethodBuilder

%DispatchMethod​

Method %DispatchMethod(Method As %String, Args...) [ ServerOnly = 1 ]

Dispatch unknown method calls to MethodBuilder

%GetCandidateTerms​

Method %GetCandidateTerms(pType As %String = "entity") As %Status [ Internal ]

INTERNAL - DO NOT INVOKE Used by MethodBuilder.%PopulateTerms() to provide: ^||%IK.TermCandidates(id) = $lb(value, spread) ^||%IK.TermCandidates(id, j) = [spread in category j]

%TestClassifier​

Method %TestClassifier(pTestSet As %RawString, Output pResult, Output pAccuracy As %Double, pCategorySpec As %String = "", pVerbose As %Boolean = 0) As %Status [ Abstract ]

Utility method to batch-test the classifier against a test set pTestSet. 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 an appropriate category specification, use pCategorySpec to refer to the actual category values to test against.