malware-modeler 0.0.1

Train logisitic regression models for benign vs. malicious files based on byte n-grams and publish research.
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
// SPDX-License-Identifier: Apache-2.0

use crate::Bytes;

use std::io::{Read, Write};
use std::path::Path;
use std::str::FromStr;
use std::sync::RwLock;

use anyhow::{bail, ensure, Result};
use rayon::prelude::*;
use serde::{Deserialize, Serialize};
use walkdir::WalkDir;

const COMMENT_PREFIXES: [u8; 2] = [b'#', b'%'];
const FEATURES_PREFIX: &str = "Features:";

/// Given a file path, feature size, and collection of features, return a vector
/// which indicates if each feature is present.
///
/// # Errors
/// Returns an error if the file can't be read.
#[inline]
pub fn featurize_file<P: AsRef<Path>>(file: P, n: usize, features: &[Bytes]) -> Result<Vec<f32>> {
    let contents = std::fs::read(file)?;
    let mut feature_vector = vec![0.0; features.len()];

    for window in contents.windows(n) {
        if let Some(position) = features.iter().position(|n| n == window) {
            feature_vector[position] = 1.0;
        }
    }

    Ok(feature_vector)
}

/// File format for a dataset
#[derive(Copy, Clone, Deserialize, Serialize, Hash, Eq, PartialEq)]
pub enum DatasetFormat {
    /// Attribute-relation format
    ARFF,

    /// Comma-separated values, the most common format
    CSV,

    /// Support vector machine format, ideal for sparse data
    SVM,
}

impl FromStr for DatasetFormat {
    type Err = String;

    fn from_str(value: &str) -> std::result::Result<Self, Self::Err> {
        match value.to_lowercase().as_str() {
            "arff" => Ok(Self::ARFF),
            "csv" => Ok(Self::CSV),
            "svm" => Ok(Self::SVM),
            x => Err(format!("Unknown data format '{x}'")),
        }
    }
}

/// A dataset contains data for training or inference, training requires labels
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Dataset {
    /// Data used for training a model or calculating predictions
    pub data: Vec<Vec<f32>>,

    /// Data labels, can be empty if only used for inference
    #[serde(default)]
    pub labels: Vec<f32>,

    /// N-gram features
    pub features: Vec<Bytes>,
}

impl PartialEq for Dataset {
    fn eq(&self, other: &Self) -> bool {
        if self.data.len() != other.data.len()
            || self.labels.len() != other.labels.len()
            || self.features.len() != other.features.len()
        {
            return false;
        }

        for this_data in &self.data {
            if !other.data.contains(this_data) {
                return false;
            }
        }

        for other_data in &other.data {
            if !self.data.contains(other_data) {
                return false;
            }
        }

        if !self.labels.is_empty() {
            for this_label in &self.labels {
                if !other.labels.contains(this_label) {
                    return false;
                }
            }

            for other_label in &other.labels {
                if !self.labels.contains(other_label) {
                    return false;
                }
            }
        }

        for this_features in &self.features {
            if !other.features.contains(this_features) {
                return false;
            }
        }

        for other_feature in &other.features {
            if !self.features.contains(other_feature) {
                return false;
            }
        }

        true
    }
}

impl Dataset {
    /// Load a file
    ///
    /// # Errors
    ///
    /// An error results if the file type can't be determined, is incorrectly determined,
    /// or if the file isn't a supported format.
    pub fn load<P: AsRef<Path>>(path: P) -> Result<Dataset> {
        if let Some(extension) = path.as_ref().extension() {
            return match extension.to_str().unwrap_or_default() {
                "arff" => Dataset::from_arff_file(path.as_ref()),
                "csv" => Dataset::from_csv_file_assume_data_length(path.as_ref()),
                "svm" | "libsvm" => Dataset::from_libsvm_file(path.as_ref()),
                "json" => {
                    let contents = std::fs::read_to_string(path.as_ref())?;
                    serde_json::from_str(&contents).map_err(Into::into)
                }
                "toml" => {
                    let contents = std::fs::read_to_string(path.as_ref())?;
                    toml::from_str(&contents).map_err(Into::into)
                }
                ext => {
                    bail!("Unsupported/unknown data type '{ext}'");
                }
            };
        }

        bail!("No extension, can't determine file type.");
    }

    /// Create a dataset struct from a CSV file
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///   * The file can't be read
    ///   * The data contained isn't numeric
    ///   * Feature data is missing
    ///   * The expected amount of data isn't encountered
    pub fn from_csv_file<P: AsRef<Path>>(path: P, data_length: usize) -> Result<Self> {
        let mut file = std::fs::File::open(path)?;
        let mut contents = String::new();
        file.read_to_string(&mut contents)?;

        Self::from_csv_string(&contents, data_length)
    }

    /// Create a dataset struct from a CSV file
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///   * The file can't be read
    ///   * The data contained isn't a float
    ///   * Feature data is missing
    ///   * The amount of columns can't be determined
    pub fn from_csv_file_assume_data_length<P: AsRef<Path>>(path: P) -> Result<Self> {
        let mut file = std::fs::File::open(path)?;
        let mut contents = String::new();
        file.read_to_string(&mut contents)?;

        let mut length = 0;
        for line in contents.lines() {
            if line.is_empty() || COMMENT_PREFIXES.contains(&line.as_bytes()[0]) {
                continue;
            }

            length = line.split(',').collect::<Vec<&str>>().len();
            break;
        }

        ensure!(length > 0, "Failed to determine data length.");
        Self::from_csv_string(&contents, length - 1)
    }

    /// Create a dataset struct from a CSV string
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///   * The data contained isn't numeric
    ///   * Feature data is missing
    ///   * The expected amount of data isn't encountered
    pub fn from_csv_string(contents: &str, data_length: usize) -> Result<Self> {
        let mut data: Vec<Vec<f32>> = Vec::new();
        let mut labels = Vec::new();
        let mut features = Vec::new();

        for (row_number, line) in contents.lines().enumerate() {
            if line.is_empty() {
                continue;
            }

            if COMMENT_PREFIXES.contains(&line.as_bytes()[0]) && line.contains(FEATURES_PREFIX) {
                let offset = line.find(FEATURES_PREFIX).unwrap_or_default() + FEATURES_PREFIX.len();
                let line = line[offset..].trim();
                features = line
                    .split(',')
                    .filter_map(|f| hex::decode(f.trim()).ok())
                    .collect();
            }

            if line.is_empty() || line.starts_with('%') | line.starts_with('#') {
                continue;
            }
            let row = line.split(',').collect::<Vec<&str>>();
            let mut row_float = Vec::with_capacity(data_length);
            for r in row.iter().take(data_length) {
                row_float.push(r.parse::<f32>().map_err(|_| {
                    anyhow::Error::msg(format!("Non-float encountered on CSV row {row_number}"))
                })?);
            }
            if let Some(first_row) = data.first() {
                ensure!(
                    first_row.len() == row_float.len(),
                    "CSV line {row_number} has invalid length {}, expected {}",
                    row_float.len(),
                    first_row.len()
                );
            }
            data.push(row_float);
            if row.len() == data_length + 1 {
                let l = row[data_length].parse::<f32>().map_err(|_| {
                    anyhow::Error::msg(format!("Non-float encountered on CSV row {row_number}"))
                })?;
                labels.push(l);
            } else if row.len() > data_length {
                bail!(
                    "CSV row had more than one label on row {row_number}, which isn't supported."
                );
            }
        }

        ensure!(
            features.len() == data[0].len(),
            "Features need to be empty or the same size as the data length."
        );

        Ok(Self {
            data,
            labels,
            features,
        })
    }

    /// Create a dataset struct from an ARFF string
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///   * The file can't be read
    ///   * The data contained isn't numeric
    ///   * Feature data is missing
    ///   * The expected amount of data isn't encountered
    pub fn from_arff_file<P: AsRef<Path>>(path: P) -> Result<Self> {
        let mut file = std::fs::File::open(path)?;
        let mut contents = String::new();
        file.read_to_string(&mut contents)?;

        Self::from_arff_string(&contents)
    }

    /// Create a dataset struct from an ARFF string
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///   * The data contained isn't numeric
    ///   * Feature data is missing
    ///   * The expected amount of data isn't encountered
    pub fn from_arff_string(contents: &str) -> Result<Self> {
        let mut data: Vec<Vec<f32>> = Vec::new();
        let mut labels = Vec::new();
        let mut features = Vec::new();
        let mut passed_data = false;

        for (row_number, line) in contents.lines().enumerate() {
            if line.is_empty() || line.starts_with('%') | line.starts_with('#') {
                continue;
            }

            if line.contains("@ATTRIBUTE") {
                let parts: Vec<&str> = line.split_ascii_whitespace().collect();
                if parts.len() == 3 && !parts[1].eq_ignore_ascii_case("CLASS") {
                    match hex::decode(parts[1]) {
                        Ok(feat) => features.push(feat),
                        Err(e) => {
                            bail!("Invalid n-gram attribute on line {row_number}: {line}: {e}")
                        }
                    }
                }
            }

            if line.contains("@DATA") {
                passed_data = true;
                continue;
            }

            // Basically a CSV at this point
            if passed_data {
                let row = line.split(',').collect::<Vec<&str>>();
                let data_length = row.len() - 1;
                let mut row_float = Vec::with_capacity(data_length);
                for r in row.iter().take(data_length) {
                    row_float.push(r.parse::<f32>().map_err(|_| {
                        anyhow::Error::msg(format!(
                            "Non-float encountered on ARFF row {row_number}"
                        ))
                    })?);
                }
                if let Some(first_row) = data.first() {
                    ensure!(
                        first_row.len() == row_float.len(),
                        "ARFF line {row_number} has invalid length {}, expected {}",
                        row_float.len(),
                        first_row.len()
                    );
                }
                data.push(row_float);
                if row.len() == data_length + 1 {
                    let l = row[data_length].parse::<f32>().map_err(|_| {
                        anyhow::Error::msg(format!(
                            "Non-float encountered on ARFF row {row_number}"
                        ))
                    })?;
                    labels.push(l);
                } else if row.len() > data_length {
                    bail!("Arff row had more than one label on row {row_number}, which isn't supported.");
                }
            }
        }

        ensure!(
            features.len() == data[0].len(),
            "Features need to be empty or the same size as the data length."
        );

        Ok(Self {
            data,
            labels,
            features,
        })
    }

    /// Create a dataset struct from a libsvm file
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///   * The file can't be read
    ///   * Feature data is missing
    ///   * The data isn't in the expected format
    ///   * The expected amount of data isn't encountered
    pub fn from_libsvm_file<P: AsRef<Path>>(path: P) -> Result<Self> {
        let mut file = std::fs::File::open(path)?;
        let mut contents = String::new();
        file.read_to_string(&mut contents)?;

        Self::from_libsvm_string(&contents)
    }

    /// Create a dataset from a libsvm string
    ///
    /// # Errors
    ///
    /// Returns an error if the file doesn't contain the expected format or is missing features
    pub fn from_libsvm_string(contents: &str) -> Result<Self> {
        let mut data = Vec::new();
        let mut labels = Vec::new();
        let mut features = Vec::new();

        for (row_number, line) in contents.lines().enumerate() {
            if line.is_empty() {
                continue;
            }

            if COMMENT_PREFIXES.contains(&line.as_bytes()[0]) && line.contains(FEATURES_PREFIX) {
                let offset = line.find(FEATURES_PREFIX).unwrap_or_default() + FEATURES_PREFIX.len();
                let line = line[offset..].trim();
                features = line
                    .split(',')
                    .filter_map(|f| hex::decode(f.trim()).ok())
                    .collect();
            }

            if line.is_empty() || line.starts_with('%') | line.starts_with('#') {
                continue;
            }

            let parts = line.split_whitespace().collect::<Vec<&str>>();
            let label = parts[0].parse::<f32>()?;
            let mut row = vec![0.0f32; features.len()];

            for part in parts.iter().skip(1) {
                let part_parts = part.split(':').collect::<Vec<&str>>();
                let part_index = part_parts[0].parse::<usize>()?;
                let part_value = part_parts[1].parse::<f32>()?;

                if part_index > row.len() && !features.is_empty() {
                    bail!("Encountered a value at index {part_index} greater than expected size {} on line {row_number}", data.len());
                }

                if row.is_empty() {
                    row = vec![0.0; part_index + 1];
                } else if part_index >= row.len() {
                    row.extend_from_slice(&vec![0.0f32; row.len() - part_index + 1]);
                }
                row[part_index] = part_value;
            }

            data.push(row);
            labels.push(label);
        }

        let data_len = data[0].len();
        for row in &data {
            if row.len() != data_len {
                bail!(
                    "Encountered a row with length {} but expected length {data_len}",
                    row.len()
                );
            }
        }

        ensure!(
            features.len() == data[0].len(),
            "Features need to be empty or the same size as the data length."
        );

        Ok(Self {
            data,
            labels,
            features,
        })
    }

    /// Given paths to malicious files, benign files, and n-grams (features), get a Dataset object.
    ///
    /// # Errors
    /// This will fail if:
    /// * The directories for benign or malicious files don't exist or are empty.
    /// * The n-gram feature file doesn't exist, is empty, or doesn't have hexidecimal-encoded features
    pub fn create_from_benign_malicious_files_and_ngrams<P: AsRef<Path>>(
        malicious_dir: P,
        benign_dir: P,
        ngrams_file: P,
    ) -> Result<Self> {
        let ngram_contents = std::fs::read_to_string(&ngrams_file)?;
        let mut n = 0;
        let ngrams = ngram_contents
            .lines()
            .filter_map(|l| {
                let line = if let Some(l) = l.split(',').collect::<Vec<&str>>().first() {
                    l
                } else {
                    l
                };
                if !line.len().is_multiple_of(2) {
                    eprintln!("Line {line} has odd number of characters.");
                    return None;
                }
                if n == 0 {
                    n = line.len() / 2;
                } else if line.len() / 2 != n {
                    eprintln!(
                        "Line {line} has unexpected length of {} bytes, expected {n}",
                        line.len() / 2
                    );
                    return None;
                }
                hex::decode(line).ok()
            })
            .collect::<Vec<_>>();

        ensure!(
            !ngrams.is_empty(),
            "No n-grams read from {}.",
            ngrams_file.as_ref().display()
        );

        let mut paths_labels = Vec::new();
        for entry in WalkDir::new(malicious_dir)
            .max_depth(crate::MAX_RECURSION_DEPTH)
            .follow_links(true)
            .into_iter()
            .flatten()
        {
            if entry.file_type().is_file() {
                paths_labels.push((entry, 1.0));
            }
        }

        for entry in WalkDir::new(benign_dir)
            .max_depth(crate::MAX_RECURSION_DEPTH)
            .follow_links(true)
            .into_iter()
            .flatten()
        {
            if entry.file_type().is_file() {
                paths_labels.push((entry, 0.0));
            }
        }

        let found_files = paths_labels.len();
        let dataset = Dataset::default();
        let dataset_lock = RwLock::new(dataset);
        paths_labels.into_par_iter().for_each(|(path, label)| {
            match featurize_file(path.path(), n, &ngrams) {
                Ok(features) => {
                    if let Ok(mut data) = dataset_lock.write() {
                        data.data.push(features);
                        data.labels.push(label);
                    }
                }
                Err(e) => eprintln!("Failed to featurized {}: {e}", path.path().display()),
            }
        });

        let mut dataset = dataset_lock.into_inner()?;
        dataset.features = ngrams;

        if dataset.data.len() != found_files {
            eprintln!(
                "Warning: found {found_files} but only have features for {} files.",
                dataset.data.len()
            );
        }

        Ok(dataset)
    }

    /// Save a dataset as a CSV
    ///
    /// # Errors
    ///
    /// An error will result if the file can't be opened for writing
    pub fn save_csv<P: AsRef<Path>>(&self, path: P) -> Result<()> {
        let mut file = std::fs::File::create(path)?;

        let feature_string_vec = self
            .features
            .iter()
            .map(hex::encode)
            .collect::<Vec<String>>();
        let features_string = format!("# {FEATURES_PREFIX} {}\n", feature_string_vec.join(", "));
        file.write_all(features_string.as_bytes())?;

        for index in 0..self.data.len() {
            let mut line = self.data[index]
                .iter()
                .map(|p| format!("{p}"))
                .collect::<Vec<String>>()
                .join(",");

            if !self.labels.is_empty() {
                if self.labels[index] > 0.9 {
                    line.push_str(",1");
                } else {
                    line.push_str(",0");
                }
            }
            line.push('\n');

            file.write_all(line.as_bytes())?;
        }

        file.sync_all().map_err(Into::into)
    }

    /// Save a dataset as an ARFF file
    ///
    /// # Errors
    ///
    /// An error will result if the file can't be opened for writing
    pub fn save_arff<P: AsRef<Path>>(&self, path: P) -> Result<()> {
        let mut file = std::fs::File::create(path)?;

        for feature in &self.features {
            let feature_hex = hex::encode(feature);
            file.write_all(format!("@ATTRIBUTE {feature_hex} NUMERIC\n").as_bytes())?;
        }

        if !self.labels.is_empty() {
            file.write_all("@ATTRIBUTE class NUMERIC\n".as_bytes())?;
        }

        file.write_all("\n@DATA\n".as_bytes())?;
        for index in 0..self.data.len() {
            let mut line = self.data[index]
                .iter()
                .map(|p| format!("{p}"))
                .collect::<Vec<String>>()
                .join(",");

            if !self.labels.is_empty() {
                if self.labels[index] > 0.9 {
                    line.push_str(",1");
                } else {
                    line.push_str(",0");
                }
            }
            line.push('\n');

            file.write_all(line.as_bytes())?;
        }

        file.sync_all().map_err(Into::into)
    }

    /// Save a dataset as a libsvm file
    ///
    /// # Errors
    ///
    /// An error will result if the file can't be opened for writing
    pub fn save_libsvm<P: AsRef<Path>>(&self, path: P) -> Result<()> {
        ensure!(
            !self.labels.is_empty(),
            "Labels are required to create an libsvm file."
        );
        let mut file = std::fs::File::create(path)?;

        let feature_string_vec = self
            .features
            .iter()
            .map(hex::encode)
            .collect::<Vec<String>>();
        let features_string = format!("# {FEATURES_PREFIX} {}\n", feature_string_vec.join(", "));
        file.write_all(features_string.as_bytes())?;

        for index in 0..self.data.len() {
            file.write_all(format!("{}", self.labels[index]).as_bytes())?;
            for (data_index, data) in self.data[index].iter().enumerate() {
                if *data != 0.0000 {
                    file.write_all(format!(" {data_index}:{data}").as_bytes())?;
                }
            }

            file.write_all(b"\n")?;
        }

        file.sync_all().map_err(Into::into)
    }

    /// Save the dataset using the file extension to determine data format
    ///
    /// # Errors
    ///
    /// There's an error if the file can't be written or if the format can't be determined
    pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()> {
        if let Some(extension) = path.as_ref().extension() {
            return match extension.to_str().unwrap_or_default() {
                "arff" => self.save_arff(path),
                "csv" => self.save_csv(path),
                "svm" | "libsvm" => self.save_libsvm(path),
                "json" => {
                    let contents = serde_json::to_string_pretty(self)?;
                    let mut file = std::fs::File::create(path)?;
                    file.write_all(contents.as_bytes())?;
                    file.sync_all().map_err(Into::into)
                }
                "toml" => {
                    let contents = toml::to_string_pretty(self)?;
                    let mut file = std::fs::File::create(path)?;
                    file.write_all(contents.as_bytes())?;
                    file.sync_all().map_err(Into::into)
                }
                ext => {
                    bail!("Unsupported/unknown data type '{ext}'");
                }
            };
        }

        bail!("No extension, can't determine file type.");
    }

    /// Return dataset size
    #[inline]
    #[must_use]
    pub fn len(&self) -> usize {
        self.data.len()
    }

    /// Indicate if the dataset is empty
    #[inline]
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    /// Ensure the dataset is valid
    /// * Same size data columns
    /// * If present, the amount of data rows equals the amount of labels
    #[inline]
    #[must_use]
    pub fn validate(&self) -> bool {
        let data_len = match self.data.first() {
            Some(first) => first.len(),
            None => return false,
        };

        // Ensure data records are the same size
        for record in &self.data {
            if record.len() != data_len {
                #[cfg(debug_assertions)]
                eprint!("Expected record size {data_len}, got {}", record.len());
                return false;
            }
        }

        let feature_len = if let Some(first) = self.features.first() {
            first.len()
        } else {
            #[cfg(debug_assertions)]
            eprintln!("Features data is missing");
            return false;
        };

        for feature in &self.features {
            if feature.len() != feature_len {
                #[cfg(debug_assertions)]
                eprint!("Expected feature size {feature_len}, got {}", feature.len());
                return false;
            }
        }

        // If we have labels, ensure it's the same size as the data
        (self.labels.is_empty() || self.labels.len() == self.data.len())
            && self.features.len() == data_len
    }

    /// Shuffle the data, using roughly 10 X log10(size).
    /// So 10 records = 10 iterations, 1,000 records gets 30 iterations
    pub fn shuffle(&mut self) {
        // Avoid a panic since `.ilog10()` panics on zero.
        if !self.is_empty() {
            let iterations = self.data.len().ilog10() * 10;
            self.shuffle_iterations(iterations);
        }
    }

    /// Shuffle the data with a specified amount of iterations, ensures
    /// that the labels are swapped with the data, if present
    pub fn shuffle_iterations(&mut self, iterations: u32) {
        use rand::Rng;

        if !self.is_empty() {
            let mut rng = rand::rng();

            for _ in 0..iterations {
                let a = rng.random_range(0..self.data.len());
                let b = rng.random_range(0..self.data.len());
                let b = if b == a {
                    rng.random_range(0..self.data.len())
                } else {
                    b
                };

                self.data.swap(a, b);
                if !self.labels.is_empty() {
                    self.labels.swap(a, b);
                }
            }
        }
    }

    /// Split the dataset, ideally into train/test datasets.
    /// The ratio indicates how much data is kept, the remaining size is shed and returned.
    #[must_use]
    #[allow(
        clippy::cast_sign_loss,
        clippy::cast_possible_truncation,
        clippy::cast_precision_loss
    )]
    pub fn split(&mut self, ratio: f32) -> Self {
        let ratio = ratio.abs();
        let ratio = if ratio > 1.0 { 1.0 - ratio } else { ratio };
        let new_size = (self.data.len() as f32 * ratio).ceil() as usize;

        let new_data = self.data.drain(new_size..).collect();
        let new_labels = if self.labels.is_empty() {
            vec![]
        } else {
            self.labels.drain(new_size..).collect()
        };

        Self {
            data: new_data,
            labels: new_labels,
            features: self.features.clone(),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::dataset::Dataset;

    #[test]
    fn xor() {
        let csv_dataset = Dataset::from_csv_string(include_str!("../testdata/xor.csv"), 6).unwrap();
        assert!(csv_dataset.validate());

        let arff_dataset = Dataset::from_arff_string(include_str!("../testdata/xor.arff")).unwrap();
        assert!(arff_dataset.validate());

        let svm_dataset = Dataset::from_libsvm_string(include_str!("../testdata/xor.svm")).unwrap();
        assert!(svm_dataset.validate());

        assert_eq!(csv_dataset, arff_dataset);
        assert_eq!(csv_dataset, svm_dataset);
        assert_eq!(arff_dataset, svm_dataset);
    }

    #[test]
    fn xor_no_label() {
        assert!(Dataset::from_csv_string(include_str!("../testdata/xor_no_label.csv"), 6).is_err());
        assert!(Dataset::from_libsvm_string(include_str!("../testdata/xor_no_label.svm")).is_err());
    }

    #[test]
    fn shuffle() {
        let original_dataset =
            Dataset::from_csv_string(include_str!("../testdata/xor.csv"), 6).unwrap();
        let mut dataset = Dataset::from_csv_string(include_str!("../testdata/xor.csv"), 6).unwrap();
        dataset.shuffle();

        assert_eq!(original_dataset, dataset);
        assert_ne!(original_dataset.data, dataset.data);
        assert_ne!(original_dataset.labels, dataset.labels);
        assert_eq!(original_dataset.features, dataset.features);
    }

    #[test]
    fn split() {
        let mut dataset = Dataset::from_csv_string(include_str!("../testdata/xor.csv"), 6).unwrap();
        let original_size = dataset.len();
        let smaller = dataset.split(0.8);

        println!(
            "Original: {original_size}, New size: {}, Smaller dataset: {}",
            dataset.len(),
            smaller.len()
        );
        assert!(smaller.len() < dataset.len());
        assert_eq!(original_size, dataset.len() + smaller.len());
        assert_ne!(dataset, smaller);
        assert_eq!(dataset.features, smaller.features);
    }

    #[test]
    fn save() {
        const COPY_CSV: &str = "xor_copy.csv";
        const COPY_ARFF: &str = "xor_copy.arff";
        const COPY_SVM: &str = "xor_copy.svm";

        let dataset = Dataset::from_csv_string(include_str!("../testdata/xor.csv"), 6).unwrap();
        dataset.save_csv(COPY_CSV).unwrap();
        dataset.save_arff(COPY_ARFF).unwrap();
        dataset.save_libsvm(COPY_SVM).unwrap();

        let dataset2 = Dataset::from_csv_file(COPY_CSV, 6).unwrap();
        assert_eq!(dataset, dataset2);

        let dataset3 = Dataset::from_arff_file(COPY_ARFF).unwrap();
        assert_eq!(dataset, dataset3);
        assert_eq!(dataset2, dataset3);

        let dataset4 = Dataset::from_libsvm_file(COPY_SVM).unwrap();
        assert_eq!(dataset, dataset4);
        assert_eq!(dataset3, dataset4);

        std::fs::remove_file(COPY_CSV).unwrap();
        std::fs::remove_file(COPY_ARFF).unwrap();
        std::fs::remove_file(COPY_SVM).unwrap();
    }
}