Struct clear_ml::models::LinearModel

pub struct LinearModel {
    pub intercept: f64,
    pub coefficients: Vec<f64>,
}

Linear model.

Formula

y = a0(intercept) + a1x1 + a2x2 + … + an*xn

Fields

intercept: f64

coefficients: Vec<f64>

Implementations

impl LinearModel

pub fn new() -> Self

Create a new linear model.

pub fn fit(&mut self, x: &Vec<Vec<f64>>, y: &Vec<f64>) -> Result<&Self, Error>

Fit linear model.

Note

Does not fit intercept for now! # TODO

Arguments

• x - Matrix of features
• y - Vector of actual values

Requirements

• x must have the same length as y
• x’s rows must all be same length

Returns

• Ok(&Self) if successful
• Err(Error) if unsuccessful

pub fn predict(&self, x: &Vec<Vec<f64>>) -> Result<Vec<f64>, Error>

Predict using the linear model.

Arguments

• x - Matrix of features

Requirements

• x’s rows must all match the length of the coefficients of the LinearModel

Returns

• Ok(Vec<f64>) if successful
• Err(Error) if unsuccessful

Trait Implementations

impl Debug for LinearModel

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

Formats the value using the given formatter.