Fix doc comment example

src/lib.rs

@@ -7,12 +7,13 @@
 //! ```rust
 //! use rustrees::{DecisionTree, Dataset, r2};
 //! 
-//! let dataset = Dataset::read_csv("iris.csv", ",");
+//! let dataset = Dataset::read_csv("datasets/titanic_train.csv", ",");
 //! 
 //! let dt = DecisionTree::train_reg(
 //!    &dataset, 
-//!    5,        // max_depth
+//!    Some(5),        // max_depth
 //!    Some(1),  // min_samples_leaf        
+//!    None,     // max_features (None = all features)
 //!    Some(42), // random_state
 //! );
 //! 
@@ -35,6 +36,7 @@ pub use trees::DecisionTree;
 pub use trees::RandomForest;
 pub use trees::TrainOptions;
 pub use trees::Tree;
+pub use utils::{accuracy, r2};
 
 use pyo3::prelude::*;
 

src/tests.rs

@@ -1,6 +1,7 @@
 #[cfg(test)]
 mod tests {
     use crate::{trees::RandomForest, *};
+    use crate::{utils::classification_threshold, utils::r2, utils::accuracy};
 
     fn assert_greater_than(a: f32, b: f32) {
         if a <= b {
@@ -10,7 +11,6 @@ mod tests {
 
     #[test]
     fn test_integration() {
-        let a = Box::new(5);
         let train = Dataset::read_csv("datasets/diabetes_train.csv", ",");
         let test = Dataset::read_csv("datasets/diabetes_test.csv", ",");
         let dt = DecisionTree::train_reg(&train, Some(5), Some(1), None, Some(42));

src/utils.rs

@@ -23,8 +23,7 @@ pub(crate) fn classification_threshold(x: &[f32], clf_threshold: f32) -> Vec<f32
 }
 
 /// computes the mean squared error between two vectors used for testing regression case.
-#[cfg(test)]
-pub(crate) fn r2(x_true: &[f32], x_pred: &[f32]) -> f32 {
+pub fn r2(x_true: &[f32], x_pred: &[f32]) -> f32 {
     let mse: f32 = x_true
         .iter()
         .zip(x_pred)
@@ -38,8 +37,7 @@ pub(crate) fn r2(x_true: &[f32], x_pred: &[f32]) -> f32 {
 }
 
 /// computes the accuracy of a binary classification. Used for testing.
-#[cfg(test)]
-pub(crate) fn accuracy(x_true: &[f32], x_pred: &[f32]) -> f32 {
+pub fn accuracy(x_true: &[f32], x_pred: &[f32]) -> f32 {
     x_true
         .iter()
         .zip(x_pred)