From 32ae63a577b3a84bcca2dc7472f830b00290f085 Mon Sep 17 00:00:00 2001 From: Volodymyr Orlov Date: Wed, 23 Dec 2020 12:38:10 -0800 Subject: [PATCH] feat: documentation adjusted to new builder --- src/cluster/dbscan.rs | 8 +++----- src/linear/linear_regression.rs | 6 +++--- src/linear/ridge_regression.rs | 7 ++----- 3 files changed, 8 insertions(+), 13 deletions(-) diff --git a/src/cluster/dbscan.rs b/src/cluster/dbscan.rs index ac095f6..c572ccc 100644 --- a/src/cluster/dbscan.rs +++ b/src/cluster/dbscan.rs @@ -15,11 +15,9 @@ //! let blobs = generator::make_blobs(100, 2, 3); //! let x = DenseMatrix::from_vec(blobs.num_samples, blobs.num_features, &blobs.data); //! // Fit the algorithm and predict cluster labels -//! let labels = DBSCAN::fit(&x, Distances::euclidian(), DBSCANParameters{ -//! min_samples: 5, -//! eps: 3.0, -//! algorithm: KNNAlgorithmName::CoverTree -//! }).and_then(|dbscan| dbscan.predict(&x)); +//! let labels = DBSCAN::fit(&x, Distances::euclidian(), +//! DBSCANParameters::default().with_eps(3.0)). +//! and_then(|dbscan| dbscan.predict(&x)); //! //! println!("{:?}", labels); //! ``` diff --git a/src/linear/linear_regression.rs b/src/linear/linear_regression.rs index 0ebad34..1855673 100644 --- a/src/linear/linear_regression.rs +++ b/src/linear/linear_regression.rs @@ -45,9 +45,9 @@ //! let y: Vec = vec![83.0, 88.5, 88.2, 89.5, 96.2, 98.1, 99.0, //! 100.0, 101.2, 104.6, 108.4, 110.8, 112.6, 114.2, 115.7, 116.9]; //! -//! let lr = LinearRegression::fit(&x, &y, LinearRegressionParameters { -//! solver: LinearRegressionSolverName::QR, // or SVD -//! }).unwrap(); +//! let lr = LinearRegression::fit(&x, &y, +//! LinearRegressionParameters::default(). +//! with_solver(LinearRegressionSolverName::QR)).unwrap(); //! //! let y_hat = lr.predict(&x).unwrap(); //! ``` diff --git a/src/linear/ridge_regression.rs b/src/linear/ridge_regression.rs index 5c14313..f29898d 100644 --- a/src/linear/ridge_regression.rs +++ b/src/linear/ridge_regression.rs @@ -45,11 +45,8 @@ //! let y: Vec = vec![83.0, 88.5, 88.2, 89.5, 96.2, 98.1, 99.0, //! 100.0, 101.2, 104.6, 108.4, 110.8, 112.6, 114.2, 115.7, 116.9]; //! -//! let y_hat = RidgeRegression::fit(&x, &y, RidgeRegressionParameters { -//! solver: RidgeRegressionSolverName::Cholesky, -//! alpha: 0.1, -//! normalize: true -//! }).and_then(|lr| lr.predict(&x)).unwrap(); +//! let y_hat = RidgeRegression::fit(&x, &y, RidgeRegressionParameters::default().with_alpha(0.1)). +//! and_then(|lr| lr.predict(&x)).unwrap(); //! ``` //! //! ## References: