RegressionModel<T> Class

Represents a statistical model.

Definition

Namespace: Extreme.DataAnalysis.Models
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C#
public abstract class RegressionModel<T> : Model
Inheritance
Object  →  Model  →  RegressionModel<T>
Derived

Type Parameters

T

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
SimpleRegressionModelA simple linear regression model with one independent variable.
LinearRegressionModelA regression model with multiple independent variables.
PolynomialRegressionModelA linear regression model that uses a polynomial in one variable.
GeneralizedLinearModelA multiple linear regression model with multiple independent variables.
NonlinearRegressionModelA multiple linear regression model with multiple independent variables.

Note to inheritors: When you inherit from RegressionModel<T>,you must override FitCore(ModelInput, ParallelOptions).

Constructors

RegressionModel<T> Constructs a new univariate model based on a model specification.

Properties

AdjustedRSquared Gets the adjusted R Squared value for the regression.
AnovaTable Gets the AnovaTable that summarizes the results of this model.
BaseFeatureIndex Gets an index containing the keys of the columns that are required inputs to the model.
(Inherited from Model)
Computed Gets whether the model has been computed.
(Inherited from Model)
Obsolete.
CovarianceMatrix Gets the covariance matrix of the model parameters.
Data Gets an object that contains all the data used as input to the model.
(Inherited from Model)
DegreesOfFreedom Gets the total degrees of freedom of the data.
DependentVariable Gets a vector that contains the dependent variable that is to be fitted.
Fitted Gets whether the model has been computed.
(Inherited from Model)
FStatistic Gets the F statistic for the regression.
IndependentVariables Gets a matrix whose columns contain the independent variables in the model.
InputSchema Gets the schema for the features used for fitting the model.
(Inherited from Model)
LogLikelihood Gets the log-likelihood that the model generated the data.
MaxDegreeOfParallelism Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from Model)
ModelSchema Gets the collection of variables used in the model.
(Inherited from Model)
NumberOfObservations Gets the number of observations the model is based on.
(Inherited from Model)
ParallelOptions Gets or sets an object that specifies how the calculation of the model should be parallelized.
(Inherited from Model)
Parameters Gets the collection of parameters associated with this model.
ParameterValues Gets the values of the parameters associated with this model.
Predictions Gets a vector containing the model's predicted values for the dependent variable.
PValue Gets the probability corresponding to the F statistic for the regression.
Residuals Gets a vector containing the residuals of the model.
ResidualSumOfSquares Gets the sum of squares of the residuals of the model.
RSquared Gets the R Squared value for the regression.
StandardError Gets the standard error of the regression.
Status Gets the status of the model, which determines which information is available.
(Inherited from Model)
SupportsWeights Indicates whether the model supports case weights.
(Inherited from Model)
Weights Gets or sets the actual weights.
(Inherited from Model)

Methods

Compute() Computes the model.
(Inherited from Model)
Obsolete.
Compute(ParallelOptions) Computes the model.
(Inherited from Model)
Obsolete.
Contains Returns whether another RegressionModel<T> is nested within this instance.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Fit() Fits the model to the data.
(Inherited from Model)
Fit(ParallelOptions) Fits the model to the data.
(Inherited from Model)
FitCore Computes the model to the specified input using the specified parallelization options.
(Inherited from Model)
GetAkaikeInformationCriterion Returns the Akaike information criterion (AIC) value for the model.
GetBayesianInformationCriterion Returns the Bayesian information criterion (BIC) value for the model.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Predict(IDataFrame, ModelInputFormat) Predicts the value of the output corresponding to the specified features.
Predict(Matrix<T>, ModelInputFormat) Predicts the value of the output corresponding to the specified features.
Predict(Vector<T>, ModelInputFormat) Predicts the value of the output corresponding to the specified features.
PredictCore(Matrix<T>, Boolean) Predicts the value of the dependent variable based on the specified values of the features.
PredictCore(Vector<T>, Boolean) Predicts the value of the dependent variable based on the specified values of the features.
ResetComputation Clears all fitted model parameters.
(Inherited from Model)
Obsolete.
ResetFit Clears all fitted model parameters.
(Inherited from Model)
SetDataSource Uses the specified data frame as the source for all input variables.
(Inherited from Model)
Summarize() Returns a string containing a human-readable summary of the object using default options.
(Inherited from Model)
Summarize(SummaryOptions) Returns a string containing a human-readable summary of the object using the specified options.
(Overrides Model.Summarize(SummaryOptions))
ToStringReturns a string that represents the current object.
(Inherited from Model)

See Also