pub struct Ridge<F> {
pub alpha: F,
pub fit_intercept: bool,
}Expand description
Ridge regression (L2-regularized least squares).
Adds an L2 penalty to the ordinary least squares objective, which shrinks coefficients toward zero and can help with multicollinearity.
§Type Parameters
F: The floating-point type (f32orf64).
Fields§
§alpha: FRegularization strength. Larger values specify stronger regularization.
fit_intercept: boolWhether to fit an intercept (bias) term.
Implementations§
Source§impl<F: Float> Ridge<F>
impl<F: Float> Ridge<F>
Sourcepub fn new() -> Self
pub fn new() -> Self
Create a new Ridge with default settings.
Defaults: alpha = 1.0, fit_intercept = true.
Sourcepub fn with_alpha(self, alpha: F) -> Self
pub fn with_alpha(self, alpha: F) -> Self
Set the regularization strength.
Sourcepub fn with_fit_intercept(self, fit_intercept: bool) -> Self
pub fn with_fit_intercept(self, fit_intercept: bool) -> Self
Set whether to fit an intercept term.
Trait Implementations§
Source§impl<F: Float + Send + Sync + ScalarOperand + FromPrimitive + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 1]>>> for Ridge<F>
impl<F: Float + Send + Sync + ScalarOperand + FromPrimitive + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 1]>>> for Ridge<F>
Source§fn fit(
&self,
x: &Array2<F>,
y: &Array1<F>,
) -> Result<FittedRidge<F>, FerroError>
fn fit( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<FittedRidge<F>, FerroError>
Fit the Ridge regression model using Cholesky decomposition.
Solves (X^T X + alpha * I)^{-1} X^T y.
§Errors
Returns FerroError::ShapeMismatch if the number of samples in
x and y differ.
Returns FerroError::InvalidParameter if alpha is negative.
Source§type Fitted = FittedRidge<F>
type Fitted = FittedRidge<F>
The fitted model type returned by
fit.Source§type Error = FerroError
type Error = FerroError
The error type returned by
fit.Source§impl<F> PipelineEstimator<F> for Ridge<F>
impl<F> PipelineEstimator<F> for Ridge<F>
Source§fn fit_pipeline(
&self,
x: &Array2<F>,
y: &Array1<F>,
) -> Result<Box<dyn FittedPipelineEstimator<F>>, FerroError>
fn fit_pipeline( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<Box<dyn FittedPipelineEstimator<F>>, FerroError>
Fit this estimator on the given data. Read more
Auto Trait Implementations§
impl<F> Freeze for Ridge<F>where
F: Freeze,
impl<F> RefUnwindSafe for Ridge<F>where
F: RefUnwindSafe,
impl<F> Send for Ridge<F>where
F: Send,
impl<F> Sync for Ridge<F>where
F: Sync,
impl<F> Unpin for Ridge<F>where
F: Unpin,
impl<F> UnsafeUnpin for Ridge<F>where
F: UnsafeUnpin,
impl<F> UnwindSafe for Ridge<F>where
F: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more