TweedieRegressor

Struct TweedieRegressor 

Source
pub struct TweedieRegressor<A> {
    pub coef: Array1<A>,
    pub intercept: A,
    /* private fields */
}
Expand description

Generalized Linear Model (GLM) with a Tweedie distribution

The Regressor can be used to model different GLMs depending on power, which determines the underlying distribution.

PowerDistribution
0Normal
1Poisson
(1, 2)Compound Poisson Gamma
2Gamma
3Inverse Gaussian

NOTE: No distribution exists between 0 and 1

Learn more from sklearn’s excellent User Guide

§Examples

Here’s an example on how to train a GLM on the diabetes dataset

use linfa::traits::{Fit, Predict};
use linfa_linear::TweedieRegressor;
use linfa::prelude::SingleTargetRegression;

let dataset = linfa_datasets::diabetes();
let model = TweedieRegressor::params().fit(&dataset).unwrap();
let pred = model.predict(&dataset);
let r2 = pred.r2(&dataset).unwrap();
println!("r2 from prediction: {}", r2);

Fields§

§coef: Array1<A>

Estimated coefficients for the linear predictor

§intercept: A

Intercept or bias added to the linear model

Implementations§

Trait Implementations§

Source§

impl<A: Clone> Clone for TweedieRegressor<A>

Source§

fn clone(&self) -> TweedieRegressor<A>

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<A: Debug> Debug for TweedieRegressor<A>

Source§

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

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

impl<A: PartialEq> PartialEq for TweedieRegressor<A>

Source§

fn eq(&self, other: &TweedieRegressor<A>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<A: Float, D: Data<Elem = A>> PredictInplace<ArrayBase<D, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>> for TweedieRegressor<A>

Source§

fn predict_inplace(&self, x: &ArrayBase<D, Ix2>, y: &mut Array1<A>)

Predict the target

Source§

fn default_target(&self, x: &ArrayBase<D, Ix2>) -> Array1<A>

Create targets that predict_inplace works with.
Source§

impl<A> StructuralPartialEq for TweedieRegressor<A>

Auto Trait Implementations§

§

impl<A> Freeze for TweedieRegressor<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for TweedieRegressor<A>
where A: RefUnwindSafe,

§

impl<A> Send for TweedieRegressor<A>
where A: Send,

§

impl<A> Sync for TweedieRegressor<A>
where A: Sync,

§

impl<A> Unpin for TweedieRegressor<A>
where A: Unpin,

§

impl<A> UnwindSafe for TweedieRegressor<A>

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> 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> 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<'a, F, D, DM, T, O> Predict<&'a ArrayBase<D, DM>, T> for O
where D: Data<Elem = F>, DM: Dimension, O: PredictInplace<ArrayBase<D, DM>, T>,

Source§

fn predict(&self, records: &'a ArrayBase<D, DM>) -> T

Source§

impl<'a, F, R, T, S, O> Predict<&'a DatasetBase<R, T>, S> for O
where R: Records<Elem = F>, O: PredictInplace<R, S>,

Source§

fn predict(&self, ds: &'a DatasetBase<R, T>) -> S

Source§

impl<F, D, E, T, O> Predict<ArrayBase<D, Dim<[usize; 2]>>, DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, T>> for O
where D: Data<Elem = F>, T: AsTargets<Elem = E>, O: PredictInplace<ArrayBase<D, Dim<[usize; 2]>>, T>,

Source§

fn predict( &self, records: ArrayBase<D, Dim<[usize; 2]>>, ) -> DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, T>

Source§

impl<F, R, T, E, S, O> Predict<DatasetBase<R, T>, DatasetBase<R, S>> for O
where R: Records<Elem = F>, S: AsTargets<Elem = E>, O: PredictInplace<R, S>,

Source§

fn predict(&self, ds: DatasetBase<R, T>) -> DatasetBase<R, S>

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> SendAlias for T

Source§

impl<T> SyncAlias for T