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 @@
//! Simple k-means clustering working on [`Matrix`] data.
//!
//! ```
//! use rustframe::compute::models::k_means::KMeans;
//! use rustframe::matrix::Matrix;
//!
//! let data = Matrix::from_vec(vec![1.0, 1.0, 5.0, 5.0], 2, 2);
//! let (model, labels) = KMeans::fit(&data, 2, 10, 1e-4);
//! assert_eq!(model.centroids.rows(), 2);
//! assert_eq!(labels.len(), 2);
//! ```
use crate::compute::stats::mean_vertical;
use crate::matrix::Matrix;
use crate::random::prelude::*;