solow 0.2.0

A complete statistical modeling, econometrics, and data-visualization toolkit for Rust
Documentation
//! # Solow
//!
//! A complete statistical modeling, econometrics, and data-visualization
//! toolkit for Rust.
//!
//! This umbrella crate re-exports the full public API of the workspace so a
//! consumer can depend on a single crate. Most users can work entirely through
//! [`prelude`], which brings the common model types, results, and helpers
//! into scope in one glob import:
//!
//! ```
//! use solow::prelude::*;
//! use ndarray::array;
//!
//! let y = array![2.5, 3.4, 4.7, 5.1, 6.5];
//! let x = array![[1.0, 1.0], [1.0, 2.0], [1.0, 3.0], [1.0, 4.0], [1.0, 5.0]];
//! let res = LinearModel::ols(y, x).unwrap().fit().unwrap();
//! assert!(res.rsquared > 0.98);
//! ```

pub use solow_bayes as bayes;
pub use solow_copula as copula;
pub use solow_core as core;
pub use solow_cv as cv;
pub use solow_discrete as discrete;
pub use solow_distributions as distributions;
pub use solow_duration as duration;
pub use solow_emplike as emplike;
pub use solow_fit as fit;
pub use solow_formula as formula;
pub use solow_gam as gam;
pub use solow_gee as gee;
pub use solow_glm as glm;
pub use solow_graphics as graphics;
pub use solow_impute as impute;
pub use solow_linalg as linalg;
pub use solow_metrics as metrics;
pub use solow_mixed as mixed;
pub use solow_multivariate as multivariate;
pub use solow_nonparametric as nonparametric;
pub use solow_optimize as optimize;
pub use solow_othermod as othermod;
pub use solow_regime as regime;
pub use solow_regression as regression;
pub use solow_robust as robust;
pub use solow_statespace as statespace;
pub use solow_stats as stats;
pub use solow_summary as summary;
pub use solow_tsa as tsa;
pub use solow_var as var;
pub use solow_viz as viz;

pub use ndarray;

/// The recommended glob-import for day-to-day use.
///
/// Brings into scope:
///
/// * the shared error / result / numeric types from [`solow_core`];
/// * the ergonomic formula-driven fit helpers from [`solow_fit`]
///   (`ols`, `wls`, `gls`, `glm`, `logit`, `probit`, `poisson`);
/// * the workhorse estimator types — [`LinearModel`](solow_regression::LinearModel),
///   [`Glm`](solow_glm::Glm), [`Logit`](solow_discrete::Logit),
///   [`Probit`](solow_discrete::Probit), [`Poisson`](solow_discrete::Poisson) —
///   and their result structs;
/// * the [`solow_glm`] families and links;
/// * the two most common design-matrix helpers,
///   [`add_constant`](solow_core::tools::add_constant) and
///   [`HasConstant`](solow_core::tools::HasConstant);
/// * the everyday model-evaluation metrics: `mean_squared_error`,
///   `root_mean_squared_error`, `mean_absolute_error`, `r2_score`,
///   `accuracy_score`, `roc_auc_score`, `log_loss`.
pub mod prelude {
    // ndarray essentials.
    pub use ndarray::{array, s, Array1, Array2, ArrayView1, ArrayView2, Axis};

    // Core error, numeric aliases, common tools.
    pub use solow_core::prelude::*;

    // Ergonomic formula-driven fit surface.
    pub use solow_fit::{glm, gls, logit, ols, poisson, probit, wls, DataFrame, NamedFit};

    // Workhorse estimators.
    pub use solow_discrete::{DiscreteResults, Logit, Poisson, Probit};
    pub use solow_glm::{Family, Glm, GlmResults, Link};
    pub use solow_regression::{LinearModel, LinearResults};

    // Formula compilation for the manual path.
    pub use solow_formula::{build, DesignOutput};

    // The most common metrics — a scikit-learn user's day-one imports.
    pub use solow_metrics::{
        accumulated_local_effects, accuracy_score, average_precision_score, binary_focal_loss,
        diebold_mariano, expected_calibration_error, friedman_test, giacomini_white_test,
        huber_loss, log_cosh_loss, log_loss, mean_absolute_error, mean_squared_error,
        multiclass_brier_score, multiclass_focal_loss, nemenyi_critical_difference,
        partial_dependence, permutation_importance, psis_loo, r2_score, ranked_probability_score,
        roc_auc_score, root_mean_squared_error, top_label_calibration_error, waic,
        wilcoxon_signed_rank, AccumulatedLocalEffects, Average, BinStrategy, DmLoss,
        FeatureImportance, FriedmanResult, IsotonicRegression, JackknifePlus, MulticlassAuc,
        PartialDependence, PlattScaling, PredictionInterval, PsisLooResult, RegressionReport,
        SplitConformal, TemperatureScaling, WaicResult, WilcoxonResult,
    };

    // Cross-validation, cross-val scoring, and bootstrap.
    pub use solow_cv::{
        bootstrap_ci, cross_val_score, BootstrapCi, BootstrapMethod, CombinatorialPurgedKFold,
        CrossValScores, GroupKFold, KFold, LeaveOneOut, PurgedKFold, ShuffleSplit, Split, Splitter,
        StratifiedGroupKFold, StratifiedKFold, TimeSeriesSplit,
    };

    // Time-series analysis — AR, ARMA, cointegration, unit-root, and filters.
    pub use solow_tsa::{coint, kpss, AutoReg, ExponentialSmoothing, Holt, SimpleExpSmoothing};

    // Multivariate analysis — PCA, factor analysis, MANOVA, canonical correlation.
    pub use solow_multivariate::{CanCorr, Factor, Manova, Pca};

    // Vector time-series — VAR, VECM, SVAR.
    pub use solow_var::{Svar, Var, Vecm};

    // State-space and structural time series.
    pub use solow_statespace::{
        DynamicFactor, MvStateSpace, Sarimax, StateSpace, UnobservedComponents,
    };

    // Nonparametric — LOWESS, KDE, kernel regression.
    pub use solow_nonparametric::{lowess, KdeUnivariate, KernelReg};

    // Regime-switching models (Markov).
    pub use solow_regime::{MarkovAutoregression, MarkovRegression, MarkovResults};

    // Quantile regression and GLSAR.
    pub use solow_regression::{Glsar, QuantReg};

    // Duration / survival.
    pub use solow_duration::{PHReg, PHRegResults, SurvfuncRight};

    // Mixed-effects and GAM.
    pub use solow_mixed::MixedLm;

    // GEE.
    pub use solow_gee::{Gee, GeeResults};

    // Robust regression.
    pub use solow_robust::Rlm;

    // The most common stats tests — the ones a regression analyst reaches for
    // right after inspecting the coefficient table.
    pub use solow_stats::{
        anova_lm, describe, durbin_watson, f_test, het_white, jarque_bera, multipletests,
        wald_test, DescrStatsW, FTestResult, WaldResult,
    };
}