sklearndf.classification.wrapper.LinearDiscriminantAnalysisWrapperDF#
- class sklearndf.classification.wrapper.LinearDiscriminantAnalysisWrapperDF(*args, **kwargs)[source]#
DF wrapper for
sklearn.discriminant_analysis.LinearDiscriminantAnalysis
.- Bases:
ClassifierWrapperDF
[LinearDiscriminantAnalysis
],NComponentsDimensionalityReductionWrapperDF
[LinearDiscriminantAnalysis
]- Metaclasses:
- Parameters:
Method summary
Make an unfitted clone of this estimator.
Compute the decision function for the given inputs.
Fit this estimator using the given inputs.
Fit this transformer using the given inputs, then transform the inputs.
Make a new wrapped DF estimator, delegating to a given native estimator that has already been fitted.
See
sklearn.utils.get_metadata_routing()
Get the parameters for this estimator.
Inverse-transform the given inputs.
Predict outputs for the given inputs.
Predict class log-probabilities for the given inputs.
Predict class probabilities for the given inputs.
Score this learner using the given inputs and outputs.
See
sklearn.utils.set_output()
Set the parameters of this estimator.
See
sklearn.utils.RequestMethod.__get__.<locals>.func()
Render this object as an expression.
Transform the given inputs.
Attribute summary
Name assigned to an
Index
or aSeries
with the names of the features used to fit aEstimatorDF
.Name assigned to a
Series
with the original feature names before transformation.Name of
Series
objects containing the predictions of single-output learners.Get the classes predicted by this classifier as a numpy array of class labels for single-output problems, or a list of such arrays for multi-output problems
The pandas column index with the names of the features used to fit this estimator.
A pandas series, mapping the output features resulting from the transformation to the original input features.
A pandas column index with the names of the features produced by this transformer
True
if this object is fitted,False
otherwise.The number of features used to fit this estimator.
The number of outputs used to fit this estimator.
The native estimator that this wrapper delegates to.
The name(s) of the output(s) this supervised learner was fitted to.
Definitions
- clone()#
Make an unfitted clone of this estimator.
- Return type:
- Returns:
the unfitted clone
- decision_function(X, **predict_params)#
Compute the decision function for the given inputs.
The inputs must have the same features as the inputs used to fit this learner. The features can be provided in any order since they are identified by their column names.
- Parameters:
- Return type:
- Returns:
a data frame with observations as rows and classes as columns, and values as the raw values predicted per observation and class; for multi-output classifiers, a list of one observation/class data frames per output
- fit(X, y=None, **fit_params)#
Fit this estimator using the given inputs.
- Parameters:
- Return type:
- Returns:
self
- fit_transform(X, y=None, **fit_params)#
Fit this transformer using the given inputs, then transform the inputs.
- Parameters:
- Return type:
- Returns:
the transformed inputs
- classmethod from_fitted(estimator, features_in, n_outputs)#
Make a new wrapped DF estimator, delegating to a given native estimator that has already been fitted.
- Parameters:
estimator (
LinearDiscriminantAnalysis
) – the fitted native estimator to use as the delegatefeatures_in (
Index
) – the column names of X used for fitting the estimatorn_outputs (
int
) – the number of outputs in y used for fitting the estimator
- Return type:
- Returns:
the wrapped data frame estimator
- get_metadata_routing()#
See
sklearn.utils.get_metadata_routing()
- get_params(deep=True)#
Get the parameters for this estimator.
- inverse_transform(X)#
Inverse-transform the given inputs.
The inputs must have the same features as the inputs used to fit this transformer. The features can be provided in any order since they are identified by their column names.
- predict(X, **predict_params)#
Predict outputs for the given inputs.
The inputs must have the same features as the inputs used to fit this learner. The features can be provided in any order since they are identified by their column names.
- Parameters:
- Return type:
- Returns:
predictions per observation as a series, or as a data frame in case of multiple outputs
- predict_log_proba(X, **predict_params)#
Predict class log-probabilities for the given inputs.
The inputs must have the same features as the inputs used to fit this learner. The features can be provided in any order since they are identified by their column names.
- Parameters:
- Return type:
- Returns:
a data frame with observations as rows and classes as columns, and values as log-probabilities per observation and class; for multi-output classifiers, a list of one observation/class data frames per output
- predict_proba(X, **predict_params)#
Predict class probabilities for the given inputs.
The inputs must have the same features as the inputs used to fit this learner. The features can be provided in any order since they are identified by their column names.
- Parameters:
- Return type:
- Returns:
a data frame with observations as rows and classes as columns, and values as probabilities per observation and class; for multi-output classifiers, a list of one observation/class data frames per output
- score(X, y, sample_weight=None)#
Score this learner using the given inputs and outputs.
- Parameters:
X (
Union
[Series
,DataFrame
]) – data frame with observations as rows and features as columnsy (
Series
) – a series or data frame with the true outputs per observationsample_weight (
Optional
[Series
]) – optional series of scalar weights, for calculating the resulting score as the weighted mean of the scores for the individual predictions
- Return type:
- Returns:
the score
- set_output(*, transform=None)#
See
sklearn.utils.set_output()
- set_params(**params)#
Set the parameters of this estimator.
Valid parameter keys can be obtained by calling
get_params()
.- Parameters:
params (
Any
) – the estimator parameters to set- Return type:
- Returns:
self
- set_score_request()#
See
sklearn.utils.RequestMethod.__get__.<locals>.func()
- to_expression()#
Render this object as an expression.
- Return type:
- Returns:
the expression representing this object
- transform(X)#
Transform the given inputs.
The inputs must have the same features as the inputs used to fit this transformer. The features can be provided in any order since they are identified by their column names.
- COL_FEATURE = 'feature'#
Name assigned to an
Index
or aSeries
with the names of the features used to fit aEstimatorDF
.
- COL_FEATURE_ORIGINAL = 'feature_original'#
Name assigned to a
Series
with the original feature names before transformation.
- COL_PREDICTION = 'prediction'#
Name of
Series
objects containing the predictions of single-output learners.See
predict()
.
- property classes_: ndarray[tuple[int, ...], dtype[Any]] | list[ndarray[tuple[int, ...], dtype[Any]]]#
Get the classes predicted by this classifier as a numpy array of class labels for single-output problems, or a list of such arrays for multi-output problems
- Raises:
AttributeError – this classifier is not fitted
- property feature_names_in_: Index#
The pandas column index with the names of the features used to fit this estimator.
- Raises:
AttributeError – this estimator is not fitted
- property feature_names_original_: Series#
A pandas series, mapping the output features resulting from the transformation to the original input features.
The index of the resulting series consists of the names of the output features; the corresponding values are the names of the original input features.
- Raises:
AttributeError – this transformer is not fitted
- property feature_names_out_: Index#
A pandas column index with the names of the features produced by this transformer
- Raises:
AttributeError – this transformer is not fitted
- property n_features_in_: int#
The number of features used to fit this estimator.
- Raises:
AttributeError – this estimator is not fitted
- property n_outputs_: int#
The number of outputs used to fit this estimator.
- Raises:
AttributeError – this estimator is not fitted
- property native_estimator: LinearDiscriminantAnalysisWrapperDF#
The native estimator that this wrapper delegates to.
- property output_names_: list[str]#
The name(s) of the output(s) this supervised learner was fitted to.
- Raises:
sklearn.exceptions.NotFittedError – this estimator is not fitted