Class StackingClassifier<T>

Namespace

AiDotNet.Classification.Meta

Assembly

AiDotNet.dll

Stacking classifier that uses predictions from base classifiers as features for a meta-classifier.

public class StackingClassifier<T> : MetaClassifierBase<T>, IProbabilisticClassifier<T>, IClassifier<T>, IFullModel<T, Matrix<T>, Vector<T>>, IModel<Matrix<T>, Vector<T>, ModelMetadata<T>>, IModelSerializer, ICheckpointableModel, IParameterizable<T, Matrix<T>, Vector<T>>, IFeatureAware, IFeatureImportance<T>, ICloneable<IFullModel<T, Matrix<T>, Vector<T>>>, IGradientComputable<T, Matrix<T>, Vector<T>>, IJitCompilable<T>

Type Parameters

T

The numeric data type used for calculations.

Inheritance

object

ClassifierBase<T>

ProbabilisticClassifierBase<T>

MetaClassifierBase<T>

StackingClassifier<T>

Implements

IProbabilisticClassifier<T>

IClassifier<T>

IFullModel<T, Matrix<T>, Vector<T>>

IModel<Matrix<T>, Vector<T>, ModelMetadata<T>>

IModelSerializer

ICheckpointableModel

IParameterizable<T, Matrix<T>, Vector<T>>

IFeatureAware

IFeatureImportance<T>

ICloneable<IFullModel<T, Matrix<T>, Vector<T>>>

IGradientComputable<T, Matrix<T>, Vector<T>>

IJitCompilable<T>

Inherited Members

MetaClassifierBase<T>.EstimatorFactory

MetaClassifierBase<T>.CreateBaseEstimator()

MetaClassifierBase<T>.GetParameters()

MetaClassifierBase<T>.SetParameters(Vector<T>)

MetaClassifierBase<T>.WithParameters(Vector<T>)

MetaClassifierBase<T>.ComputeGradients(Matrix<T>, Vector<T>, ILossFunction<T>)

MetaClassifierBase<T>.ApplyGradients(Vector<T>, T)

ProbabilisticClassifierBase<T>.ApplySoftmax(Matrix<T>)

ProbabilisticClassifierBase<T>.ApplySigmoid(Vector<T>)

ClassifierBase<T>.NumOps

ClassifierBase<T>.Engine

ClassifierBase<T>.Regularization

ClassifierBase<T>.NumClasses

ClassifierBase<T>.TaskType

ClassifierBase<T>.ClassLabels

ClassifierBase<T>.NumFeatures

ClassifierBase<T>.FeatureNames

ClassifierBase<T>.ExpectedParameterCount

ClassifierBase<T>.InferTaskType(Vector<T>)

ClassifierBase<T>.ExtractClassLabels(Vector<T>)

ClassifierBase<T>.ComputeClassWeights(Vector<T>)

ClassifierBase<T>.GetClassIndexFromLabel(T)

ClassifierBase<T>.Serialize()

ClassifierBase<T>.Deserialize(byte[])

ClassifierBase<T>.GetActiveFeatureIndices()

ClassifierBase<T>.IsFeatureUsed(int)

ClassifierBase<T>.SetActiveFeatureIndices(IEnumerable<int>)

ClassifierBase<T>.GetFeatureImportance()

ClassifierBase<T>.DeepCopy()

ClassifierBase<T>.ParameterCount

ClassifierBase<T>.DefaultLossFunction

ClassifierBase<T>.SaveModel(string)

ClassifierBase<T>.LoadModel(string)

ClassifierBase<T>.SaveState(Stream)

ClassifierBase<T>.LoadState(Stream)

ClassifierBase<T>.SupportsJitCompilation

ClassifierBase<T>.ExportComputationGraph(List<ComputationNode<T>>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DistributedExtensions.AsDistributedForHighBandwidth<T, TInput, TOutput>(IFullModel<T, TInput, TOutput>, ICommunicationBackend<T>)

DistributedExtensions.AsDistributedForLowBandwidth<T, TInput, TOutput>(IFullModel<T, TInput, TOutput>, ICommunicationBackend<T>)

DistributedExtensions.AsDistributed<T, TInput, TOutput>(IFullModel<T, TInput, TOutput>, ICommunicationBackend<T>)

DistributedExtensions.AsDistributed<T, TInput, TOutput>(IFullModel<T, TInput, TOutput>, IShardingConfiguration<T>)

Remarks

Stacking trains multiple base classifiers and then uses their predictions as features to train a final meta-classifier.

For Beginners: Stacking is a sophisticated ensemble method:

1. Train multiple base classifiers
2. Get predictions from each on training data (using cross-validation)
3. Use these predictions as features for a "meta" classifier
4. Train the meta-classifier on these stacked predictions

For prediction:

1. Get predictions from all base classifiers
2. Stack them as features
3. Feed to meta-classifier for final prediction

Benefits:

• Can combine very different types of classifiers
• Often achieves better accuracy than individual classifiers
• The meta-classifier learns which base classifiers to trust

Considerations:

• More complex to implement
• Risk of overfitting if not using cross-validation
• Computationally expensive

Constructors

StackingClassifier(IEnumerable<IClassifier<T>>, Func<IClassifier<T>>, StackingClassifierOptions<T>?, IRegularization<T, Matrix<T>, Vector<T>>?)

Initializes a new instance of the StackingClassifier class.

public StackingClassifier(IEnumerable<IClassifier<T>> estimators, Func<IClassifier<T>> finalEstimator, StackingClassifierOptions<T>? options = null, IRegularization<T, Matrix<T>, Vector<T>>? regularization = null)

Parameters

estimators IEnumerable<IClassifier<T>>

List of base classifiers.

finalEstimator Func<IClassifier<T>>

The meta-classifier for final predictions.

options StackingClassifierOptions<T>

Configuration options for the classifier.

regularization IRegularization<T, Matrix<T>, Vector<T>>

Optional regularization strategy.

Properties

Options

Gets the stacking-specific options.

protected StackingClassifierOptions<T> Options { get; }

Property Value

StackingClassifierOptions<T>

Methods

Clone()

Creates a clone of the classifier model.

public override IFullModel<T, Matrix<T>, Vector<T>> Clone()

Returns

IFullModel<T, Matrix<T>, Vector<T>>

A new instance of the model with the same parameters and options.

CreateNewInstance()

Creates a new instance of the same type as this classifier.

protected override IFullModel<T, Matrix<T>, Vector<T>> CreateNewInstance()

Returns

IFullModel<T, Matrix<T>, Vector<T>>

A new instance of the same classifier type.

GetModelMetadata()

Gets metadata about the model.

public override ModelMetadata<T> GetModelMetadata()

Returns

ModelMetadata<T>

A ModelMetadata object containing information about the model.

Remarks

This method returns metadata about the model, including its type, feature count, complexity, description, and additional information specific to classification.

For Beginners: Model metadata provides information about the model itself, rather than the predictions it makes. This includes details about the model's structure (like how many features it uses) and characteristics (like how many classes it can predict). This information can be useful for understanding and comparing different models.

GetModelType()

Returns the model type identifier for this classifier.

protected override ModelType GetModelType()

Returns

ModelType

Predict(Matrix<T>)

Predicts class labels for the given input data by taking the argmax of probabilities.

public override Vector<T> Predict(Matrix<T> input)

Parameters

input Matrix<T>

The input features matrix where each row is an example and each column is a feature.

Returns

Vector<T>

A vector of predicted class indices for each input example.

Remarks

This implementation uses the argmax of the probability distribution to determine the predicted class. For binary classification with a custom decision threshold, you may want to use PredictProbabilities() directly and apply your own threshold.

For Beginners: This method picks the class with the highest probability for each sample.

For example, if the probabilities are [0.1, 0.7, 0.2] for classes [A, B, C], this method returns class B (index 1) because it has the highest probability (0.7).

PredictLogProbabilities(Matrix<T>)

Predicts log-probabilities for each class.

public override Matrix<T> PredictLogProbabilities(Matrix<T> input)

Parameters

input Matrix<T>

The input features matrix where each row is a sample and each column is a feature.

Returns

Matrix<T>

A matrix where each row corresponds to an input sample and each column corresponds to a class. The values are the natural logarithm of the class probabilities.

Remarks

The default implementation computes log(PredictProbabilities(input)). Subclasses that compute log-probabilities directly (like Naive Bayes) should override this method for better numerical stability.

For Beginners: Log-probabilities are probabilities transformed by the natural logarithm. They're useful for numerical stability when working with very small probabilities.

For example:

• Probability 0.9 → Log-probability -0.105
• Probability 0.1 → Log-probability -2.303
• Probability 0.001 → Log-probability -6.908

Log-probabilities are always negative (since probabilities are between 0 and 1). Higher (less negative) values mean higher probability.

PredictProbabilities(Matrix<T>)

Predicts class probabilities for each sample in the input.

public override Matrix<T> PredictProbabilities(Matrix<T> input)

Parameters

input Matrix<T>

The input features matrix where each row is a sample and each column is a feature.

Returns

Matrix<T>

A matrix where each row corresponds to an input sample and each column corresponds to a class. The values represent the probability of the sample belonging to each class.

Remarks

This abstract method must be implemented by derived classes to compute class probabilities. The output matrix should have shape [num_samples, num_classes], and each row should sum to 1.0.

For Beginners: This method computes the probability of each sample belonging to each class. Each row in the output represents one sample, and each column represents one class. The values in each row sum to 1.0 (100% total probability).

Train(Matrix<T>, Vector<T>)

Trains the stacking classifier.

public override void Train(Matrix<T> x, Vector<T> y)

Parameters

x Matrix<T>

y Vector<T>