aprender/
lib.rs

1//! Aprender: Next-generation machine learning library in pure Rust.
2//!
3//! Aprender provides production-grade ML algorithms with a focus on
4//! ergonomic APIs, comprehensive testing, and backend-agnostic compute.
5//!
6//! # Quick Start
7//!
8//! ```
9//! use aprender::prelude::*;
10//!
11//! // Create training data (y = 2*x + 1)
12//! let x = Matrix::from_vec(4, 1, vec![
13//!     1.0,
14//!     2.0,
15//!     3.0,
16//!     4.0,
17//! ]).unwrap();
18//! let y = Vector::from_slice(&[3.0, 5.0, 7.0, 9.0]);
19//!
20//! // Train linear regression
21//! let mut model = LinearRegression::new();
22//! model.fit(&x, &y).unwrap();
23//!
24//! // Make predictions
25//! let predictions = model.predict(&x);
26//! let r2 = model.score(&x, &y);
27//! assert!(r2 > 0.99);
28//! ```
29//!
30//! # Modules
31//!
32//! - [`primitives`]: Core Vector and Matrix types
33//! - [`data`]: DataFrame for named columns
34//! - [`linear_model`]: Linear regression algorithms
35//! - [`cluster`]: Clustering algorithms (K-Means)
36//! - [`metrics`]: Evaluation metrics
37
38pub mod cluster;
39pub mod data;
40pub mod linear_model;
41pub mod metrics;
42pub mod prelude;
43pub mod primitives;
44pub mod traits;
45
46pub use primitives::{Matrix, Vector};
47pub use traits::{Estimator, Transformer, UnsupervisedEstimator};