A B C D E F G H I L M N O P Q R S T U V W
All Classes All Packages

## A

AbstractQlt<T extends com.tibco.patterns.learn.jaxb.model.SearchQueryBaseType> - Class in com.tibco.patterns.learn.api.feature
  Stores a single querylet in an XML structure.
add(VectorExample) - Method in class com.tibco.patterns.learn.training.VectorExperiment
  Randomly adds the example to one of the datasets, preserving dataset proportions.
add(T) - Method in class com.tibco.patterns.learn.training.RLinkDataSet
  Adds the given example to this dataset.
addFeature(Feature<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Adds the newFeature (of any type) to the feature query.
addFeature(String, AbstractQlt<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Creates a new generic feature and adds it to the feature query.
AddPairsResult - Class in com.tibco.patterns.learn.api.project
  Contains sets of pairs that were added to each dataset, and collections of pairs that were not added to the project for various reasons.
AddPairsResult() - Constructor for class com.tibco.patterns.learn.api.project.AddPairsResult
  Creates object with empty collections of pairs.
addPrediction(RLinkOut, boolean) - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Updates all stored statistics based on the additional model prediction.
addRecPair(RecPair) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Adds a new record pair randomly to the training or validation dataset of the active model.
addRecPair(RecPair, DataPartition) - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
  Remembers the pair that was added to the given partition.
addRecPair(RecPair, DataPartition) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Adds a new record pair to the specified dataset of the active model.
addRecPairsFromCsv(File) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Adds all record pairs from the specified CSV file to the active model settings.
addThesFile(String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Adds the thesaurus file to the "thesauri subdirectory of the active model's directory, overwriting any previous file with same name.
addToOverflow(RecPair) - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
  Remembers the pair that did not fit within the max size of the Reserve dataset.
addToReserveOrOverflow(List<RecPair>, ModelSettings, int, String, Date) - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
  Adds given pairs to the Reserve dataset, or to the overflow list if the size of the Reserve dataset exceeds the maximum.
addToUsedDataset(RecPair, ModelSettings, DataPartition, String, Date) - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
  Adds or moves the record pair to a dataset used for training in msDest.
addUsefulRecPairs(DatasetStats, ModelSettings, DataPartition, int, int, String, Date, AddPairsResult) - Method in class com.tibco.patterns.learn.api.hint.SubsetLabelPairMap
  Add pairs for each subset in this object, using statistics for each label in the same subset in Training dataset.
addUsefulRecPairs(List<RecPair>, int, int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Adds each record pair if it is likely to improve model training while limiting the grwth of datasets.
ALL - com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Train all subsets with generated examples
annealRate(double) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the annealing rate which defines the speed of learning rate decrease with each training iteration.
ARRAY - com.tibco.patterns.learn.rlink.RLink.ThermometerType
  Array-based thermometer (default).
asChar() - Method in enum com.tibco.patterns.learn.api.project.RecPair.Label
asChar(RecPair.Label) - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
asJavaCode(String, String, String) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
asJavaCode(String, String, String) - Method in class com.tibco.patterns.learn.api.feature.DateQlt
asJavaCode(String, String, String) - Method in class com.tibco.patterns.learn.api.feature.PredicateQlt
  Builds the predicate query Java source using the predicate expression string.
asJavaCode(String, String, String) - Method in interface com.tibco.patterns.learn.api.feature.Querylet
  Converts the querylet to a Java code string.
asJavaCode(String, String, String) - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
asXmlLabel() - Method in enum com.tibco.patterns.learn.api.project.RecPair.Label

## B

beforeFeatureChange() - Method in interface com.tibco.patterns.learn.api.feature.FeatureListener
  This method is called when any change that may impact feature scores occurs in the feature query.
beforeFeatureChange() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Called by FeatureQuery before a feature is added, deleted, replaced.
beginIteration() - Method in class com.tibco.patterns.learn.training.COErrorRate
  Remembers result of previous iteration, prepares to accumulate results for the current iteration.
beginIteration() - Method in class com.tibco.patterns.learn.training.COIterationCount
  Counts an additional iteration, switches object state.
beginIteration() - Method in class com.tibco.patterns.learn.training.COScoreChange
  Prepares to accumulate statistics for a new training iteration.
beginIteration() - Method in interface com.tibco.patterns.learn.training.TrainingObserver
  Resets internal state to prepare for a new iteration of evaluating the entire dataset.
beginIteration(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Must be called before each training iteration with the entire training dataset.
beginTraining(ConvergenceObserver, ConvergenceObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Creates model using the model configuration from modelTrainConfig.xml file, or the default configuration if that file is not in the project directory.
beginTraining(ConvergenceObserver, ConvergenceObserver, ModelConfig) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Creates model and prepares training structures to start step-by-step training.
bestRes - Variable in class com.tibco.patterns.learn.training.COErrorRateMin
bools() - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
build() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Creates an RLink model using the parameters stored in this object.
build(int) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Creates an RLink model using the parameters stored in this object and the given number of features.

## C

calcAllFeatureScores() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Creates a new record pair scorer and recalculates feature scores for pairs in datasets used for model creation and training in ModelSettings.
calcAndScore(RecPairScorer) - Method in class com.tibco.patterns.learn.api.project.RecPair
  Calculates the symmetric match score of using all feature querylets (that compute symmetric querylet scores) combined with an AND score combiner.
calcAndScore(List<String>, List<String>) - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Calculates symmetric match score for the given pair of records using all feature querylets (that compute symmetric querylet scores) combined with an AND score combiner.
calcDatasetResult(DataPartition, double) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Calculates statistics for custom threshold from model predictions stored in one dataset.
calcDatasetSubsets(FeatureQuery, RecPairMap, DataPartition, boolean) - Static method in class com.tibco.patterns.learn.api.hint.DatasetStats
  Finds all subsets present in the specified dataset.
calcFeatureScores(RecPair) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Calculates symmetric feature scores and saves them in the given pair.
calcFeatureScores(RecPairScorer) - Method in class com.tibco.patterns.learn.api.project.RecPair
  Calculates and saves symmetric feature scores in this object.
calcFeatureScores(List<RecPair>) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Calculates symmetric feature scores for each pair and saves them in the given RecPair objects.
calcMissingFeatureScores() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Calculates any missing feature scores in datasets used for model creation and training, stores them in ModelSettings.
calcQltScore(String, int, RecPairScorer) - Method in class com.tibco.patterns.learn.api.project.RecPair
  Calculates score of a single querylet of the given feature.
calcQltScore(String, int, List<String>, List<String>) - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Calculates score of a single querylet of the given feature.
calcTableSubsets(FeatureQuery, ModelTrainer) - Static method in class com.tibco.patterns.learn.api.hint.HintAddUntrainedInTable
  Determines the Rlink subset of each table record (for the given feature query) and adds subset to family.
clear() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Deletes all features and the list of used thesauri.
clearPredictions() - Method in class com.tibco.patterns.learn.training.RLinkDataSet
  Clears stored predictions from all examples.
clearPredictions() - Method in class com.tibco.patterns.learn.training.RLinkExperiment
  Clears stored predictions from all examples in both datasets.
clearRecPairs() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Deletes all record pairs from all datasets.
clearRecPairs(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Deletes all record pairs from the specified dataset.
clone() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Performs shallow copy of all simple types.
close() - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Deletes thesauri and model (if it exists) from server.
close(boolean) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Closes scorer if it was created - deletes thesauri and model (if loaded) from server.
COErrorRate - Class in com.tibco.patterns.learn.training
  Stops the training when the error rate over validation dataset during the last iteration is below the given threshold.
COErrorRate() - Constructor for class com.tibco.patterns.learn.training.COErrorRate
  Creates object with default target error rate and max iterations.
COErrorRate(double, int) - Constructor for class com.tibco.patterns.learn.training.COErrorRate
  Creates object with specified parameters.
COErrorRate.IterationResult - Class in com.tibco.patterns.learn.training
  Stores statistics for a full or partial training iteration
COErrorRateMin - Class in com.tibco.patterns.learn.training
  Stops the training after a minimum error rate for the validation dataset was found and this result was not improved during the specified number of subsequent iterations.
COErrorRateMin(COErrorRate) - Constructor for class com.tibco.patterns.learn.training.COErrorRateMin
  Creates object with default parameters.
COErrorRateMin(COErrorRate, int) - Constructor for class com.tibco.patterns.learn.training.COErrorRateMin
  Creates object with specified parameters.
CognateQlt - Class in com.tibco.patterns.learn.api.feature
  A Cognate querylet for matching several related text fields where values may be entered into a wrong field.
CognateQlt(int[], double[], double, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.CognateQlt
  Creates cognate querylet with given parameters.
CognateQlt(int[], double, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.CognateQlt
  Default field weights 1.0 are used.
COIterationCount - Class in com.tibco.patterns.learn.training
  A simple class that counts iterations and stops training after the given maximum number of iterations has been reached.
COIterationCount() - Constructor for class com.tibco.patterns.learn.training.COIterationCount
  Uses the default maximum number of iterations.
COIterationCount(int) - Constructor for class com.tibco.patterns.learn.training.COIterationCount
  Creates object with the given max iterations.
com.tibco.patterns.learn.api.autopair - package com.tibco.patterns.learn.api.autopair
  Contains functionality for finding and generating new record pairs automatically.
com.tibco.patterns.learn.api.feature - package com.tibco.patterns.learn.api.feature
  Manages feature query, features and querylets that are stored in Patterns Learn model.xml file.
com.tibco.patterns.learn.api.hint - package com.tibco.patterns.learn.api.hint
  Generation of all types of model training suggestions, filtering of data table for a specific subset in a suggestion, analysis of datasets by subset and label.
com.tibco.patterns.learn.api.project - package com.tibco.patterns.learn.api.project
  The main package to support Patterns Learn projects and automated model training.
com.tibco.patterns.learn.modelconfig - package com.tibco.patterns.learn.modelconfig
  Configuration and options for creating and using Learn models.
com.tibco.patterns.learn.recpair - package com.tibco.patterns.learn.recpair
  Management of datasets of record pairs, calculation of feature scores for record pairs.
com.tibco.patterns.learn.rlink - package com.tibco.patterns.learn.rlink
  Creation, loading and saving of RLink models; model training and evaluation using individual feature vectors.
com.tibco.patterns.learn.training - package com.tibco.patterns.learn.training
  Functionality to train, validate, monitor statistics and stop the training of RLink models using datasets of feature vectors.
COMBINED - com.tibco.patterns.learn.api.feature.Thesaurus.Type
  Combined thesaurus.
compare(RecPair, RecPair) - Method in class com.tibco.patterns.learn.api.project.RecPair.ConfScoreComparator
compareTo(RecPairId) - Method in class com.tibco.patterns.learn.recpair.RecPairId
  Compares the two keys.
ConfDefault - Class in com.tibco.patterns.learn.rlink
  Settings for the default model confidence measure.
ConfDefault() - Constructor for class com.tibco.patterns.learn.rlink.ConfDefault
ConfFeature - Class in com.tibco.patterns.learn.rlink
  Feature based confidence measure.
ConfFeature() - Constructor for class com.tibco.patterns.learn.rlink.ConfFeature
  Create an instance with default values.
ConfFeature(int, double) - Constructor for class com.tibco.patterns.learn.rlink.ConfFeature
  Create an instance with specific parameter values.
Confidence - Interface in com.tibco.patterns.learn.rlink
  Defines a confidence measure and its options.
CONFIDENCE_ORDER - Static variable in class com.tibco.patterns.learn.api.project.RecPair
  Provides ascending order by prediction confidence.
ConfNone - Class in com.tibco.patterns.learn.rlink
  Turns off calculation of a confidence measure.
ConfNone() - Constructor for class com.tibco.patterns.learn.rlink.ConfNone
ConfQFeature - Class in com.tibco.patterns.learn.modelconfig
  Extends the ConfFeature class to provide means to configure a NetricsQuery.
ConfQFeature() - Constructor for class com.tibco.patterns.learn.modelconfig.ConfQFeature
  Create an instance with default values.
ConfQFeature(int, double) - Constructor for class com.tibco.patterns.learn.modelconfig.ConfQFeature
  Create an instance with specific parameter values.
ConfQNone - Class in com.tibco.patterns.learn.modelconfig
  Extends the ConfNone class to provide means to configure a NetricsQuery.
ConfQNone() - Constructor for class com.tibco.patterns.learn.modelconfig.ConfQNone
ConfQuery - Interface in com.tibco.patterns.learn.modelconfig
  Defines a confidence measure that can be used in a Patterns server RLink query.
ConfRatio - Class in com.tibco.patterns.learn.rlink
  Weighted true/false ratio confidence measure.
ConfRatio() - Constructor for class com.tibco.patterns.learn.rlink.ConfRatio
  Create an instance with default values.
ConfRatio(int) - Constructor for class com.tibco.patterns.learn.rlink.ConfRatio
  Create an instance with specific parameter values.
ConfRatioLabel - Class in com.tibco.patterns.learn.rlink
  Label based confidence measure.
ConfRatioLabel() - Constructor for class com.tibco.patterns.learn.rlink.ConfRatioLabel
  Create an instance with default values.
ConfRatioLabel(int, double, double) - Constructor for class com.tibco.patterns.learn.rlink.ConfRatioLabel
  Create an instance with specific parameter values.
ConfScoreComparator(double, double) - Constructor for class com.tibco.patterns.learn.api.project.RecPair.ConfScoreComparator
  Creates a ConfScoreComparator with given parameters.
ConfStats - Class in com.tibco.patterns.learn.rlink
  Confidence measure based on submodel statistics.
ConfStats() - Constructor for class com.tibco.patterns.learn.rlink.ConfStats
  Create an instance with default values.
ConfStats(int, double) - Constructor for class com.tibco.patterns.learn.rlink.ConfStats
  Create an instance with specific parameter values.
contains(RecPairId) - Method in class com.tibco.patterns.learn.api.project.RecPairMap
  Checks if the given ID is already in any dataset.
ConvergenceObserver - Interface in com.tibco.patterns.learn.training
  Defines an object that makes decisions when to stop the training.
copy() - Method in class com.tibco.patterns.learn.modelconfig.STAll
copy() - Method in class com.tibco.patterns.learn.modelconfig.STDynamic
copy() - Method in class com.tibco.patterns.learn.modelconfig.STFixed
copy() - Method in class com.tibco.patterns.learn.modelconfig.STNone
copy() - Method in class com.tibco.patterns.learn.modelconfig.STTaper
copy() - Method in class com.tibco.patterns.learn.modelconfig.SubsetTrainConfig
  Copies this object to a new object.
copyModelResultsToXml(List<RecPairType>, List<RecPairType>, ObjectFactory) - Method in class com.tibco.patterns.learn.recpair.RecPairExperiment
  Copies RLink predictions for all examples to XML datasets.
correctPrediction() - Method in class com.tibco.patterns.learn.api.project.RecPair
correctPrediction() - Method in class com.tibco.patterns.learn.training.VectorExample
  Checks if the RLink prediction is correct.
correctPrediction(boolean) - Method in class com.tibco.patterns.learn.rlink.RLinkOut
correctPrediction(boolean, double) - Method in class com.tibco.patterns.learn.rlink.RLinkOut
  Do not use custom thresholds for model training!
COScoreChange - Class in com.tibco.patterns.learn.training
  Stops the training when the maximum change in prediction scores compared with the previous iteration is below the given threshold.
COScoreChange() - Constructor for class com.tibco.patterns.learn.training.COScoreChange
  Creates object with default parameters.
COScoreChange(double, int, int) - Constructor for class com.tibco.patterns.learn.training.COScoreChange
  Creates the object with given parameters.
create(FeatureQuery, DatasetStats, RecPair.Label, double) - Static method in class com.tibco.patterns.learn.api.hint.HintAddLabel
  Creates a hint object with all subsets where the proportion of pairs with the given label is lower than minProportion.
create(FeatureQuery, SubsetFamily, double, int) - Static method in class com.tibco.patterns.learn.api.hint.HintAddUnderrepr
  Creates a hint object with all underrepresented subsets, selecting them from subsets in training dataset.
create(RecPairMap) - Static method in class com.tibco.patterns.learn.api.hint.HintReviewContra
  Creates a hint that holds pairs that have contradicting pairs.
create(RecPairMap, double) - Static method in class com.tibco.patterns.learn.api.hint.HintReviewMislabeled
  Creates a hint that holds possibly mislabeled pairs.
create(RLink.SubsetTrainMode) - Static method in class com.tibco.patterns.learn.modelconfig.SubsetTrainConfig
  Creates a SubsetTrainConfig object of an appropriate subclass that corresponds to the given mode and uses default parameters.
create(String, String) - Static method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Creates a new project.
create(Map<DataPartition, SubsetFamily>) - Static method in class com.tibco.patterns.learn.api.hint.HintAddUntrained
  Creates a hint object with all subsets that are in validation, but not in training dataset.
create(Map<DataPartition, SubsetFamily>, SubsetFamily) - Static method in class com.tibco.patterns.learn.api.hint.HintAddUntrainedInTable
  Creates a hint object with all subsets that are not in any dataset, but are found in the data table.
createCO(Partition, COErrorRate) - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Creates convergence observer for the given partition.
createDataSet() - Method in class com.tibco.patterns.learn.recpair.RecPairSet
createDataSet() - Method in class com.tibco.patterns.learn.training.RLinkDataSet
createDataSet() - Method in class com.tibco.patterns.learn.training.VectorSet
createDftCO(COErrorRate) - Method in enum com.tibco.patterns.learn.training.Partition
createDftObservers() - Static method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Creates default observers for both datasets (COErrorRate and COErrorRateMin).
createExperiment() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Calculates any missing feature scores in datasets used for model creation and training, saves them to ModelSettings.
createLowConfPairFinder() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Creates and stores an object that finds low confidence pairs in the data table.
createModel(int, double, double, int, RLink.ThermometerType, int, int[]) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Creates a new untrained RLink model.
createModelConfig() - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Reads ModelConfig from file.
createModelTrainConfig(ModelConfig, Boolean, Map<Partition, ConvergenceObserver>) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Creates and remembers a new ModelTrainConfig, replacing any previous one.
createObservers() - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Creates observers for both datasets.
createObservers() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Creates convergence observers from modelTrainConfig.xml file, or creates default observers (COErrorRate and COErrorRateMin) if that file is not in the project directory.
createOnServer(NetricsServerInterface, String, Path) - Method in class com.tibco.patterns.learn.api.feature.Thesaurus
  Creates the thesaurus of the appropriate type on the Patterns server.
createScorer(NetricsServerInterface) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Creates a RecPairScorer that can be used only for scoring any record pairs with known field values.
createTrainCO() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Creates a COErrorRate object for the training dataset to be used for retraining the model with the exact best number of iterations.
createTrainedModelHints() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Creates hints that depend on model training results.
createTrainer(NetricsServerInterface) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Creates a ModelTrainer for training the active model.
createVldCO() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Creates a COErrorRate object for the validation dataset to be used for retraining the model with the exact best number of iterations.
currRes - Variable in class com.tibco.patterns.learn.training.COErrorRate

## D

DataPartition - Enum in com.tibco.patterns.learn.api.project
  Defines the type of a dataset: Training, Validation, Test, Reserve, Low Confidence, False Subsets.
DatasetResult - Class in com.tibco.patterns.learn.api.project
  Stores model training results for one dataset.
DatasetResult(COErrorRate.IterationResult) - Constructor for class com.tibco.patterns.learn.api.project.DatasetResult
  Copies information from given IterationResult to this object.
datasetSize(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
DatasetStats - Class in com.tibco.patterns.learn.api.hint
  Stores statistics about existing pairs in a dataset, grouped by subset: the number of pairs with each label and the total number of labeled pairs.
DatasetStats(FeatureQuery, RecPairMap, DataPartition) - Constructor for class com.tibco.patterns.learn.api.hint.DatasetStats
  Calculates and stores all dataset statistics for the given dataset.
DateQlt - Class in com.tibco.patterns.learn.api.feature
  A Date querylet for comparing the similarity of date values.
DateQlt(int, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.DateQlt
  Creates date querylet with given parameters.
deleteModel(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Deletes the non-active model specified by index.
deleteTable() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Deletes the loaded table from server, if it is found on the server.
deleteTrainedModel() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Deletes binary file of the trained model.
destroyModels() - Static method in class com.tibco.patterns.learn.rlink.RLink
  Destroys all RLink models created by the RLink static methods.
DYNAMIC - com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Train subsets and supersets, restricted by score limits

## E

EMPTY_SCORE - Static variable in class com.tibco.patterns.learn.rlink.RLink
  The value -1 used for the empty feature score (when it cannot be calculated).
endIteration() - Method in class com.tibco.patterns.learn.training.COErrorRate
  If printing is set up, prints results of this iteration.
endIteration() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  If the last iteration was the best, then remembers its results.
endIteration() - Method in class com.tibco.patterns.learn.training.COIterationCount
  Only switches object state.
endIteration() - Method in class com.tibco.patterns.learn.training.COScoreChange
  If printing is enabled, outputs the maximum score change of the iteration that has just ended.
endIteration() - Method in interface com.tibco.patterns.learn.training.TrainingObserver
  Any actions that need to be performed after evaluating the dataset.
endIteration(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Must be called after each training iteration with the entire training dataset.
equals(Object) - Method in class com.tibco.patterns.learn.api.feature.Thesaurus
equals(Object) - Method in class com.tibco.patterns.learn.api.project.RecPair
equals(Object) - Method in class com.tibco.patterns.learn.recpair.RecPairId
  If the two keys are swapped, the record pairs are still equal.
errorRate() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
errorRate() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
evaluate(DataPartition, TrainingObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Evaluates the existing model using examples from specified partition in the existing experiment.
evaluate(ModelSettings, DataPartition, TrainingObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Evaluates the existing model with the specified dataset loaded from another ModelSettings object (pairSource).
evaluate(RLinkDataSet<? extends VectorExample>, TrainingObserver) - Method in class com.tibco.patterns.learn.training.Trainer
  Calculates RLink predictions and evaluates them for the given examples.
evaluateAll(ModelSettings, TrainingObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Evaluates the existing model with record pairs in datasets used for training loaded from another ModelSettings object (pairSource).
evaluateAll(TrainingObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Evaluates the existing model using examples from both datasets in the existing experiment.
evaluateCsv(String, TrainingObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Loads record pairs from the CSV file and evaluates them.
evaluateErrorRate(RLinkDataSet<? extends VectorExample>) - Method in class com.tibco.patterns.learn.training.Trainer
  Convenience method that creates and uses COErrorRate to evaluate given examples.
evaluatePrediction(VectorExample) - Method in class com.tibco.patterns.learn.training.COErrorRate
  Updates statistics for the current training iteration.
evaluatePrediction(VectorExample) - Method in class com.tibco.patterns.learn.training.COIterationCount
  Does nothing.
evaluatePrediction(VectorExample) - Method in class com.tibco.patterns.learn.training.COScoreChange
  Updates the current maximum score change based on the prediction score for the given example.
evaluatePrediction(VectorExample) - Method in interface com.tibco.patterns.learn.training.TrainingObserver
  Interprets or accumulates prediction result of a single feature vector Called once for each feature vector in the dataset
examples - Variable in class com.tibco.patterns.learn.training.RLinkDataSet
  Stores all examples for this dataset
exportModelAndQuery(int, Path, String, Path, String, String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Exports all files needed to use the trained model on the Patterns server: the trained model binary file, Java source file that builds the Learn query, and any thesaurus files used by the query.
exportThesFiles(Path) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Exports all thesaurus files used by the feature query of the active model.
exportTrainedModel(Path) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Exports the trained model binary file with model score threshold.
exportTrainedModel(Path, String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Exports the trained model binary file from the active ModelSettings to the given location.

## F

FALSE - com.tibco.patterns.learn.api.project.RecPair.Label
  A False label - records do not match.
falseNegRate() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
falseNegRate() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
falsePosRate() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
falsePosRate() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
falseSubsets(int[]) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the always false subsets.
Feature<T extends com.tibco.patterns.learn.jaxb.model.FeatureType> - Class in com.tibco.patterns.learn.api.feature
  A user-defined feature composed of one or more querylets.
FeatureListener - Interface in com.tibco.patterns.learn.api.feature
  Classes implementing this interface receive notifications when feature query changes.
FeatureQuery - Class in com.tibco.patterns.learn.api.feature
  Supports a feature query that can contain all types of features.
FeatureQuery(List<String>, FeatureListener) - Constructor for class com.tibco.patterns.learn.api.feature.FeatureQuery
  Creates an empty feature query.
FeatureQuery(List<String>, Model.Features, FeatureListener) - Constructor for class com.tibco.patterns.learn.api.feature.FeatureQuery
  Creates the feature query and all querylets read from the xmlFeatures.
featureValuesSimilar(RecPair, double) - Method in class com.tibco.patterns.learn.api.project.RecPair
  Calculates whether the feature values in two pairs are similar.
FeatureVector - Class in com.tibco.patterns.learn.training
  Stores a feature vector that can be predicted by a Learn model.
FeatureVector(double[]) - Constructor for class com.tibco.patterns.learn.training.FeatureVector
  Creates the feature vector.
FieldStats - Class in com.tibco.patterns.learn.api.project
  Stores statistics for one table field.
FieldStats() - Constructor for class com.tibco.patterns.learn.api.project.FieldStats
  Creates a blank object.
FieldStats(FileFieldType) - Constructor for class com.tibco.patterns.learn.api.project.FieldStats
  Copies information from the XML field to this object
finalize() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Provided for safety, but client code must call close() explicitly.
finalize() - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Provided for safety, but client code must call `RecPairScorer.close()` explicitly.
firstRecBatch() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Prepares the server table for iteration over all records.
firstRecBatch(int, String) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Prepares the server table for iteration over records using specific options.
FIXED - com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Train up to fixed depth of subsets, defined by percentage of missing info
fromBool(boolean) - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
fromInt(int) - Static method in enum com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
fromInt(int) - Static method in enum com.tibco.patterns.learn.rlink.RLink.ThermometerType
  Converts the given integer constant to the enum.
fromString(String) - Static method in enum com.tibco.patterns.learn.api.feature.Thesaurus.Type
fromXml(RecPairLabelType) - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
FSUBSETS - com.tibco.patterns.learn.api.project.DataPartition
  Dataset of always false subsets.

## G

GenderFeature - Class in com.tibco.patterns.learn.api.feature
  A feature with 2 predicate querylets that mean: both records are male; both records are female.
GenderFeature(String, int, List<String>, List<String>, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.GenderFeature
  Creates a new feature for the given gender field
generateXml(Model.Features) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Fills the given XML type with the user-defined features and thesauri that are stored in this FeatureQuery.
GenericFeature - Class in com.tibco.patterns.learn.api.feature
  A generic feature that has a single querylet of any type.
GenericFeature(String, AbstractQlt<?>) - Constructor for class com.tibco.patterns.learn.api.feature.GenericFeature
  Creates a generic feature with a single querylet.
get(DataPartition, int) - Method in class com.tibco.patterns.learn.api.project.RecPairMap
  Get the XML representation of the pair.
get(RecPairId) - Method in class com.tibco.patterns.learn.api.project.RecPairMap
getAbbr() - Method in enum com.tibco.patterns.learn.api.project.DataPartition
getAbbr() - Method in enum com.tibco.patterns.learn.training.Partition
getActiveModelIndex() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getActiveModelSettings() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
getAdded(DataPartition) - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getAllExamples() - Method in class com.tibco.patterns.learn.training.RLinkExperiment
getAllRecPairs() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Converts record pairs in all datasets from XML structures to RecPair objects.
getAnnealingRate() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getBestIteration() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
getBestResult() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
getBlurWindow() - Method in class com.tibco.patterns.learn.rlink.ConfFeature
getCalcSignificance() - Method in class com.tibco.patterns.learn.rlink.PredictOptions
  Return the include significance setting.
getConfidence() - Method in class com.tibco.patterns.learn.rlink.PredictOptions
  Returns the confidence measure options.
getConfidence() - Method in class com.tibco.patterns.learn.rlink.RLinkOut
  Gets the prediction confidence.
getConfType() - Method in class com.tibco.patterns.learn.rlink.ConfDefault
  Return the confidence type.
getConfType() - Method in class com.tibco.patterns.learn.rlink.ConfFeature
  Return the confidence type.
getConfType() - Method in interface com.tibco.patterns.learn.rlink.Confidence
  Return the confidence type.
getConfType() - Method in class com.tibco.patterns.learn.rlink.ConfNone
  Return the confidence type.
getConfType() - Method in class com.tibco.patterns.learn.rlink.ConfRatio
  Return the confidence type.
getConfType() - Method in class com.tibco.patterns.learn.rlink.ConfRatioLabel
  Return the confidence type.
getConfType() - Method in class com.tibco.patterns.learn.rlink.ConfStats
  Return the confidence type.
getCount(List<Boolean>) - Method in class com.tibco.patterns.learn.api.hint.HintAddPairs
getDataFile(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
getDataFileLastModified(int) - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
  Get the data file last modified date, as that date is remembered in the project.
getDataset(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Converts record pairs in the given partition from XML structures to RecPair objects.
getDataset(RecPairExperiment) - Method in enum com.tibco.patterns.learn.api.project.DataPartition
getDatasetResult(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Returns a saved dataset result.
getDblArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfDefault
  Return a double parameter.
getDblArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfFeature
  Return a double parameter.
getDblArg(int) - Method in interface com.tibco.patterns.learn.rlink.Confidence
  Return a double parameter.
getDblArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfNone
  Return a double parameter.
getDblArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfRatio
  Return a double parameter.
getDblArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfRatioLabel
  Return a double parameter.
getDblArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfStats
  Return a double parameter.
getDefault() - Static method in enum com.tibco.patterns.learn.api.feature.Thesaurus.Type
getDftFieldWeight() - Static method in class com.tibco.patterns.learn.api.feature.AbstractQlt
getDftGoodFitDistance() - Static method in class com.tibco.patterns.learn.training.COErrorRateMin
getDftInsertScore(boolean) - Static method in class com.tibco.patterns.learn.modelconfig.STDynamic
getDftMaxConfThreshold() - Static method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
getDftMaxFalsePairsPerQuery() - Static method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
getDftMaxIterations() - Static method in class com.tibco.patterns.learn.training.COErrorRateMin
  Get default maximum iterations for COErrorRateMin.
getDftMaxIterations() - Static method in class com.tibco.patterns.learn.training.COIterationCount
getDftMaxPairsPerQuery() - Static method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
getDftMinIterations() - Static method in class com.tibco.patterns.learn.training.COScoreChange
getDftNIterAfterMin() - Static method in class com.tibco.patterns.learn.training.COErrorRateMin
getDftRemoveLimit(boolean) - Static method in class com.tibco.patterns.learn.modelconfig.STDynamic
getDftTargetErrorRate() - Static method in class com.tibco.patterns.learn.training.COErrorRate
getDftTargetScoreChange() - Static method in class com.tibco.patterns.learn.training.COScoreChange
getDistinctValues() - Method in class com.tibco.patterns.learn.api.project.FieldStats
getDuplicates() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getEmptyFieldPenalty() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
  Gets the empty field penalty.
getFalseInsertScores() - Method in class com.tibco.patterns.learn.modelconfig.STDynamic
getFalseInsertScores(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getFalseRemoveLimits() - Method in class com.tibco.patterns.learn.modelconfig.STDynamic
getFalseRemoveLimits(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getFalseSubsets() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getFamilyAllSubsets() - Method in class com.tibco.patterns.learn.api.hint.DatasetStats
getFeature(int) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getFeature(String) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Gets the feature by name.
getFeatureCount(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Gets the number of model features.
getFeatureQuery() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  The returned reference can be used to add, modify or delete features.
getFeatureValues() - Method in class com.tibco.patterns.learn.api.project.RecPair
  No setter - feature values are calculated and assigned to XML structure
getFeatureValues() - Method in class com.tibco.patterns.learn.training.FeatureVector
getFeatureValues() - Method in class com.tibco.patterns.learn.training.VectorExample
getFemaleCodes() - Method in class com.tibco.patterns.learn.api.feature.GenderFeature
getFieldIgnore(int) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getFieldIndex(int) - Method in class com.tibco.patterns.learn.api.feature.AbstractQlt
getFieldIndex(int) - Method in interface com.tibco.patterns.learn.api.feature.Querylet
  Converts from field index in the list of querylet fields to the field index in the list of all non-key table fields.
getFieldInvalidValues(int) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getFieldName() - Method in class com.tibco.patterns.learn.api.feature.DateQlt
getFieldName() - Method in class com.tibco.patterns.learn.api.feature.GenderFeature
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.DateQlt
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.Feature
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.GenderFeature
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.PersonNameFeature
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.PredicateQlt
getFieldNames() - Method in interface com.tibco.patterns.learn.api.feature.Querylet
getFieldNames() - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
getFieldNames() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getFields(int) - Method in class com.tibco.patterns.learn.recpair.RecPairExample
getFieldStats(int, int) - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getFieldType(int) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getFieldValues() - Method in class com.tibco.patterns.learn.api.project.RecPair
getFieldValues(String, String) - Method in class com.tibco.patterns.learn.recpair.RLinkServerInterface
getFieldWeight(int) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
getFieldWeight(int) - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
getFieldWeight(int) - Method in class com.tibco.patterns.learn.api.feature.TextQlt
getFNameField() - Method in class com.tibco.patterns.learn.api.feature.PersonNameFeature
getFrequentValues() - Method in class com.tibco.patterns.learn.api.project.FieldStats
getGoodFitDistance() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
getId() - Method in class com.tibco.patterns.learn.api.project.RecPair
getId() - Method in class com.tibco.patterns.learn.recpair.RecPairExample
getID(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Return the unique ID for this model.
getInitialLearningRate(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Returns the initial learning rate, or -1 for file versions below RFV5.
getInProjectNoLabel() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getInProjectOppositeLabel() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getInProjectSameLabel() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getIntArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfDefault
  Return an integer parameter.
getIntArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfFeature
  Return an integer parameter.
getIntArg(int) - Method in interface com.tibco.patterns.learn.rlink.Confidence
  Return an integer parameter.
getIntArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfNone
  Return an integer parameter.
getIntArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfRatio
  Return an integer parameter.
getIntArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfRatioLabel
  Return an integer parameter.
getIntArg(int) - Method in class com.tibco.patterns.learn.rlink.ConfStats
  Return an integer parameter.
getIterationResult() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
  May be used to get access to statistics not directly exposed by DatasetResult methods.
getKey(int) - Method in class com.tibco.patterns.learn.recpair.RecPairId
getKeyFieldIndex() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getLabel() - Method in class com.tibco.patterns.learn.api.hint.HintAddLabel
getLabel() - Method in class com.tibco.patterns.learn.api.project.RecPair
getLabel() - Method in class com.tibco.patterns.learn.rlink.RLinkOut
getLabel() - Method in class com.tibco.patterns.learn.training.VectorExample
getLabel(double) - Static method in class com.tibco.patterns.learn.rlink.RLinkOut
getLastConfThreshold() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Gets the last confidence threshold.
getLastTablePos() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
getLearningRate() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getLNameField() - Method in class com.tibco.patterns.learn.api.feature.PersonNameFeature
getLowConfMatches(List<String>, double) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Runs a query on server to get the low confidence matches in the data table for the given query record.
getLowConfMatches(List<String>, double, Confidence) - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Runs a query on server to get the low confidence matches in the data table for the given query record.The query uses the model and thesauri on server.
getMaleCodes() - Method in class com.tibco.patterns.learn.api.feature.GenderFeature
getMaxIterations() - Method in class com.tibco.patterns.learn.training.COIterationCount
getMetadata(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Returns the notes (meta-data) of the model.
getMinDiff() - Method in class com.tibco.patterns.learn.rlink.ConfFeature
getMinIterations() - Method in class com.tibco.patterns.learn.training.COErrorRate
getMissingInfoLimit() - Method in class com.tibco.patterns.learn.modelconfig.STFixed
getMissingInfoLimit(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getMNameField() - Method in class com.tibco.patterns.learn.api.feature.PersonNameFeature
getModelFileName() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getModelId() - Method in class com.tibco.patterns.learn.training.Trainer
getModelScoreThreshold() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getModelTrainConfig() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Get model training configuration.
getModelTrainDate() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getModelTrainIter() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNAdded(DataPartition) - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getName() - Method in class com.tibco.patterns.learn.api.feature.Feature
getName() - Method in class com.tibco.patterns.learn.api.feature.Thesaurus
getName() - Method in enum com.tibco.patterns.learn.api.project.DataPartition
getName() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getName() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getName() - Method in enum com.tibco.patterns.learn.training.Partition
getNDataFiles() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getNegative() - Method in class com.tibco.patterns.learn.modelconfig.STTaper
getNegativeTaper(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getNErrors() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getNetricsQlt(String[]) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
getNetricsQlt(String[]) - Method in class com.tibco.patterns.learn.api.feature.DateQlt
getNetricsQlt(String[]) - Method in class com.tibco.patterns.learn.api.feature.PredicateQlt
  Constructs a NetricsQuery querylet from the stored XML structure and the given field values.
getNetricsQlt(String[]) - Method in interface com.tibco.patterns.learn.api.feature.Querylet
  Constructs a NetricsQuery querylet from the stored XML structure and the given field values.
getNetricsQlt(String[]) - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
getNetricsQlts(String[]) - Method in class com.tibco.patterns.learn.api.feature.Feature
  Constructs all NetricsQuery querylets from the corresponding XML Search structure and the field values.
getNetricsQlts(String[]) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Constructs NetricsQuery querylets from all querylets in feature query.
getNExamples() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getNFalseExamples() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getNFalseNeg() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getNFalsePos() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getNFeatures() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getNFeatures() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNFeatures() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getNFeatures() - Method in class com.tibco.patterns.learn.training.FeatureVector
getNFeatures() - Method in class com.tibco.patterns.learn.training.RLinkDataSet
getNFeatures() - Method in class com.tibco.patterns.learn.training.RLinkExperiment
getNFeatures() - Method in class com.tibco.patterns.learn.training.VectorExample
getNFields() - Method in class com.tibco.patterns.learn.api.feature.AbstractQlt
getNFields() - Method in interface com.tibco.patterns.learn.api.feature.Querylet
getNFields() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getNFields() - Method in class com.tibco.patterns.learn.api.project.RecPair
getNIgnoredFields() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNInProject() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getNIterAfterMin() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
getNIterations() - Method in class com.tibco.patterns.learn.training.COIterationCount
  Can be used with subclasses to distinguish between convergence and reaching maxIterations without converging.
getNLabeledRecPairs(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNModels() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
getNNotUseful() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
  Gets the number of pairs added to Reserve dataset and to the overflow list.
getNonCognateWeight() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
  Gets non-cognate weight applied when a value is entered in a wrong field.
getNonEmptyRows() - Method in class com.tibco.patterns.learn.api.project.FieldStats
getNonKeyFieldNames() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getNorm() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getNorm(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getNote() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNote() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getNotUseful() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getNProcessedInputRecs() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Get the number of processed records.
getNQlts() - Method in class com.tibco.patterns.learn.api.feature.Feature
getNQlts() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Returns the total number of querylets in all features
getNQlts() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNRecords() - Static method in class com.tibco.patterns.learn.api.project.RecPair
getNRecPairs() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNRecPairs(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNReturnedFalsePairs() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNReturnedPairs() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNSkippedExists() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNSkippedFalse() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNSkippedPairs() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNSkippedSimilar() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNSkippedThreshold() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can only be used in the consumer thread.
getNStoredPairs() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Can be called from a concurrent consumer thread.
getNTrueExamples() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getNUntrainedPred() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Returns the number of examples that cannot be reliably predicted.
getNUsedRecPairs() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getNUseful() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getOverflow() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getPartition() - Method in class com.tibco.patterns.learn.api.hint.DatasetStats
getPartition() - Method in class com.tibco.patterns.learn.api.project.RecPair
getPositive() - Method in class com.tibco.patterns.learn.modelconfig.STTaper
getPositiveTaper(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getPrecisionBits() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getPrecisionBits(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Returns number of precision bits, or -1 for file versions below RFV5.
getPredicate() - Method in class com.tibco.patterns.learn.api.feature.PredicateQlt
getPrediction() - Method in class com.tibco.patterns.learn.api.project.RecPair
  No public setter - model result is calculated during training.
getPrediction() - Method in class com.tibco.patterns.learn.training.VectorExample
getPredictOptions() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
getPredictOptions() - Method in class com.tibco.patterns.learn.training.Trainer
getPrevModelName() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  No setter: previous model name is set automatically when saving a copy of the model.
getPrevPrediction() - Method in class com.tibco.patterns.learn.training.VectorExample
  Used from TrainingObservers that need to compare previous and current iterations.
getProgressEstimate() - Method in class com.tibco.patterns.learn.training.COErrorRate
getProgressEstimate() - Method in class com.tibco.patterns.learn.training.COIterationCount
getProgressEstimate() - Method in interface com.tibco.patterns.learn.training.ConvergenceObserver
  Returns an estimate of training progress, which can be used to indicate how close the desired convergence is.
getProgressEstimate() - Method in class com.tibco.patterns.learn.training.COScoreChange
getProjectSettings() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
getQlt(int) - Method in class com.tibco.patterns.learn.api.feature.Feature
getQltNames() - Method in class com.tibco.patterns.learn.api.feature.Feature
getQltNames() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getQlts() - Method in class com.tibco.patterns.learn.api.feature.Feature
getQlts() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getRecPair(DataPartition, int) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getRecPair(RecPairId) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
getRecPairs() - Method in class com.tibco.patterns.learn.api.hint.HintReviewPairs
getRecPairs(Set<DataPartition>) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Converts record pairs in the specified datasets from XML structures to RecPair objects.
getResult() - Method in class com.tibco.patterns.learn.training.COErrorRate
getScore() - Method in class com.tibco.patterns.learn.rlink.RLinkOut
getScoreDist(RecPairId) - Method in class com.tibco.patterns.learn.api.hint.HintReviewPairs
  Get the computed score distance for a record pair.
getSignificance() - Method in class com.tibco.patterns.learn.rlink.RLinkOut
  Gets the significance of each model feature value.
getSkippedCount(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Skipped count is applicable only for TAPER subset training mode.
getSubsets() - Method in class com.tibco.patterns.learn.api.hint.HintAddPairs
getSubsetTrainConfig() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
getSubsetTrainMode() - Method in class com.tibco.patterns.learn.modelconfig.SubsetTrainConfig
getSubsetTrainMode(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getTablePosition() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Gets the encoded current position in the table that is used to get the next batch of records.
getTargetErrorRate() - Method in class com.tibco.patterns.learn.training.COErrorRate
getThermometerType(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Returns the thermometer type, or throws exception for file versions below RFV5 (thermometer type is -1, which is invalid).
getThesauri() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getThesaurus(String) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getThesaurusName() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
getThesaurusName() - Method in class com.tibco.patterns.learn.api.feature.PersonNameFeature
getThesaurusName() - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
getThesaurusName() - Method in class com.tibco.patterns.learn.api.feature.TextQlt
getThesaurusNames() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
getThesaurusWeight() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
getThesaurusWeight() - Method in class com.tibco.patterns.learn.api.feature.PersonNameFeature
getThesaurusWeight() - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
getThesaurusWeight() - Method in class com.tibco.patterns.learn.api.feature.TextQlt
getThreshold(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Return the threshold for this model.
getTotalConf() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
getTrainCO() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
getTrainedCount(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Trained count is applicable only for TAPER subset training mode.
getTrainLabel() - Method in class com.tibco.patterns.learn.api.project.RecPair
  No setter - training label is saved together with model prediction.
getTrainSet() - Method in class com.tibco.patterns.learn.training.RLinkExperiment
getTrueInsertScores() - Method in class com.tibco.patterns.learn.modelconfig.STDynamic
getTrueInsertScores(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getTrueRemoveLimits() - Method in class com.tibco.patterns.learn.modelconfig.STDynamic
getTrueRemoveLimits(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
getType() - Method in class com.tibco.patterns.learn.api.feature.Thesaurus
getUseful() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
getValue() - Method in enum com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
getValue() - Method in enum com.tibco.patterns.learn.rlink.RLink.ThermometerType
getVersion() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  No setter: version is not configurable.
getVersion() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
getVersion(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Return the version ID for this model.
getVldSet() - Method in class com.tibco.patterns.learn.training.RLinkExperiment
getXmlString() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Generates XML with all features (similar to the features element in model.xml) and returns it as string.

## H

hashCode() - Method in class com.tibco.patterns.learn.api.feature.Thesaurus
  Hash code uses thesaurus name only.
hashCode() - Method in class com.tibco.patterns.learn.api.project.RecPair
hashCode() - Method in class com.tibco.patterns.learn.recpair.RecPairId
hasIterations() - Method in class com.tibco.patterns.learn.training.COIterationCount
hasIterations() - Method in interface com.tibco.patterns.learn.training.TrainingObserver
hasLowConfPairFinder() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
hasModel() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
hasModelTrainConfig() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Checks whether a custom model training configuration is used to train the model.
hasMoreInputRecords() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
hasNext() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Checks if more constructed pairs exist.
hasPrediction() - Method in class com.tibco.patterns.learn.api.project.RecPair
hasRecPairs() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
hasThesaurus() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
hasThesaurus() - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
hasThesaurus() - Method in class com.tibco.patterns.learn.api.feature.TextQlt
hasTrainedModel() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Use this method before obtaining any other info about trained model.
Hint - Interface in com.tibco.patterns.learn.api.hint
  Any suggestion that is given to the user based on the current state of the project.
HintAddLabel - Class in com.tibco.patterns.learn.api.hint
  Hint to add pairs for subsets that have too few True/False labels.
HintAddPairs - Class in com.tibco.patterns.learn.api.hint
  A hint to select additional record pairs for specified subsets.
HintAddPairs(SubsetFamily) - Constructor for class com.tibco.patterns.learn.api.hint.HintAddPairs
HintAddUnderrepr - Class in com.tibco.patterns.learn.api.hint
  Hint to add pairs to subsets that are underrepresented in training dataset.
HintAddUntrained - Class in com.tibco.patterns.learn.api.hint
  Hint to add pairs to subsets that are present in validation dataset, but are not in training dataset.
HintAddUntrainedInTable - Class in com.tibco.patterns.learn.api.hint
  Hint to add pairs to subsets that are not found in either training or validation datasets, but are found in the data table.
HintReviewContra - Class in com.tibco.patterns.learn.api.hint
  A hint to review pairs that have contradicting pairs.
HintReviewMislabeled - Class in com.tibco.patterns.learn.api.hint
  A hint to review possibly mislabeled pairs.
HintReviewPairs - Class in com.tibco.patterns.learn.api.hint
  A hint to review the labels for a list of existing record pairs.
HintReviewPairs(Map<RecPairId, Double>) - Constructor for class com.tibco.patterns.learn.api.hint.HintReviewPairs

## I

incorrectPrediction() - Method in class com.tibco.patterns.learn.api.project.RecPair
INS_DEFAULT - Static variable in class com.tibco.patterns.learn.modelconfig.STDynamic
  Use default insertion score.
isBool() - Method in enum com.tibco.patterns.learn.api.project.RecPair.Label
isBool(RecPairLabelType) - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
isCompareVldFirst() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
isConverged() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
  Use this method with validation dataset result.
isConverged() - Method in class com.tibco.patterns.learn.training.COErrorRate
  Returns true if the target error rate has been reached in the last training iteration, after performing at least the minimum number of iterations.
isConverged() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Returns true if the default target error rate has been reached.
isConverged() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Determines if further training is unlikely to improve the best result that was found.
isConverged() - Method in class com.tibco.patterns.learn.training.COIterationCount
isConverged() - Method in interface com.tibco.patterns.learn.training.ConvergenceObserver
  Returns whether the trained model has converged.
isConverged() - Method in class com.tibco.patterns.learn.training.COScoreChange
isConverged(double) - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Returns true if the target error rate has been reached.
isDebugOutput() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
isDftRandomOrder() - Static method in class com.tibco.patterns.learn.training.Trainer
isFalseNeg() - Method in class com.tibco.patterns.learn.api.project.RecPair
isFalsePos() - Method in class com.tibco.patterns.learn.api.project.RecPair
isMatchEmpty() - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
isMatchEmpty() - Method in class com.tibco.patterns.learn.api.feature.DateQlt
isMatchEmpty() - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
isMatchEmpty() - Method in class com.tibco.patterns.learn.api.feature.TextQlt
isModelLoaded() - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Checks if the model was loaded to server by this object.
isModelLoadedToServer() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Checks if the model was loaded to server by the scorer.
isPerfectResult() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
isPerfectResult() - Method in class com.tibco.patterns.learn.training.COErrorRate
  Returns true if all examples in the dataset are predicted correctly.
isPerfectResult() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
isPerfectResult() - Method in class com.tibco.patterns.learn.training.COIterationCount
isPerfectResult() - Method in class com.tibco.patterns.learn.training.COScoreChange
isPerfectResult() - Method in interface com.tibco.patterns.learn.training.TrainingObserver
isRandomOrder() - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
isRandomOrder() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Get the random order parameter that was specified in ModelTrainConfig (if file present), or the default (true).
isReview() - Method in class com.tibco.patterns.learn.api.project.RecPair
isUsedForModel() - Method in enum com.tibco.patterns.learn.api.project.DataPartition
  Checks whether the partition is used for model creation or training (TRAIN, VLD, FSUBSETS).
isUsedInTraining() - Method in enum com.tibco.patterns.learn.api.project.DataPartition
  Checks whether the partition is used in training (TRAIN and VLD).
isUsingSubsets() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
IterationResult(double) - Constructor for class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Initializes all values to 0.
IterationResult(int, int, int, int, int, int, double) - Constructor for class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Stores all given values in the new object.
iterator() - Method in class com.tibco.patterns.learn.training.RLinkDataSet

## L

LARGE - com.tibco.patterns.learn.rlink.RLink.ThermometerType
  Large thermometer - faster learning, slower predictions.
learn(int, double[], boolean) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Trains the existing model with the given training example (feature vector and label).
learn(RLinkDataSet<? extends VectorExample>) - Method in class com.tibco.patterns.learn.training.Trainer
  Performs a single training iteration for all given training examples.
learnRate(double) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the initial learning rate which defines how quickly the internal model state changes during training in response to incorrectly classified examples.
load(String, String) - Static method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Loads an existing project from the specified directory.
loadModel(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Loads ModelSettings from model.xml file specified by the index.
loadModel(String, Path) - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Loads the model to server.
loadTable(String, NetricsRecFile) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Loads the table from a server side CSV file to the Patterns server for scoring.
loadTrainedModel() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Loads the trained model from the model.bin file to ModelTrainer of the active model.
localDataFileExists(String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
LOW_CONF - com.tibco.patterns.learn.api.project.DataPartition
  Low confidence dataset stores the best pairs found by LowConfPairFinder, but not yet shown to the user.
LowConfPairFinder - Class in com.tibco.patterns.learn.api.autopair
  Finds new low confidence pairs to be labeled and added to the project.
LowConfPairFinder(RecPairMap, FeatureQuery, ModelTrainer, String) - Constructor for class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Constructs the object that can find new low confidece pairs.

## M

main(String[]) - Static method in class com.tibco.patterns.learn.rlink.ThermoCsvDump
  Writes weights of thermometers in one winnow to a CSV file.
MAX_SCORE - Static variable in class com.tibco.patterns.learn.rlink.RLink
  The maximum non-empty feature score, and the maximum model score (1).
meanConf() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
meanConf() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
meanDist() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
meanErrConf() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
meanErrDist() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
MIN_SCORE - Static variable in class com.tibco.patterns.learn.rlink.RLink
  The minimum non-empty feature score, and the minimum model score (0).
minNLabeledRecPairs(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Calculates a minimum number of labeled record pairs that is recommended for the given partition.
ModelConfig - Class in com.tibco.patterns.learn.modelconfig
  Stores a configuration of an RLink model and builds model(s) with this configuration.
ModelConfig() - Constructor for class com.tibco.patterns.learn.modelconfig.ModelConfig
  Creates model configuration with all default parameters that are recommended for up to 11 features.
ModelConfig(int) - Constructor for class com.tibco.patterns.learn.modelconfig.ModelConfig
  Creates model configuration with default parameters that are recommended for the specified number of features.
ModelConfig(ModelConfig) - Constructor for class com.tibco.patterns.learn.modelconfig.ModelConfig
  Creates a deep copy of the given object.
ModelSettings - Class in com.tibco.patterns.learn.api.project
  Stores all settings for a single Patterns Learn model.xml file.
ModelTrainConfig - Class in com.tibco.patterns.learn.api.project
  Defines configuration for creating and training a Learn model.
ModelTrainConfig(Schema, Path) - Constructor for class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Loads the configuration from xmlFile.
ModelTrainer - Class in com.tibco.patterns.learn.api.project
  Functionality to communicate with Patterns server, load data table, calculate feature scores, train and evaluate model.
modelValues() - Static method in enum com.tibco.patterns.learn.api.project.DataPartition
  Lists partitions that are used for model creation or for model training.
moveUsefulRecPairs(DataPartition, int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Moves the record pairs that are likely to improve model training from the given dataset (Reserve) to the training or validation dataset of the active model.

## N

needContinueTraining(TrainingObserver, ConvergenceObserver) - Static method in class com.tibco.patterns.learn.training.Trainer
needRetrain() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Returns true if the model needs to be retrained.
needStopTraining() - Method in class com.tibco.patterns.learn.training.COErrorRate
  Returns true if the target error rate (after performing the minimum number of iterations) or the maximum number of iterations have been reached.
needStopTraining() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Determines if training needs to be stopped.
needStopTraining() - Method in class com.tibco.patterns.learn.training.COIterationCount
needStopTraining() - Method in interface com.tibco.patterns.learn.training.ConvergenceObserver
  Returns whether the training has to be stopped after current iteration.
needStopTraining() - Method in class com.tibco.patterns.learn.training.COScoreChange
next(RecPair.Label, DataPartition) - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Returns the next constructed pair to be labeled.
nextRecBatch() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Gets the next batch of records from the server table.
nFeatures(int) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the number of model features.
NO_CHANGE - Static variable in class com.tibco.patterns.learn.modelconfig.STDynamic
  Do not insert/remove score.
NO_CONFIDENCE_MEASURE - Static variable in class com.tibco.patterns.learn.rlink.RLink
  The value returned if no confidence measure was calculated or if the requested confidence measure is not supported by the given model.
NONE - com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Train actual examples only, no generated subsets
noPredictionRate() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
noPredictionRate() - Method in class com.tibco.patterns.learn.training.COErrorRate.IterationResult
  Returns the percentage of examples that cannot be reliably predicted.
norm(double) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets Minkowski norm value for combining feature values.
nsi() - Method in class com.tibco.patterns.learn.recpair.RLinkServerInterface
  Returns the server interface object to be used for all standard server methods.

## O

opposite() - Method in enum com.tibco.patterns.learn.api.project.RecPair.Label
optimizeScoreThreshold(DataPartition) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Optimizes the score threshold to minimize the error rate and maximize the separation of the correct predictions.
otherFeatureHasThesWithDifferentType(Thesaurus, Feature<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Checks for thesaurus type conflicts.

## P

Partition - Enum in com.tibco.patterns.learn.training
  Defines the type of a dataset: Training or Validation.
PersonNameFeature - Class in com.tibco.patterns.learn.api.feature
  A feature with 3 querylets:
  Simple: first name, with thesaurus;
  Simple: last name;
  Cognate: first, middle (optional) and last name fields, with thesaurus, non-cognate weight 0.8, empty field penalty 0.1.
PersonNameFeature(String, int, int, int, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.PersonNameFeature
  Creates a new feature for first, middle and last names.
PersonNameFeature(String, int, int, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.PersonNameFeature
  Creates a new feature for first and last names (middle name field is not used).
precision(int) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the number of precision bits.
PredicateQlt - Class in com.tibco.patterns.learn.api.feature
  A Predicate querylet for evaluating a predicate expression.
PredicateQlt(String, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.PredicateQlt
  Creates predicate querylet with the given predicate expression.
predict(int) - Method in class com.tibco.patterns.learn.training.VectorExample
  Calculates prediction using default options.
predict(int, double[]) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Predicts the score (and label) using default options.
predict(int, double[], PredictOptions) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Predicts the score (and label), calculates the requested confidence and significance.
predict(int, PredictOptions) - Method in class com.tibco.patterns.learn.training.FeatureVector
  Calculates prediction using the given model and options.
predict(int, PredictOptions) - Method in class com.tibco.patterns.learn.training.VectorExample
  Calculates prediction using the given model and options, stores it in this example.
predict(RecPair) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Predicts the given pair using the existing model.
predict(FeatureVector) - Method in class com.tibco.patterns.learn.training.Trainer
  Calculates the RLink prediction for the given feature vector.
predict(VectorExample) - Method in class com.tibco.patterns.learn.training.Trainer
  Calculates and saves RLink prediction in the given example.
PredictOptions - Class in com.tibco.patterns.learn.rlink
  Holds all options for calculating prediction using a Learn model.
PredictOptions() - Constructor for class com.tibco.patterns.learn.rlink.PredictOptions
  Creates object with default options.
PredictOptions(boolean, Confidence) - Constructor for class com.tibco.patterns.learn.rlink.PredictOptions
  Creates object with specified options.
prevRes - Variable in class com.tibco.patterns.learn.training.COErrorRate
printHeaderLine() - Method in class com.tibco.patterns.learn.training.COErrorRate
  Prints the header of the iteration list.
processNextInputRec() - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Finds low confidence pairs for the next input record in the table.
ProjectFiles - Class in com.tibco.patterns.learn.api.project
  Manages all files for one Patterns Learn project.
ProjectSettings - Class in com.tibco.patterns.learn.api.project
  Stores all settings for a single Patterns Learn project.xml file.

## Q

Querylet - Interface in com.tibco.patterns.learn.api.feature
  Defines shared functionality for a single Learn querylet.

## R

read(String) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Loads a model from file.
RecPair - Class in com.tibco.patterns.learn.api.project
  Stores information about one record pair, including field values, feature scores and label.
RecPair(String, String, List<String>, List<String>) - Constructor for class com.tibco.patterns.learn.api.project.RecPair
  Creates a new record pair with required data to be passed to Learn API.
RecPair(String, String, List<String>, List<String>, RecPair.Label) - Constructor for class com.tibco.patterns.learn.api.project.RecPair
  Creates a labeled record pair to be passed to Learn API.
RecPair.ConfScoreComparator - Class in com.tibco.patterns.learn.api.project
  Provides ordering by a combination (weighted sum) of the prediction confidence (ascending) and the distance of the model score from the 0.5 threshold (ascending).
RecPair.Label - Enum in com.tibco.patterns.learn.api.project
  Defines a label that can be assigned to a record pair: True, False or Unsure.
RecPairExample - Class in com.tibco.patterns.learn.recpair
  A training example constructed based on a pair of database records.
RecPairExample(RecPairId, RecPairScorer, boolean) - Constructor for class com.tibco.patterns.learn.recpair.RecPairExample
  Uses RecPairScorer to get field values from server table, calculates symmetric feature scores.
RecPairExample(RecPairId, List<String>, List<String>, double[], boolean) - Constructor for class com.tibco.patterns.learn.recpair.RecPairExample
  Creates RecPairExample when feature values are known.
RecPairExperiment - Class in com.tibco.patterns.learn.recpair
  Manages a training dataset and a validation dataset.
RecPairExperiment(double, String, RecPairScorer) - Constructor for class com.tibco.patterns.learn.recpair.RecPairExperiment
  Loads a single list of pairs from CSV, then divides them randomly to training and validation datasets.
RecPairExperiment(int, List<RecPairType>, List<RecPairType>) - Constructor for class com.tibco.patterns.learn.recpair.RecPairExperiment
  Creates RecPairExperiment with training examples imported from the two given XML datasets.
RecPairId - Class in com.tibco.patterns.learn.recpair
  Stores a pair of keys.
RecPairId(RecPairType) - Constructor for class com.tibco.patterns.learn.recpair.RecPairId
  Creates object that stores keys taken from the given XML record pair.
RecPairId(String, String) - Constructor for class com.tibco.patterns.learn.recpair.RecPairId
  Creates object that stores the two given keys for a record pair.
RecPairMap - Class in com.tibco.patterns.learn.api.project
  Manages datasets in the XML structure in sync with a map of all record pairs that are stored in these datasets.
recPairs - Variable in class com.tibco.patterns.learn.api.hint.HintReviewPairs
RecPairScorer - Class in com.tibco.patterns.learn.recpair
  Manages calculation of feature scores and communication with Patterns server.
RecPairScorer(NetricsServerInterface, NetricsTable, FeatureQuery, Path) - Constructor for class com.tibco.patterns.learn.recpair.RecPairScorer
  Creates scorer object for scoring records.
RecPairScorer(NetricsServerInterface, String, FeatureQuery, Path) - Constructor for class com.tibco.patterns.learn.recpair.RecPairScorer
  Creates scorer object for scoring records and getting field values from the existing table on the server.
RecPairSet - Class in com.tibco.patterns.learn.recpair
  A container for storing a set of RecPairExample training examples.
RecPairSet(int) - Constructor for class com.tibco.patterns.learn.recpair.RecPairSet
  Creates empty dataset.
RecPairSet(int, int) - Constructor for class com.tibco.patterns.learn.recpair.RecPairSet
  Creates empty dataset.
RecPairSet(int, List<RecPairType>) - Constructor for class com.tibco.patterns.learn.recpair.RecPairSet
  Creates RecPairSet with examples copied from xmlDataset.
RecPairSet(String, RecPairScorer) - Constructor for class com.tibco.patterns.learn.recpair.RecPairSet
  Constructs the dataset by loading record pairs from CSV file.
reloadTable(String, NetricsRecFile) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Deletes table from the server if it exists, then loads table from a server side CSV file.
removeFeature(int) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Deletes the feature with the given index.
removeRecPair(DataPartition, int) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Deletes a record pair with the given index from the specified dataset.
removeRecPair(DataPartition, RecPairId) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Deletes a record pair with the given keys from the specified dataset.
removeRecPair(RecPairId) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Deletes a record pair with the given keys.
removeThesauri(Feature<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Removes all thesauri from the given feature and from the list of thesauri used by this feature query (if needed).
removeThesaurus(TextQlt<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Removes the thesaurus (if assigned) from the given querylet.
replaceDataFile(int, String, List<String>, boolean, boolean) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Replaces the currently assigned data file with a compatible data file.
RESERVE - com.tibco.patterns.learn.api.project.DataPartition
  Reserve dataset - not used during model training.
RLink - Class in com.tibco.patterns.learn.rlink
  Performs communication with rlink_jni library using JNI to create, load, save, train and evaluate RLink models.
RLINK_THRESHOLD - Static variable in class com.tibco.patterns.learn.rlink.RLinkOut
  The threshold between "true" and "false" labels used to train models
RLink.SubsetTrainMode - Enum in com.tibco.patterns.learn.rlink
  Defines methods used to generate training examples for subsets of given training example
RLink.ThermometerType - Enum in com.tibco.patterns.learn.rlink
  Type of thermometers used in RLink model.
RLinkDataSet<T extends VectorExample> - Class in com.tibco.patterns.learn.training
  A container for storing a set of training examples suitable for model training.
RLinkDataSet(int) - Constructor for class com.tibco.patterns.learn.training.RLinkDataSet
  Creates empty dataset.
RLinkDataSet(int, int) - Constructor for class com.tibco.patterns.learn.training.RLinkDataSet
  Creates empty dataset.
RLinkExperiment<T extends VectorExample> - Class in com.tibco.patterns.learn.training
  Manages all data required for a model training experiment: training and validation datasets.
RLinkExperiment(RLinkDataSet<T>, double) - Constructor for class com.tibco.patterns.learn.training.RLinkExperiment
  Creates experiment with validation dataset randomly split from allExamples according to vldProportion.
RLinkExperiment(RLinkDataSet<T>, RLinkDataSet<T>) - Constructor for class com.tibco.patterns.learn.training.RLinkExperiment
  Creates the experiment that contains the two given datasets.
RLinkOut - Class in com.tibco.patterns.learn.rlink
  Stores the result of RLink model prediction.
RLinkOut(double, double) - Constructor for class com.tibco.patterns.learn.rlink.RLinkOut
  Creates object that stores the given score and confidence.
RLinkOut(double, double, double[]) - Constructor for class com.tibco.patterns.learn.rlink.RLinkOut
  Creates object that stores the given score, confidence and feature significance values.
RLinkServerInterface - Class in com.tibco.patterns.learn.recpair
  Provides more convenient communication with the Patterns server in situations that are frequently used in record pair scoring for Learn.
RLinkServerInterface(NetricsServerInterface) - Constructor for class com.tibco.patterns.learn.recpair.RLinkServerInterface
  Constructs RLinkServerInterface object that wraps the given object.

## S

safeDeleteModel() - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Deletes the model from server if it has been loaded.
save() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Saves project.xml and active model.xml files to the existing project location
saveAllRecPairsToCsv(Path) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Saves record pairs from all datasets to the CSV file.
saveAs(String, String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Saves project files to the new project location and/or project name.
saveDatasetToCsv(DataPartition, Path) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Saves record pairs from the specified dataset to the CSV file.
saveFeatureScoresToCsv(DataPartition, Path) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Saves the pairs that have feature scores from the specified dataset to the CSV file.
saveJavaCode(Path, String, String) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Saves Java source code for the stored feature query.
saveLowConfPairFinder(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Saves the state of the low confidence pair finder that was created before and used to find pairs.
saveModelCopy(String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Saves the active model, then saves its copy (creates model dir, model.xml and model.bin).
saveTrainedModel() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Saves trained model binary file to the active model directory.
saveXmlSearch(Path) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Exports all features to an XML file according to Patterns Search XML schema.
score() - Method in enum com.tibco.patterns.learn.api.project.RecPair.Label
scoreRecPair(RecPairId) - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Computes symmetric querylet scores for the pair of records defined by key0 and key1.
scoreRecPair(List<String>, List<String>) - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
  Computes symmetric querylet scores for the given pair of records.
searchForRecord(NetricsSearchCfg, NetricsSearchOpts) - Method in class com.tibco.patterns.learn.recpair.RLinkServerInterface
  Searches for a given record in a single table.
selfTest() - Static method in class com.tibco.patterns.learn.recpair.RecPairId
  Called from ProjectTest, RecPairTest.
serverThesName(String, String) - Static method in class com.tibco.patterns.learn.api.feature.TextQlt
  Returns the thesaurus name that is used on the server.
setAnnealingRate(int, double) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Sets the annealing rate (the speed of the learning rate decrease with each training iteration).
setCompareVldFirst(boolean) - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Sets a flag whether to compare the Validation or the Training error rates first.
setDataFile(String, List<String>, boolean, boolean) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Sets the data file info.
setDebugOutput(boolean) - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
setDebugOutput(boolean) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Sets the debug output.
setDistinctValues(int) - Method in class com.tibco.patterns.learn.api.project.FieldStats
setDynamic(int, double[], double[], double[], double[]) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Sets parameters for removal and insertion of scores to generate related training vectors when using SubsetTrainMode.DYNAMIC.
setEmptyFieldPenalty(double) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
  Sets empty field penalty.
setFeature(int, Feature<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Replaces the existing feature with the new one.
setField(int) - Method in class com.tibco.patterns.learn.api.feature.DateQlt
  Replaces the date field in the querylet.
setFieldIgnore(int, boolean) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Assigns the given Ignore value to a field with the given fieldIndex.
setFields(int[], double[]) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
  Replaces the list of fields in the querylet.
setFields(int[], double[]) - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
  Replaces the list of fields in the querylet.
setFields(int[], double[]) - Method in class com.tibco.patterns.learn.api.feature.TextQlt
  Replaces the list of fields in the querylet.
setFieldStats(int, int, FieldStats) - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
  Assigns the given field statistics to a field with the given fieldIndex.
setFieldType(int, int, float) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Assigns the given field type to a field with the given index.
setFieldWeight(int, double) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
setFieldWeight(int, double) - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
setFieldWeight(int, double) - Method in class com.tibco.patterns.learn.api.feature.TextQlt
  Sets the weight of the given field.
setFrequentValues(List<ValueFreq>) - Method in class com.tibco.patterns.learn.api.project.FieldStats
setGoodFitDistance(double) - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Sets the maximum distance that the training error rate can be above the validation error rate and the result is deemed a good fit, i.e.
setHeader(String, String, String, String, double) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Copy a model file, updating the header values.
setID(int, String) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Set the ID of the model.
setInitialConfThreshold(double) - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Sets the initial confidence limit of all returned pairs.
setKeyField(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Sets the index of the key field in the data file.
setLabel(RecPair.Label) - Method in class com.tibco.patterns.learn.api.project.RecPair
setMatchEmpty(boolean) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
setMatchEmpty(boolean) - Method in class com.tibco.patterns.learn.api.feature.DateQlt
  Sets the Match Empty parameter.
setMatchEmpty(boolean) - Method in class com.tibco.patterns.learn.api.feature.SimpleQlt
setMatchEmpty(boolean) - Method in class com.tibco.patterns.learn.api.feature.TextQlt
  Sets the Match Empty parameter.
setMaxConfTheshold(double) - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Sets the maximum confidence limit of all returned pairs.
setMaxIterations(int) - Method in class com.tibco.patterns.learn.training.COErrorRate
  Sets the maximum number of model training iterations to perform.
setMaxIterations(int) - Method in class com.tibco.patterns.learn.training.COIterationCount
  Sets the maximum number of model training iterations to perform.
setMetadata(int, String) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Sets the notes (meta-data) field for an existing model.
setMinIterations(int) - Method in class com.tibco.patterns.learn.training.COErrorRate
  Sets the minimum number of iterations to perform.
setMissingInfoLimit(int, double) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Sets the percentage of values that may be missing in a generated training example for a subset.
setModelConfig(ModelConfig) - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Copies settings from mConfig to the XML structure (modelConfig node).
setModelScoreThreshold(double) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Sets the prediction score threshold of the trained model.
setModelTrainConfig(ModelTrainConfig) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Remembers the ModelTrainConfig reference (can be further modified from outside).
setName(String) - Method in class com.tibco.patterns.learn.api.feature.Feature
  Sets the name of this feature.
setNIterAfterMin(int) - Method in class com.tibco.patterns.learn.training.COErrorRateMin
  Sets the number of iterations to explore after the best iteration.
setNonCognateWeight(double) - Method in class com.tibco.patterns.learn.api.feature.CognateQlt
  Sets non-cognate weight applied when a value is entered in a wrong field.
setNonEmptyRows(float) - Method in class com.tibco.patterns.learn.api.project.FieldStats
setNote(String) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
setNote(String) - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
setPartition(DataPartition) - Method in class com.tibco.patterns.learn.api.project.RecPair
  Sets the data partition.
setPredicate(String) - Method in class com.tibco.patterns.learn.api.feature.PredicateQlt
  Sets the predicate expression.
setPredictOptions(PredictOptions) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Sets options to be used for all subsequent model predictions using this ModelTrainer.
setPredictOptions(PredictOptions) - Method in class com.tibco.patterns.learn.training.Trainer
  Sets options to be used for all model predictions.
setPrint(boolean) - Method in class com.tibco.patterns.learn.training.COScoreChange
  Enables printing of iteration results to console.
setPrintOptions(int, Partition, boolean) - Method in class com.tibco.patterns.learn.training.COErrorRate
  Enables printing of the iteration results, sets console printing options, prints header.
setRandomSeed(long) - Method in class com.tibco.patterns.learn.training.Trainer
  Sets the random seed to be used for randomizing the order of examples.
setRecPairLabel(DataPartition, int, RecPair.Label) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Sets the label of an existing record pair with the given index in specified dataset.
setRecPairLabel(RecPairId, RecPair.Label) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Sets the label of an existing record pair with the given keys (in any dataset).
setRecPairReview(DataPartition, int, boolean) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Sets review attribute of an existing record pair with the given index in specified dataset.
setRecPairReview(RecPairId, boolean) - Method in class com.tibco.patterns.learn.api.project.ModelSettings
  Sets review attribute of an existing record pair with the given keys (in any dataset).
setReview(boolean) - Method in class com.tibco.patterns.learn.api.project.RecPair
  Sets the Review property (whether the pair needs to be reviewed).
setSavedPairs(List<RecPair>) - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Recalculates model predictions for the saved pairs using the current model and remembers the pairs with confidence that is still below the current confidence threshold.
setSubsetTrainMode(int, RLink.SubsetTrainMode) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Set the subset training mode to an existing model.
setTable(String) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Sets the name of the table that already exists on the server.
setTableDef() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Sets the table definition for pair scoring.
setTaper(int, double, double) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Set parameters for the tapering function that generates examples for subsets.
setThesaurus(Thesaurus, double, Feature<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Sets (or replaces) thesaurus in the given feature and adds it to the list of thesauri used by this feature query (if not yet present).
setThesaurus(Thesaurus, double, TextQlt<?>) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Sets (or replaces) thesaurus in the given querylet and adds it to the list of thesauri used by this feature query (if not yet present).
setThesPrefix(String) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  Assigns the given identifier (UUID) that is used in all thesauri names on the server.
setThreshold(int, double) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Set the cutoff threshold for the model.
setTrainConfig(Boolean, Map<Partition, ConvergenceObserver>) - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
  Copies settings from observers to the XML structure (trainConfig node).
setVersion(int, String) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Set the version ID of the model.
SimpleQlt - Class in com.tibco.patterns.learn.api.feature
  A Simple querylet for matching one field or concatenated string values of several fields.
SimpleQlt(int[], double[], List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.SimpleQlt
  Creates simple querylet with given parameters.
SimpleQlt(int[], List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.SimpleQlt
  Default field weights 1.0 are used.
SimpleQlt(int, List<String>) - Constructor for class com.tibco.patterns.learn.api.feature.SimpleQlt
  A single field with default field weight is used.
size() - Method in class com.tibco.patterns.learn.api.hint.HintAddPairs
size() - Method in class com.tibco.patterns.learn.api.hint.HintReviewPairs
size() - Method in class com.tibco.patterns.learn.training.RLinkDataSet
size(DataPartition) - Method in class com.tibco.patterns.learn.api.project.RecPairMap
SMALL - com.tibco.patterns.learn.rlink.RLink.ThermometerType
  Small thermometer - slower learning, faster predictions.
STAll - Class in com.tibco.patterns.learn.modelconfig
  Specifies training of all subsets with generated examples.
STAll() - Constructor for class com.tibco.patterns.learn.modelconfig.STAll
  Creates a configuration to train all subsets.
STDynamic - Class in com.tibco.patterns.learn.modelconfig
  Specifies dynamic training of subsets.
STDynamic() - Constructor for class com.tibco.patterns.learn.modelconfig.STDynamic
  Creates a Dynamic subset training configuration with default parameters.
STDynamic(double[], double[], double[], double[]) - Constructor for class com.tibco.patterns.learn.modelconfig.STDynamic
  Creates a Dynamic subset training configuration with specified parameters.
STDynamic(int, double, double, double, double) - Constructor for class com.tibco.patterns.learn.modelconfig.STDynamic
  Creates a Dynamic subset training configuration using the same value for each of the parameter arrays.
STFixed - Class in com.tibco.patterns.learn.modelconfig
  Specifies training up to a fixed depth of subsets, defined by percentage of missing information in the subset.
STFixed() - Constructor for class com.tibco.patterns.learn.modelconfig.STFixed
  Creates a new fixed depth subset training configuration with default parameters.
STFixed(double) - Constructor for class com.tibco.patterns.learn.modelconfig.STFixed
  Creates a new fixed depth subset training configuration with custom parameters.
STNone - Class in com.tibco.patterns.learn.modelconfig
  Specifies training with actual examples only, without any generated examples for submodels.
STNone() - Constructor for class com.tibco.patterns.learn.modelconfig.STNone
  Creates a configuration to train with actual examples only.
STTaper - Class in com.tibco.patterns.learn.modelconfig
  Specifies the use of a random tapering function to generate some examples for subsets.
STTaper() - Constructor for class com.tibco.patterns.learn.modelconfig.STTaper
  Creates a new subset training configuration that uses a tapering function with default parameters.
STTaper(double, double) - Constructor for class com.tibco.patterns.learn.modelconfig.STTaper
  Creates a new subset training configuration that uses a tapering function with custom parameters.
SubsetFamily - Class in com.tibco.patterns.learn.api.hint
  Stores a family (a set) of RLink subsets.
SubsetFamily(FeatureQuery) - Constructor for class com.tibco.patterns.learn.api.hint.SubsetFamily
SubsetLabelPairMap - Class in com.tibco.patterns.learn.api.hint
  Stores a family (a set) of RLink subsets.
SubsetLabelPairMap(FeatureQuery) - Constructor for class com.tibco.patterns.learn.api.hint.SubsetLabelPairMap
SubsetLabelPairMap(FeatureQuery, List<RecPair>) - Constructor for class com.tibco.patterns.learn.api.hint.SubsetLabelPairMap
  Adds all given pairs to the new SubsetLabelPairMap.
subsets - Variable in class com.tibco.patterns.learn.api.hint.HintAddPairs
subsetTrain(SubsetTrainConfig) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the subset training configuration.
SubsetTrainConfig - Class in com.tibco.patterns.learn.modelconfig
  Defines configuration parameters for one of the subset training modes.
SUBSTITUTION - com.tibco.patterns.learn.api.feature.Thesaurus.Type
  Substitution (simple) thesaurus.
suggestInitialConfThreshold(double) - Method in class com.tibco.patterns.learn.api.autopair.LowConfPairFinder
  Sets the initial confidence threshold after restricting it within valid limits.
suitableRecord(List<Boolean>, List<String>) - Method in class com.tibco.patterns.learn.api.hint.HintAddPairs
  Filters a record in a data table.
switchActiveModel(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Saves the currently active model, then loads another model from file, makes it active, saves the new active model index.

## T

tableExists(String) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
tableIsCompatible(String) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Checks if the table on server has field names and types that match ModelSettings.
TAPER - com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Use a random tapering function to generate some examples for subsets
tblExists(String) - Method in class com.tibco.patterns.learn.recpair.RLinkServerInterface
  Checks if a table exists on the server.
tblSafeDelete(String) - Method in class com.tibco.patterns.learn.recpair.RLinkServerInterface
  Deletes a table if it exists on the server, otherwise does nothing.
TEST - com.tibco.patterns.learn.api.project.DataPartition
  Test dataset - currently not used.
TextQlt<T extends com.tibco.patterns.learn.jaxb.model.SearchQueryBaseType> - Class in com.tibco.patterns.learn.api.feature
  Provides common functionality for querylets that use approximate text matching (Simple and Cognate querylets).
ThermoCsvDump - Class in com.tibco.patterns.learn.rlink
  Dumps thermometers to CSV files
ThermoCsvDump() - Constructor for class com.tibco.patterns.learn.rlink.ThermoCsvDump
Thesaurus - Class in com.tibco.patterns.learn.api.feature
  Represents thesaurus file that can be used in multiple querylets.
Thesaurus(String) - Constructor for class com.tibco.patterns.learn.api.feature.Thesaurus
  Creates Thesaurus using the default thesaurus type SUBSTITUTION.
Thesaurus(String, Thesaurus.Type) - Constructor for class com.tibco.patterns.learn.api.feature.Thesaurus
  Creates Thesaurus with the given name and type.
Thesaurus.Type - Enum in com.tibco.patterns.learn.api.feature
  The type of a thesaurus file.
thesFileExists(String) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
toBool() - Method in enum com.tibco.patterns.learn.api.project.RecPair.Label
toString() - Method in class com.tibco.patterns.learn.api.feature.AbstractQlt
toString() - Method in class com.tibco.patterns.learn.api.feature.Feature
toString() - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
toString() - Method in class com.tibco.patterns.learn.api.feature.Thesaurus
toString() - Method in class com.tibco.patterns.learn.api.hint.DatasetStats
toString() - Method in class com.tibco.patterns.learn.api.hint.HintAddPairs
toString() - Method in class com.tibco.patterns.learn.api.hint.HintReviewPairs
toString() - Method in class com.tibco.patterns.learn.api.hint.SubsetFamily
toString() - Method in class com.tibco.patterns.learn.api.hint.SubsetLabelPairMap
toString() - Method in class com.tibco.patterns.learn.api.project.AddPairsResult
toString() - Method in class com.tibco.patterns.learn.api.project.DatasetResult
toString() - Method in class com.tibco.patterns.learn.api.project.FieldStats
toString() - Method in class com.tibco.patterns.learn.api.project.ModelSettings
toString() - Method in class com.tibco.patterns.learn.api.project.ModelTrainConfig
toString() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
toString() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
toString() - Method in class com.tibco.patterns.learn.api.project.ProjectSettings
toString() - Method in class com.tibco.patterns.learn.api.project.RecPair
toString() - Method in class com.tibco.patterns.learn.api.project.RecPairMap
toString() - Method in class com.tibco.patterns.learn.api.project.ValueFreq
toString() - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
toString() - Method in class com.tibco.patterns.learn.modelconfig.STFixed
toString() - Method in class com.tibco.patterns.learn.modelconfig.STTaper
toString() - Method in class com.tibco.patterns.learn.modelconfig.SubsetTrainConfig
toString() - Method in class com.tibco.patterns.learn.recpair.RecPairExample
toString() - Method in class com.tibco.patterns.learn.recpair.RecPairId
toString() - Method in class com.tibco.patterns.learn.recpair.RecPairScorer
toString() - Method in class com.tibco.patterns.learn.rlink.ConfFeature
toString() - Method in class com.tibco.patterns.learn.rlink.ConfRatio
toString() - Method in class com.tibco.patterns.learn.rlink.ConfRatioLabel
toString() - Method in class com.tibco.patterns.learn.rlink.ConfStats
toString() - Method in class com.tibco.patterns.learn.rlink.PredictOptions
toString() - Method in class com.tibco.patterns.learn.rlink.RLinkOut
toString() - Method in class com.tibco.patterns.learn.training.COErrorRate
toString() - Method in class com.tibco.patterns.learn.training.COErrorRateMin
toString() - Method in class com.tibco.patterns.learn.training.COIterationCount
toString() - Method in class com.tibco.patterns.learn.training.COScoreChange
toString() - Method in class com.tibco.patterns.learn.training.FeatureVector
toString() - Method in class com.tibco.patterns.learn.training.RLinkDataSet
toString() - Method in class com.tibco.patterns.learn.training.VectorExample
TRAIN - com.tibco.patterns.learn.api.project.DataPartition
  Training dataset - used to train the model.
TRAIN - com.tibco.patterns.learn.training.Partition
  Training dataset
Trainer - Class in com.tibco.patterns.learn.training
  Implements automated training for a single RLink model.
Trainer(int) - Constructor for class com.tibco.patterns.learn.training.Trainer
  Creates a Trainer to train one existing model.
Trainer(int, boolean) - Constructor for class com.tibco.patterns.learn.training.Trainer
  Creates a Trainer to train one existing model.
TrainingObserver - Interface in com.tibco.patterns.learn.training
  Defines an object that gathers training statistics for a certain dataset.
trainIteration() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Performs a single training iteration.
trainIteration(RLinkExperiment<? extends VectorExample>, TrainingObserver, ConvergenceObserver) - Method in class com.tibco.patterns.learn.training.Trainer
  Runs a single training iteration.
trainSet - Variable in class com.tibco.patterns.learn.training.RLinkExperiment
  Training dataset
trainToConverge(ConvergenceObserver, ConvergenceObserver) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Trains the model using the model configuration from modelTrainConfig.xml file, or the default configuration if that file is not in the project directory.
trainToConverge(ConvergenceObserver, ConvergenceObserver, ModelConfig) - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Creates and trains model with the prepared experiment data until stopping criteria are satisfied.
trainToConverge(RLinkDataSet<? extends VectorExample>, ConvergenceObserver) - Method in class com.tibco.patterns.learn.training.Trainer
  Uses the same set of examples for both training and validation.
trainToConverge(RLinkExperiment<? extends VectorExample>, ConvergenceObserver) - Method in class com.tibco.patterns.learn.training.Trainer
  Trains the model until training termination criteria over the validation dataset (as specified in vldCO) are satisfied.
trainToConverge(RLinkExperiment<? extends VectorExample>, TrainingObserver, ConvergenceObserver) - Method in class com.tibco.patterns.learn.training.Trainer
  Trains the model until training termination criteria over the validation dataset (as specified in vldCO) are satisfied, or until the model correctly predicts all examples in the training dataset.
TRUE - com.tibco.patterns.learn.api.project.RecPair.Label
  A True label - records match.
typeName() - Method in enum com.tibco.patterns.learn.api.feature.Thesaurus.Type
typeNames() - Static method in enum com.tibco.patterns.learn.api.feature.Thesaurus.Type

## U

UNSURE - com.tibco.patterns.learn.api.project.RecPair.Label
  An Unsure label - user was not sure whether the records match.
update(RecPair) - Method in class com.tibco.patterns.learn.api.hint.DatasetStats
  Updates statistics with the info about the pair that has been added to this dataset.
updateDataFileLastModified(int) - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Updates the stored last modified date of the data file.
updatePairsFromTable() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Updates field data in pairs from the (modified) data table.
upgradeXmlVersion(int) - Method in class com.tibco.patterns.learn.api.feature.FeatureQuery
  v.4: build list of thesauri with default thesaurus type using all thesauri in querylets.
USE_DFT_BLUR_REGION_WIDTH - Static variable in class com.tibco.patterns.learn.rlink.ConfFeature
  Special value to indicate that the server must use default blur region width.
usedValues() - Static method in enum com.tibco.patterns.learn.api.project.DataPartition
  Lists partitions that are used in model training.
useInQuery(NetricsQuery) - Method in class com.tibco.patterns.learn.modelconfig.ConfQFeature
  Configures the given query to use the feature confidence with its parameters.
useInQuery(NetricsQuery) - Method in class com.tibco.patterns.learn.modelconfig.ConfQNone
  Configures the given query to use no confidence measure.
useInQuery(NetricsQuery) - Method in interface com.tibco.patterns.learn.modelconfig.ConfQuery
  Configures the given query to use the confidence measure and its parameters represented by this object.
useSubsets(boolean) - Method in class com.tibco.patterns.learn.modelconfig.ModelConfig
  Sets the model to take subsets into account (default), or to not use subsets and support more features.

## V

ValueFreq - Class in com.tibco.patterns.learn.api.project
  Stores one field value and its frequency.
ValueFreq(ValueFreqType) - Constructor for class com.tibco.patterns.learn.api.project.ValueFreq
  Copies data from XML ValueFreqType.
ValueFreq(String, float) - Constructor for class com.tibco.patterns.learn.api.project.ValueFreq
valueOf(String) - Static method in enum com.tibco.patterns.learn.api.feature.Thesaurus.Type
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tibco.patterns.learn.api.project.DataPartition
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tibco.patterns.learn.rlink.RLink.ThermometerType
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tibco.patterns.learn.training.Partition
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.tibco.patterns.learn.api.feature.Thesaurus.Type
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tibco.patterns.learn.api.project.DataPartition
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tibco.patterns.learn.api.project.RecPair.Label
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tibco.patterns.learn.rlink.RLink.SubsetTrainMode
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tibco.patterns.learn.rlink.RLink.ThermometerType
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tibco.patterns.learn.training.Partition
  Returns an array containing the constants of this enum type, in the order they are declared.
VectorExample - Class in com.tibco.patterns.learn.training
  Stores a feature vector and a label that are used for training the model.
VectorExample(double[], boolean) - Constructor for class com.tibco.patterns.learn.training.VectorExample
  Creates example with given parameters and no prediction.
VectorExperiment - Class in com.tibco.patterns.learn.training
  Manages a training dataset and a validation dataset.
VectorExperiment(int, double) - Constructor for class com.tibco.patterns.learn.training.VectorExperiment
  Creates an experiment with two empty datasets and a new random number generator.
VectorExperiment(int, double, Random) - Constructor for class com.tibco.patterns.learn.training.VectorExperiment
  Creates an experiment with two empty datasets.
VectorSet - Class in com.tibco.patterns.learn.training
  A container for storing a set of VectorExample training examples.
VectorSet(int) - Constructor for class com.tibco.patterns.learn.training.VectorSet
  Creates empty dataset.
VectorSet(int, int) - Constructor for class com.tibco.patterns.learn.training.VectorSet
  Creates empty dataset.
verifyCanSetDataFile() - Method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Verifies that a data file can be assigned or replaced.
verifyDatasetProportion(double) - Static method in class com.tibco.patterns.learn.training.RLinkDataSet
  Verifies the proportion of validation dataset as a percentage of all examples.
verifyDir(String, String) - Static method in class com.tibco.patterns.learn.api.project.ProjectFiles
  Verifies that the structure of files and directories of the given project is correct without loading the entire project.
verifyHasModel() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
verifyIterationBegun() - Method in class com.tibco.patterns.learn.training.COIterationCount
  Use from methods that process incoming predictions to ensure that iteration has begun.
verifyIterationEnded() - Method in class com.tibco.patterns.learn.training.COIterationCount
  Use from methods that return iteration results to ensure that iteration has ended.
verifyMissingInfoLimit(double) - Static method in class com.tibco.patterns.learn.rlink.RLink
verifyModelId(int) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Verifies that the model with the given modelId actually exists.
verifyServerTableLoaded() - Method in class com.tibco.patterns.learn.api.project.ModelTrainer
  Verifies that the server table (not a table definition) was assigned, and that this table currently exists on the server.
verifyTaper(double, double) - Static method in class com.tibco.patterns.learn.rlink.RLink
VLD - com.tibco.patterns.learn.api.project.DataPartition
  Validation dataset - used to evaluate model performance during training.
VLD - com.tibco.patterns.learn.training.Partition
  Validation dataset
vldSet - Variable in class com.tibco.patterns.learn.training.RLinkExperiment
  Validation dataset

## W

WEIGHTED_TERM - com.tibco.patterns.learn.api.feature.Thesaurus.Type
  Weighted term dictionary.
write(int, String) - Static method in class com.tibco.patterns.learn.rlink.RLink
  Saves the existing model to file.

A B C D E F G H I L M N O P Q R S T U V W
All Classes All Packages