rusty_science 0.1.1

An easy to learn and use ML toolkit for rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

use crate::data::datasets::data_structs::{BreastCancerData, HousingData, IrisData};
use crate::data::datasets::load_csv::{read_breast_cancer_csv, read_housing_csv, read_iris_csv};

mod data_structs;
mod load_csv;

/// Loads the Iris dataset.
///
/// # Returns
///
/// * `IrisData` - A structure containing data from the Iris dataset.
///
/// If the CSV file cannot be read, an empty `IrisData` is returned and an error message is printed to stderr.
///
/// # Errors
/// Prints an error message to stderr if the CSV file cannot be read.
///
/// # Example
///
/// ```
/// use rusty_science::data::load_iris;
/// let iris_data = load_iris();
/// ```
pub fn load_iris() -> IrisData {
    let data_path = "src/data/datasets/data_files/iris.csv";
    match read_iris_csv(data_path) {
        Ok(data) => {
            data
        },
        Err(e) => {
            eprintln!("Error reading CSV file: {}", e);
            IrisData::new()
        },
    }}

/// Loads the Breast Cancer dataset.
///
/// # Returns
///
/// * `BreastCancerData` - A structure containing data from the Breast Cancer dataset.
///
/// If the CSV file cannot be read, an empty `BreastCancerData` is returned and an error message is printed to stderr.
///
/// # Errors
/// Prints an error message to stderr if the CSV file cannot be read.
///
/// # Example
///
/// ```
/// use rusty_science::data::load_brest_cancer;
/// let breast_cancer_data = load_brest_cancer();
/// ```
pub fn load_brest_cancer() -> BreastCancerData {
    let data_path = "src/data/datasets/data_files/brest-cancer.csv";
    match read_breast_cancer_csv(data_path) {
        Ok(data) => {
            data 
        },
        Err(e) => {
            eprintln!("Error reading CSV file: {}", e);
            BreastCancerData::new()
        }
    }
}

/// Loads the Housing dataset.
///
/// # Returns
///
/// * `HousingData` - A structure containing data from the Housing dataset.
///
/// If the CSV file cannot be read, an empty `HousingData` is returned and an error message is printed to stderr.
///
/// # Errors
/// Prints an error message to stderr if the CSV file cannot be read.
///
/// # Example
///
/// ```
/// use rusty_science::data::load_housing;
/// let housing_data = load_housing();
/// ```
pub fn load_housing() -> HousingData {
    let data_path = "src/data/datasets/data_files/housing-data.csv";
    match read_housing_csv(data_path) {
        Ok(data) => {
            data
        },
        Err(e) => {
            eprintln!("Error reading CSV file: {}", e);
            HousingData::new()
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_load_iris_data_exists() {
        let iris_data = load_iris();    
        assert!(iris_data.sepal_length.len() > 0, "No data was loaded for Iris dataset");
        assert_eq!(iris_data.sepal_width.len(), iris_data.sepal_length.len(), "Mismatch in sepal_width and sepal_length record counts");
        assert_eq!(iris_data.species.len(), iris_data.sepal_length.len(), "Mismatch in species and sepal_length record counts");

        if iris_data.sepal_length.len() > 0 {
            assert_eq!(iris_data.species[0], "setosa", "The species of the first Iris record is incorrect");
        }
    }

    #[test]
    fn test_load_breast_cancer_data_exists() {
        let breast_cancer_data = load_brest_cancer();

        assert!(breast_cancer_data.ids.len() > 0, "No data was loaded for Breast Cancer dataset");
        assert_eq!(breast_cancer_data.diagnoses.len(), breast_cancer_data.ids.len(), "Mismatch in diagnoses and ids record counts");
        assert_eq!(breast_cancer_data.radius_mean.len(), breast_cancer_data.ids.len(), "Mismatch in radius_mean and ids record counts");

        if breast_cancer_data.ids.len() > 0 {
            assert_eq!(breast_cancer_data.diagnoses[0], "M", "The diagnosis of the first Breast Cancer record is incorrect");
        }
    }
    
    #[test]
    fn test_housing_data_exists() {
        let housing_data = load_housing();
        println!("{:?}", housing_data)
    }
}