Partial Least Squares Model Class
Definition
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
public class PartialLeastSquaresModel : Model
- Inheritance
- Object → Model → PartialLeastSquaresModel
Remarks
Use the PartialLeastSquaresModel to perform a partial least squares calculation.
Partial least squares is a technique that fits combinations of independent variables called factors to one or more dependent variables. The factors are chosen to maximize the covariance between the factors and the dependent variables.
Partial least squares is useful when the number of independent variables is large compared to the number of observations, or when variables are highly correlated.
Fitting the model is done with one of two standard algorithms: NIPALS (Nonlinear Iterative PArtial Least Squares) or SIMPLS (Statistically Inspired Modification of Partial Least Squares). The two algorithms give identical results when there is only one dependent variable.
Constructors
Partial | Constructs a new PartialLeastSquaresModel. |
Partial | Constructs a new PartialLeastSquaresModel. |
Partial | Constructs a new PartialLeastSquaresModel. |
Partial | Constructs a new PartialLeastSquaresModel. |
Properties
Base |
Gets an index containing the keys of the columns
that are required inputs to the model.
(Inherited from Model) |
Coefficients | Gets a matrix containing the (unstandardized) coefficients of the Partial Least Squares regression. |
Computed |
Gets whether the model has been computed.
(Inherited from Model) Obsolete. |
Data |
Gets an object that contains all the data used as input to the model.
(Inherited from Model) |
Dependent | Gets a matrix that contains the dependent variables that are to be fitted. |
Fitted |
Gets whether the model has been computed.
(Inherited from Model) |
Independent | Gets a matrix whose columns contain the independent variables in the model. |
Input |
Gets the schema for the features used for fitting the model.
(Inherited from Model) |
Intercepts | Gets a matrix containing the intercept term of the Partial Least Squares regression. |
Max |
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from Model) |
Method | Gets or sets the method used to compute the PLS model. |
Model |
Gets the collection of variables used in the model.
(Inherited from Model) |
Number | Gets or sets the number of components to calculate. |
Number |
Gets the number of observations the model is based on.
(Inherited from Model) |
Parallel |
Gets or sets an object that specifies how the calculation of the model should be parallelized.
(Inherited from Model) |
Predicted | Gets the residuals of the dependent variables. |
Standardized | Gets a matrix containing the standardized coefficients of the Partial Least Squares regression. |
Status |
Gets the status of the model, which determines which information is available.
(Inherited from Model) |
Supports |
Indicates whether the model supports case weights.
(Inherited from Model) |
Variable | Gets a matrix that contains the Variable Importance in Projection (VIP) value for each variable and each number of components. |
Weight | Gets the weights of the independent variables. |
Weights |
Gets or sets the actual weights.
(Inherited from Model) |
XCumulative | Gets a vector containing the cumulative proportion of variance in the independent variables explained by each the component |
XDistance | Gets a vector containing the distance to the model of the independent variables. |
XLoadings | Gets the scores matrix of the independent variables. |
XResiduals | Gets the residuals of the independent variables. |
XScaling | Gets or sets how independent variables are scaled. |
XScores | Gets the loadings matrix of the independent variables. |
XVariance | Gets a vector containing the proportion of variance in the independent variables explained by each the component |
YCumulative | Gets a vector containing the cumulative proportion of variance in the dependent variables explained by each the component |
YDistance | Gets a vector containing the distance to the model of the dependent variables. |
YLoadings | Gets the scores matrix of the dependent variables. |
YResiduals | Gets the residuals of the dependent variables. |
YScaling | Gets or sets how dependent variables are scaled. |
YScores | Gets the loadings matrix of the dependent variables. |
YVariance | Gets a vector containing the proportion of variance in the dependent variables explained by each the component |
Methods
Compute() |
Computes the model.
(Inherited from Model) Obsolete. |
Compute( |
Computes the model.
(Inherited from Model) Obsolete. |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
Finalize | Allows 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( |
Fits the model to the data.
(Inherited from Model) |
Fit |
Computes the model.
(Overrides Model.FitCore(ModelInput, ParallelOptions)) |
GetHashCode | Serves as the default hash function. (Inherited from Object) |
GetType | Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
Predict( | Predicts the value of the dependent variables corresponding to the specified features. |
Predict( | Predicts the value of the dependent variables corresponding to the specified features. |
Predict( | Predicts the value of the dependent variables corresponding to the specified features. |
Predict | Predicts the value of the dependent variable based on the specified values of the features. |
Predict | Predicts the value of the dependent variable based on the specified values of the features. |
Press | Returns the Predicted REsidual Sum of Squares (PRESS) value for the specified test features and targets. |
Reset |
Clears all fitted model parameters.
(Inherited from Model) Obsolete. |
Reset |
Clears all fitted model parameters.
(Inherited from Model) |
Root | Returns the square root of the mean of the Predicted REsidual Sum of Squares (PRESS) value for the specified test features and targets. |
Set |
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( |
Returns a string containing a human-readable summary of the object using the specified options.
(Inherited from Model) |
ToString | Returns a string that represents the current object. (Inherited from Model) |