Enhance documentation with usage examples for crate::compute::models

This commit is contained in:
Palash Tyagi
2025-08-03 16:48:37 +01:00
parent e6964795e3
commit ed01c4b8f2
8 changed files with 116 additions and 0 deletions

View File

@@ -1,3 +1,14 @@
//! Principal Component Analysis using covariance matrices.
//!
//! ```
//! use rustframe::compute::models::pca::PCA;
//! use rustframe::matrix::Matrix;
//!
//! let data = Matrix::from_rows_vec(vec![1.0, 1.0, 2.0, 2.0], 2, 2);
//! let pca = PCA::fit(&data, 1, 0);
//! let projected = pca.transform(&data);
//! assert_eq!(projected.cols(), 1);
//! ```
use crate::compute::stats::correlation::covariance_matrix;
use crate::compute::stats::descriptive::mean_vertical;
use crate::matrix::{Axis, Matrix, SeriesOps};