Crate linfa_elasticnet

Expand description

Elastic Net

linfa-elasticnet provides a pure Rust implementations of elastic net linear regression.

The Big Picture

linfa-elasticnet is a crate in the linfa ecosystem, an effort to create a toolkit for classical Machine Learning implemented in pure Rust, akin to Python’s scikit-learn.

Current state

The linfa-elasticnet crate provides linear regression with ridge and LASSO constraints. The solver uses coordinate descent to find an optimal solution.

This library contains an elastic net implementation for linear regression models. It combines l1 and l2 penalties of the LASSO and ridge methods and offers therefore a greater flexibility for feature selection. With increasing penalization certain parameters become zero, their corresponding variables are dropped from the model.

Examples

There is an usage example in the examples/ directory. To run, use:

$ cargo run --features linfa/intel-mkl-system --example elasticnet

Show source code

use linfa::prelude::*;
use linfa_elasticnet::{ElasticNet, Result};

// load Diabetes dataset
let (train, valid) = linfa_datasets::diabetes().split_with_ratio(0.90);

// train pure LASSO model with 0.1 penalty
let model = ElasticNet::params()
    .penalty(0.3)
    .l1_ratio(1.0)
    .fit(&train)?;

println!("intercept:  {}", model.intercept());
println!("params: {}", model.hyperplane());

println!("z score: {:?}", model.z_score());

// validate
let y_est = model.predict(&valid);
println!("predicted variance: {}", valid.r2(&y_est)?);

Structs

ElasticNet

Elastic Net model

ElasticNetParams

A hyper-parameter set during construction

ElasticNetValidParams

A verified hyper-parameter set ready for the estimation of a ElasticNet regression model

Enums

ElasticNetError

Error variants from hyperparameter construction or model estimation

Type Definitions

Result

Simplified Result using ElasticNetError as error type