Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET

  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Blog
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference
  • Extreme Optimization
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Nuget packages
    • Configuration
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Data Access Library User's Guide
    • Reference
  • Reference
    • Extreme
    • Extreme.Collections
    • Extreme.Data
    • Extreme.Data.Json
    • Extreme.Data.Matlab
    • Extreme.Data.R
    • Extreme.Data.Stata
    • Extreme.Data.Text
    • Extreme.DataAnalysis
    • Extreme.DataAnalysis.Linq
    • Extreme.DataAnalysis.Models
    • Extreme.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Providers
    • Extreme.Providers.InteropServices
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.DataAnalysis.Models
    • ClassificationModel(T) Class
    • ClusteringModel(T) Class
    • ITransformationModel Interface
    • Model Class
    • ModelExtensions Class
    • ModelFitOptions Class
    • ModelInput Class
    • ModelInputCategory Enumeration
    • ModelInputFormat Enumeration
    • ModelInputGroup Class
    • ModelSerialization Enumeration
    • ModelStatus Enumeration
    • ModelTerm Class
    • ModelTermCollection Class
    • ModelTermKind Enumeration
    • RegressionModel(T) Class
    • TransformationModel(T) Class
  • ClassificationModel(T) Class
    • ClassificationModel(T) Constructor
    • Properties
    • Methods

ClassificationModelT Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents a statistical model used for classification.
Inheritance Hierarchy

SystemObject
  Extreme.DataAnalysis.ModelsModel
    Extreme.DataAnalysis.ModelsClassificationModelT
      Extreme.StatisticsLogisticRegressionModel
      Extreme.Statistics.MultivariateLinearDiscriminantAnalysis

Namespace:  Extreme.DataAnalysis.Models
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax

C#
VB
C++
F#
Copy
public abstract class ClassificationModel<T> : Model
Public MustInherit Class ClassificationModel(Of T)
	Inherits Model
generic<typename T>
public ref class ClassificationModel abstract : public Model
[<AbstractClassAttribute>]
type ClassificationModel<'T> =  
    class
        inherit Model
    end

Type Parameters

T

The ClassificationModelT type exposes the following members.

Constructors

  NameDescription
Protected methodClassificationModelT
Constructs a new classification model based on a model specification.
Top
Properties

  NameDescription
Public propertyBaseFeatureIndex
Gets an index containing the keys of the columns that are required inputs to the model.
(Inherited from Model.)
Public propertyCanPredictProbabilities
Gets whether the classifier supports predicting probabilities for each class.
Public propertyCategoryIndex
Gets the category index of the dependent variable or targets.
Public propertyComputed Obsolete.
Gets whether the model has been computed.
(Inherited from Model.)
Public propertyData
Gets an object that contains all the data used as input to the model.
(Inherited from Model.)
Public propertyDependentVariable
Gets a vector that contains the dependent variable that is to be fitted.
Public propertyFitted
Gets whether the model has been computed.
(Inherited from Model.)
Public propertyIndependentVariables
Gets a matrix whose columns contain the independent variables in the model.
Public propertyInputSchema
Gets the schema for the features used for fitting the model.
(Inherited from Model.)
Public propertyMaxDegreeOfParallelism
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from Model.)
Public propertyModelSchema
Gets the collection of variables used in the model.
(Inherited from Model.)
Public propertyNumberOfObservations
Gets the number of observations the model is based on.
(Inherited from Model.)
Protected propertyParallelOptions
Gets or sets an object that specifies how the calculation of the model should be parallelized.
(Inherited from Model.)
Public propertyPredictedLogProbabilities
Gets a vector containing the model's predicted values for the dependent variable.
Public propertyPredictedProbabilities
Gets a vector containing the model's predicted values for the dependent variable.
Public propertyPredictions
Gets a vector containing the model's predicted values for the dependent variable.
Public propertyProbabilityResiduals
Gets a matrix containing the residuals of the model.
Public propertyStatus
Gets the status of the model, which determines which information is available.
(Inherited from Model.)
Public propertySupportsWeights
Indicates whether the model supports case weights.
(Inherited from Model.)
Public propertyWeights
Gets or sets the actual weights.
(Inherited from Model.)
Top
Methods

  NameDescription
Public methodCompute Obsolete.
Computes the model.
(Inherited from Model.)
Public methodCompute(ParallelOptions) Obsolete.
Computes the model.
(Inherited from Model.)
Public methodContains
Returns whether another ClassificationModelT is nested within this instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFit
Fits the model to the data.
(Inherited from Model.)
Public methodFit(ParallelOptions)
Fits the model to the data.
(Inherited from Model.)
Protected methodFitCore
Computes the model to the specified input using the specified parallelization options.
(Inherited from Model.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPredict(IDataFrame, ModelInputFormat)
Predicts the most likely class based on the specified features.
Public methodPredict(MatrixT, ModelInputFormat)
Predicts the value of the output corresponding to the specified features.
Public methodPredict(VectorT, ModelInputFormat)
Predicts the value of the output corresponding to the specified input.
Protected methodPredictCore(MatrixT, Boolean)
Predicts the value of the dependent variable based on the specified values of the features.
Protected methodPredictCore(VectorT, Boolean)
Predicts the class based on the specified values of the features.
Public methodPredictProbabilities(IDataFrame, ModelInputFormat)
Predicts the value of the output corresponding to the specified input.
Public methodPredictProbabilities(MatrixT, ModelInputFormat)
Predicts the value of the output corresponding to the specified features.
Public methodPredictProbabilities(VectorT, ModelInputFormat)
Predicts the value of the output corresponding to the specified input.
Protected methodPredictProbabilitiesCore(MatrixT, MatrixDouble, Boolean)
Predicts the probabilities of each class based on the specified values of the features.
Protected methodPredictProbabilitiesCore(VectorT, VectorDouble, Boolean)
Predicts the probabilities of each class based on the specified values of the features.
Public methodPredictProbabilitiesInto(IDataFrame, MatrixDouble, ModelInputFormat)
Predicts the value of the output corresponding to the specified input.
Public methodPredictProbabilitiesInto(MatrixT, MatrixDouble, ModelInputFormat)
Predicts the value of the output corresponding to the specified features.
Public methodPredictProbabilitiesInto(VectorT, VectorDouble, ModelInputFormat)
Predicts the probabilities of each class based on the specified features.
Public methodResetComputation Obsolete.
Clears all fitted model parameters.
(Inherited from Model.)
Public methodResetFit
Clears all fitted model parameters.
(Inherited from Model.)
Public methodSetDataSource
Uses the specified data frame as the source for all input variables.
(Inherited from Model.)
Public methodSummarize
Returns a string containing a human-readable summary of the object using default options.
(Inherited from Model.)
Public methodSummarize(SummaryOptions)
Returns a string containing a human-readable summary of the object using the specified options.
(Inherited from Model.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Model.)
Top
Remarks

This is an abstract base class and cannot be instantiated directly. Instead, use one of the inherited types, as listed in the table below:

ClassDescription
LogisticRegressionModelA binary or multinomial logistic regression model with one or more independent variables.
LinearDiscriminantAnalysisA linear discriminant analysis model with multiple independent variables.

Note to inheritors: When you inherit from ClassificationModelT, you must override FitCore(ModelInput, ParallelOptions).

See Also

Reference

Extreme.DataAnalysis.Models Namespace

Copyright (c) 2004-2021 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2021, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.