Skip to main content

Predictions

Struct Predictions 

Source
pub struct Predictions {
    pub ds: Vec<TimestampSeconds>,
    pub yhat: FeaturePrediction,
    pub trend: FeaturePrediction,
    pub cap: Option<Vec<f64>>,
    pub floor: Option<Vec<f64>>,
    pub additive: FeaturePrediction,
    pub multiplicative: FeaturePrediction,
    pub holidays: HashMap<String, FeaturePrediction>,
    pub seasonalities: HashMap<String, FeaturePrediction>,
    pub regressors: HashMap<String, FeaturePrediction>,
}
Expand description

Predictions from a Prophet model.

The yhat field contains the forecasts for the input time series. All other fields contain individual components of the model which contribute towards the final yhat estimate.

Certain fields (such as cap and floor) may be None if the model did not use them (e.g. the model was not configured to use logistic trend).

Fields§

§ds: Vec<TimestampSeconds>

The timestamps of the forecasts.

§yhat: FeaturePrediction

Forecasts of the input time series y.

§trend: FeaturePrediction

The trend contribution at each time point.

§cap: Option<Vec<f64>>

The cap for the logistic growth.

Will only be Some if the model used GrowthType::Logistic.

§floor: Option<Vec<f64>>

The floor for the logistic growth.

Will only be Some if the model used GrowthType::Logistic and the floor was provided in the input data.

§additive: FeaturePrediction

The combined combination of all additive components.

This includes seasonalities, holidays and regressors if their mode was configured to be FeatureMode::Additive.

§multiplicative: FeaturePrediction

The combined combination of all multiplicative components.

This includes seasonalities, holidays and regressors if their mode was configured to be FeatureMode::Multiplicative.

§holidays: HashMap<String, FeaturePrediction>

Mapping from holiday name to that holiday’s contribution.

§seasonalities: HashMap<String, FeaturePrediction>

Mapping from seasonality name to that seasonality’s contribution.

§regressors: HashMap<String, FeaturePrediction>

Mapping from regressor name to that regressor’s contribution.

Trait Implementations§

Source§

impl Clone for Predictions

Source§

fn clone(&self) -> Predictions

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 Debug for Predictions

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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