Skip to main content

BayesianRidge

Struct BayesianRidge 

Source
pub struct BayesianRidge<F> {
    pub max_iter: usize,
    pub tol: F,
    pub alpha_init: F,
    pub lambda_init: F,
    pub fit_intercept: bool,
}
Expand description

Bayesian Ridge Regression with automatic regularization tuning.

Estimates weight precision (lambda) and noise precision (alpha) iteratively using evidence maximization. The intercept, if requested, is fit by centering.

§Type Parameters

  • F: The floating-point type (f32 or f64).

Fields§

§max_iter: usize

Maximum number of EM (evidence-maximization) iterations.

§tol: F

Convergence tolerance on the relative change in log-evidence.

§alpha_init: F

Initial noise precision (alpha). Must be positive.

§lambda_init: F

Initial weight precision (lambda). Must be positive.

§fit_intercept: bool

Whether to fit an intercept (bias) term.

Implementations§

Source§

impl<F: Float + FromPrimitive> BayesianRidge<F>

Source

pub fn new() -> Self

Create a new BayesianRidge with default settings.

Defaults: max_iter = 300, tol = 1e-3, alpha_init = 1.0, lambda_init = 1.0, fit_intercept = true.

Source

pub fn with_max_iter(self, max_iter: usize) -> Self

Set the maximum number of iterations.

Source

pub fn with_tol(self, tol: F) -> Self

Set the convergence tolerance.

Source

pub fn with_alpha_init(self, alpha_init: F) -> Self

Set the initial noise precision.

Source

pub fn with_lambda_init(self, lambda_init: F) -> Self

Set the initial weight precision.

Source

pub fn with_fit_intercept(self, fit_intercept: bool) -> Self

Set whether to fit an intercept term.

Trait Implementations§

Source§

impl<F: Clone> Clone for BayesianRidge<F>

Source§

fn clone(&self) -> BayesianRidge<F>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<F: Debug> Debug for BayesianRidge<F>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<F: Float + FromPrimitive> Default for BayesianRidge<F>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<F: Float + Send + Sync + ScalarOperand + FromPrimitive + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 1]>>> for BayesianRidge<F>

Source§

fn fit( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<FittedBayesianRidge<F>, FerroError>

Fit the Bayesian Ridge model via evidence maximization (EM).

Iterates over:

  1. Solve posterior for w given current alpha and lambda.
  2. Update alpha and lambda using the posterior statistics.
§Errors
Source§

type Fitted = FittedBayesianRidge<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.
Source§

impl PipelineEstimator<f64> for BayesianRidge<f64>

Source§

fn fit_pipeline( &self, x: &Array2<f64>, y: &Array1<f64>, ) -> Result<Box<dyn FittedPipelineEstimator<f64>>, FerroError>

Fit the model and return it as a boxed pipeline estimator.

§Errors

Propagates any FerroError from fit.

Auto Trait Implementations§

§

impl<F> Freeze for BayesianRidge<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for BayesianRidge<F>
where F: RefUnwindSafe,

§

impl<F> Send for BayesianRidge<F>
where F: Send,

§

impl<F> Sync for BayesianRidge<F>
where F: Sync,

§

impl<F> Unpin for BayesianRidge<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for BayesianRidge<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for BayesianRidge<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,