Skip to main content

ModelParams

Enum ModelParams 

Source
pub enum ModelParams {
    Ses {
        alpha: f64,
        level: f64,
        residual_std: f64,
    },
    HoltLinear {
        alpha: f64,
        beta: f64,
        level: f64,
        trend: f64,
        phi: f64,
        residual_std: f64,
    },
    HoltWinters {
        alpha: f64,
        beta: f64,
        gamma: f64,
        period: usize,
        level: f64,
        trend: f64,
        seasonal: Vec<f64>,
        multiplicative: bool,
        residual_std: f64,
        seasonal_phase: usize,
    },
    Arima {
        p: usize,
        d: usize,
        q: usize,
        ar_coeffs: Vec<f64>,
        ma_coeffs: Vec<f64>,
        constant: f64,
        residual_std: f64,
        effective_ar_order: Option<usize>,
    },
    Sarima {
Show 13 fields p: usize, d: usize, q: usize, sp: usize, sd: usize, sq: usize, m: usize, ar_coeffs: Vec<f64>, ma_coeffs: Vec<f64>, sar_coeffs: Vec<f64>, sma_coeffs: Vec<f64>, constant: f64, residual_std: f64,
}, LinearRegression { slope: f64, intercept: f64, r_squared: f64, residual_std: f64, start_ts: i64, interval_ns: i64, }, Custom { name: String, data: Vec<u8>, }, }
Expand description

Fitted model parameters — variant per model type.

Variants§

§

Ses

Simple Exponential Smoothing parameters.

Fields

§alpha: f64

Smoothing factor α ∈ (0, 1).

§level: f64

Last smoothed level.

§residual_std: f64

Standard deviation of in-sample residuals.

§

HoltLinear

Holt’s Linear Trend parameters.

Fields

§alpha: f64

Level smoothing factor α.

§beta: f64

Trend smoothing factor β.

§level: f64

Last smoothed level.

§trend: f64

Last smoothed trend.

§phi: f64

Damping factor ϕ (1.0 = undamped).

§residual_std: f64

Standard deviation of in-sample residuals.

§

HoltWinters

Holt-Winters (triple exponential smoothing) parameters.

Fields

§alpha: f64

Level smoothing factor α.

§beta: f64

Trend smoothing factor β.

§gamma: f64

Seasonal smoothing factor γ.

§period: usize

Seasonal period length (number of observations per cycle).

§level: f64

Last smoothed level.

§trend: f64

Last smoothed trend.

§seasonal: Vec<f64>

Seasonal indices (one per period position).

§multiplicative: bool

Whether multiplicative (true) or additive (false) seasonality is used.

§residual_std: f64

Standard deviation of in-sample residuals.

§seasonal_phase: usize

Phase offset into the seasonal vector for the first prediction step. Set to n_train % period during fit so predictions continue the cycle.

§

Arima

ARIMA(p,d,q) parameters.

Fields

§p: usize

Autoregressive order.

§d: usize

Differencing order.

§q: usize

Moving average order.

§ar_coeffs: Vec<f64>

Autoregressive coefficients φ₁…φₚ.

§ma_coeffs: Vec<f64>

Moving average coefficients θ₁…θ_q.

§constant: f64

Mean of the differenced series, added back to every forecast.

Zero when the model carries no constant — see ArimaModel for when one is included.

§residual_std: f64

Standard deviation of in-sample residuals.

§effective_ar_order: Option<usize>

Effective AR order after Burg estimation. May be less than p if the algorithm terminated early due to near-constant input data.

§

Sarima

Seasonal ARIMA (p,d,q)(P,D,Q)m parameters.

Fields

§p: usize

Non-seasonal AR order.

§d: usize

Non-seasonal differencing order.

§q: usize

Non-seasonal MA order.

§sp: usize

Seasonal AR order P.

§sd: usize

Seasonal differencing order D.

§sq: usize

Seasonal MA order Q.

§m: usize

Seasonal period m.

§ar_coeffs: Vec<f64>

Non-seasonal AR coefficients.

§ma_coeffs: Vec<f64>

Non-seasonal MA coefficients.

§sar_coeffs: Vec<f64>

Seasonal AR coefficients Φ₁…Φ_P.

§sma_coeffs: Vec<f64>

Seasonal MA coefficients Θ₁…Θ_Q.

§constant: f64

Mean of the fully differenced series, added back to every forecast.

§residual_std: f64

Standard deviation of in-sample residuals.

§

LinearRegression

Linear regression parameters.

Fields

§slope: f64

Regression slope (change per unit index).

§intercept: f64

Regression intercept.

§r_squared: f64

Coefficient of determination R².

§residual_std: f64

Standard deviation of in-sample residuals.

§start_ts: i64

Start timestamp of training data (nanoseconds).

§interval_ns: i64

Observation interval (nanoseconds).

§

Custom

Opaque parameters for a custom plugin model.

Fields

§name: String

Plugin model name.

§data: Vec<u8>

Opaque serialized parameter data (interpreted by the plugin).

Trait Implementations§

Source§

impl Clone for ModelParams

Source§

fn clone(&self) -> ModelParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModelParams

Source§

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

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

impl<'de> Deserialize<'de> for ModelParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ModelParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more