anofox-forecast 0.15.0

Time series forecasting library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! # anofox-forecast
//!
//! Time series forecasting library for Rust.
//!
//! Provides 35+ forecasting models including ARIMA, ETS, Theta,
//! and baseline methods, along with automatic model selection (`AutoForecast`,
//! `AutoEnsemble`), seasonality decomposition (STL/MSTL), changepoint detection,
//! outlier detection, and model serialization.
//!
//! Cross-validation is available both as a Rust-native API ([`utils::cross_validate`])
//! and as a DuckDB extension ([forecast-extension](https://github.com/DataZooDE/forecast-extension))
//! for multi-series datasets at scale.
//!
//! For comprehensive periodicity detection, see the
//! [fdars](https://crates.io/crates/fdars-core) crate.

// Allow some clippy warnings for cleaner code in specific cases
#![allow(clippy::upper_case_acronyms)]
#![allow(clippy::too_many_arguments)]
#![allow(clippy::type_complexity)]
#![allow(clippy::needless_range_loop)]
#![allow(clippy::manual_memcpy)]
#![allow(clippy::manual_is_multiple_of)] // is_multiple_of is unstable on WASM

// Prevent use of parallel feature on WASM targets (rayon requires OS threads)
#[cfg(all(feature = "parallel", target_arch = "wasm32"))]
compile_error!(
    "The 'parallel' feature is not supported on WASM targets. Build without --features parallel"
);

#[cfg(feature = "anomaly")]
pub mod anomaly;
pub mod batch;
pub mod changepoint;
pub mod core;
pub mod detection;
pub mod error;
pub mod features;
#[cfg(feature = "forecastability")]
pub mod forecastability;
pub mod hierarchy;
pub mod models;
pub mod monitor;
#[cfg(feature = "postprocess")]
pub mod postprocess;
pub mod seasonality;
pub mod simd;
pub mod transform;
pub mod utils;
pub mod validation;

pub use error::{ForecastError, Result};

pub mod prelude {
    pub use crate::core::{ConstrainedForecast, Forecast, ForecastConstraint, TimeSeries};
    pub use crate::error::{ForecastError, Result};
    pub use crate::models::Forecaster;
    pub use crate::utils::{
        bootstrap_forecast, calculate_metrics, cross_validate, quantile_normal, AccuracyMetrics,
        BootstrapConfig, CVConfig, CVResults,
    };
    pub use crate::validation::{diagnose_residuals, ResidualDiagnostics};

    #[cfg(feature = "postprocess")]
    pub use crate::postprocess::{
        ConformalMethod, ConformalPredictor, ConformalResult, HistoricalSimResult,
        HistoricalSimulator, IDRPredictor, IDRResult, NormalPredictor, NormalResult,
        PointForecasts, PostProcessor, PredictionIntervals, QRAPredictor, QuantileForecasts,
    };
}