Struct GLMRegressor 

pub struct GLMRegressor<F> {
    pub family: GLMFamily,
    pub alpha: F,
    pub max_iter: usize,
    pub tol: F,
    pub fit_intercept: bool,
}

Generalized Linear Model regressor.

Fitted via IRLS with a log link function. The GLMFamily controls the assumed variance-mean relationship.

Type Parameters

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

Fields

family: GLMFamily

Distributional family (Poisson, Gamma, or Tweedie).

alpha: F

L2 regularization strength.

max_iter: usize

Maximum number of IRLS iterations.

tol: F

Convergence tolerance on the maximum coefficient change.

fit_intercept: bool

Whether to fit an intercept (bias) term.

Implementations

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

pub fn new(family: GLMFamily) -> Self

Create a new GLMRegressor with the given family.

Defaults: alpha = 1.0, max_iter = 100, tol = 1e-4, fit_intercept = true.

pub fn with_alpha(self, alpha: F) -> Self

Set the L2 regularization strength.

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

Set the maximum number of IRLS iterations.

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

Set the convergence tolerance.

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

Set whether to fit an intercept term.

Trait Implementations

impl<F: Clone> Clone for GLMRegressor<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for GLMRegressor<F>

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

Formats the value using the given formatter.

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

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

Fit the GLM via IRLS.

Errors

• FerroError::ShapeMismatch — sample count mismatch.
• FerroError::InsufficientSamples — zero samples.
• FerroError::InvalidParameter — negative alpha or negative y.

type Fitted = FittedGLMRegressor<F>

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.

impl<F> PipelineEstimator<F> for GLMRegressor<F>

where F: Float + FromPrimitive + ScalarOperand + Send + Sync + 'static,

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

Fit this estimator on the given data.