Click or drag to resize

CategoricalEntailmentEnsembleClassifierAddTrained Method

Adds a number of new categorical entailments by training them together with the entailments currently included in this instance. Training happens on the specified features and response categorical variables in a given data set.

Namespace:  Novacta.Analytics
Assembly:  Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0
Syntax
public void AddTrained(
	CategoricalDataSet dataSet,
	IndexCollection featureVariableIndexes,
	int responseVariableIndex,
	int numberOfTrainedCategoricalEntailments,
	bool allowEntailmentPartialTruthValues,
	bool trainSequentially
)

Parameters

dataSet
Type: Novacta.AnalyticsCategoricalDataSet
The categorical data set containing information about the available feature and response variables.
featureVariableIndexes
Type: Novacta.AnalyticsIndexCollection
The zero-based indexes of the columns in dataSet containing observations about the feature variables on which premises must be defined.
responseVariableIndex
Type: SystemInt32
The zero-based index of the column in dataSet containing observations about the response variable.
numberOfTrainedCategoricalEntailments
Type: SystemInt32
The number of categorical entailments to be trained.
allowEntailmentPartialTruthValues
Type: SystemBoolean
If set to true signals that the truth value of a categorical entailment must be equal to the homogeneity of the probability distribution from which its conclusion has been drawn. Otherwise, the truth value is unity.
trainSequentially
Type: SystemBoolean
If set to true signals that the ensemble is trained sequentially, i.e. it starts as an empty collection, and new categorical entailments are added through a step-by-step procedure to the trained ensemble, by selecting, at each step, the entailment that better improves the system's performance of the current ensemble. Otherwise, the categorical entailments are trained simultaneously.

Return Value

Type: 
The instance of the CategoricalEntailmentEnsembleClassifier class based on the trained ensemble of categorical entailments.
Exceptions
ExceptionCondition
ArgumentNullExceptiondataSet is null.
-or-
featureVariableIndexes is null.
ArgumentOutOfRangeExceptionnumberOfTrainedCategoricalEntailments is not positive.
-or-
featureVariableIndexes contains values which are not valid column indexes for the Data of dataSet.
-or-
responseVariableIndex is not a valid column index for the Data of dataSet.
ArgumentExceptionfeatureVariableIndexes has not the same Count of the FeatureVariables of this instance.
Remarks

The entailments to be trained are added to the Entailments to optimally enlarge such collection by the specified numberOfTrainedCategoricalEntailments.

it is expected that featureVariableIndexes has the same count of the FeatureVariables of this instance, and that the LaTeX equation-th position of featureVariableIndexes is the index of the column that, in dataSet, contains observations about the LaTeX equation-th feature variable of the classifier. Furthermore, responseVariableIndex must be the index of the column where, in dataSet, are stored observations about the ResponseVariable of this instance.

See Also