tenflowers-dataset 0.1.1

Data pipeline and dataset utilities for TenfloweRS
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
use crate::Dataset;
use std::collections::HashMap;
use tenflowers_core::{Result, Tensor};

// Type aliases for complex types
#[allow(dead_code)]
type SampleData<T> = (usize, (Tensor<T>, Tensor<T>));
type SampleList<T> = [(usize, (Tensor<T>, Tensor<T>))];

#[derive(Debug, Clone)]
pub struct ValidationConfig {
    pub check_schema: bool,
    pub check_ranges: bool,
    pub check_duplicates: bool,
    pub check_outliers: bool,
    pub outlier_threshold: f64, // Z-score threshold for outlier detection
}

impl Default for ValidationConfig {
    fn default() -> Self {
        Self {
            check_schema: true,
            check_ranges: true,
            check_duplicates: true,
            check_outliers: true,
            outlier_threshold: 3.0, // 3 standard deviations
        }
    }
}

#[derive(Debug, Clone)]
pub struct SchemaInfo {
    pub feature_shape: Vec<usize>,
    pub label_shape: Vec<usize>,
    pub expected_feature_type: String,
    pub expected_label_type: String,
}

#[derive(Debug, Clone)]
pub struct RangeConstraint<T> {
    pub min_value: Option<T>,
    pub max_value: Option<T>,
}

impl<T> RangeConstraint<T> {
    pub fn new(min_value: Option<T>, max_value: Option<T>) -> Self {
        Self {
            min_value,
            max_value,
        }
    }

    pub fn min(min_value: T) -> Self {
        Self {
            min_value: Some(min_value),
            max_value: None,
        }
    }

    pub fn max(max_value: T) -> Self {
        Self {
            min_value: None,
            max_value: Some(max_value),
        }
    }

    pub fn range(min_value: T, max_value: T) -> Self {
        Self {
            min_value: Some(min_value),
            max_value: Some(max_value),
        }
    }
}

#[derive(Debug, Clone)]
pub struct ValidationResult {
    pub is_valid: bool,
    pub schema_errors: Vec<String>,
    pub range_errors: Vec<String>,
    pub duplicate_indices: Vec<usize>,
    pub outlier_indices: Vec<usize>,
}

impl ValidationResult {
    pub fn new() -> Self {
        Self {
            is_valid: true,
            schema_errors: Vec::new(),
            range_errors: Vec::new(),
            duplicate_indices: Vec::new(),
            outlier_indices: Vec::new(),
        }
    }

    pub fn has_errors(&self) -> bool {
        !self.schema_errors.is_empty()
            || !self.range_errors.is_empty()
            || !self.duplicate_indices.is_empty()
            || !self.outlier_indices.is_empty()
    }

    pub fn add_schema_error(&mut self, error: String) {
        self.schema_errors.push(error);
        self.is_valid = false;
    }

    pub fn add_range_error(&mut self, error: String) {
        self.range_errors.push(error);
        self.is_valid = false;
    }

    pub fn add_duplicate(&mut self, index: usize) {
        self.duplicate_indices.push(index);
        self.is_valid = false;
    }

    pub fn add_outlier(&mut self, index: usize) {
        self.outlier_indices.push(index);
        self.is_valid = false;
    }
}

impl Default for ValidationResult {
    fn default() -> Self {
        Self::new()
    }
}

pub struct DataValidator<T> {
    config: ValidationConfig,
    schema_info: Option<SchemaInfo>,
    feature_range: Option<RangeConstraint<T>>,
    label_range: Option<RangeConstraint<T>>,
}

impl<T> DataValidator<T>
where
    T: Clone
        + Default
        + PartialEq
        + PartialOrd
        + std::fmt::Display
        + scirs2_core::numeric::Float
        + Send
        + Sync
        + 'static,
{
    pub fn new(config: ValidationConfig) -> Self {
        Self {
            config,
            schema_info: None,
            feature_range: None,
            label_range: None,
        }
    }

    pub fn with_schema(mut self, schema: SchemaInfo) -> Self {
        self.schema_info = Some(schema);
        self
    }

    pub fn with_feature_range(mut self, range: RangeConstraint<T>) -> Self {
        self.feature_range = Some(range);
        self
    }

    pub fn with_label_range(mut self, range: RangeConstraint<T>) -> Self {
        self.label_range = Some(range);
        self
    }

    pub fn validate<D: Dataset<T>>(&self, dataset: &D) -> Result<ValidationResult> {
        let mut result = ValidationResult::new();

        if dataset.is_empty() {
            result.add_schema_error("Dataset is empty".to_string());
            return Ok(result);
        }

        // Collect all samples for validation
        let mut samples = Vec::new();
        for i in 0..dataset.len() {
            match dataset.get(i) {
                Ok(sample) => samples.push((i, sample)),
                Err(e) => {
                    result.add_schema_error(format!("Failed to get sample {i}: {e:?}"));
                }
            }
        }

        if self.config.check_schema {
            self.validate_schema(&samples, &mut result)?;
        }

        if self.config.check_ranges {
            self.validate_ranges(&samples, &mut result)?;
        }

        if self.config.check_duplicates {
            self.validate_duplicates(&samples, &mut result)?;
        }

        if self.config.check_outliers {
            self.validate_outliers(&samples, &mut result)?;
        }

        Ok(result)
    }

    fn validate_schema(
        &self,
        samples: &SampleList<T>,
        result: &mut ValidationResult,
    ) -> Result<()> {
        if let Some(ref schema) = self.schema_info {
            for (index, (features, labels)) in samples {
                // Check feature shape
                if features.shape().dims() != schema.feature_shape {
                    result.add_schema_error(format!(
                        "Sample {}: Feature shape mismatch. Expected {:?}, got {:?}",
                        index,
                        schema.feature_shape,
                        features.shape().dims()
                    ));
                }

                // Check label shape
                if labels.shape().dims() != schema.label_shape {
                    result.add_schema_error(format!(
                        "Sample {}: Label shape mismatch. Expected {:?}, got {:?}",
                        index,
                        schema.label_shape,
                        labels.shape().dims()
                    ));
                }
            }
        }
        Ok(())
    }

    fn validate_ranges(
        &self,
        samples: &SampleList<T>,
        result: &mut ValidationResult,
    ) -> Result<()> {
        for (index, (features, labels)) in samples {
            // Validate feature ranges
            if let Some(ref range) = self.feature_range {
                if let Some(feature_data) = features.as_slice() {
                    for (i, &value) in feature_data.iter().enumerate() {
                        if let Some(min_val) = &range.min_value {
                            if value < *min_val {
                                result.add_range_error(format!(
                                    "Sample {index}: Feature {i} value {value} below minimum {min_val}"
                                ));
                            }
                        }
                        if let Some(max_val) = &range.max_value {
                            if value > *max_val {
                                result.add_range_error(format!(
                                    "Sample {index}: Feature {i} value {value} above maximum {max_val}"
                                ));
                            }
                        }
                    }
                }
            }

            // Validate label ranges
            if let Some(ref range) = self.label_range {
                if let Some(label_data) = labels.as_slice() {
                    for (i, &value) in label_data.iter().enumerate() {
                        if let Some(min_val) = &range.min_value {
                            if value < *min_val {
                                result.add_range_error(format!(
                                    "Sample {index}: Label {i} value {value} below minimum {min_val}"
                                ));
                            }
                        }
                        if let Some(max_val) = &range.max_value {
                            if value > *max_val {
                                result.add_range_error(format!(
                                    "Sample {index}: Label {i} value {value} above maximum {max_val}"
                                ));
                            }
                        }
                    }
                }
            }
        }
        Ok(())
    }

    fn validate_duplicates(
        &self,
        samples: &SampleList<T>,
        result: &mut ValidationResult,
    ) -> Result<()> {
        let mut seen_features: HashMap<Vec<String>, Vec<usize>> = HashMap::new();

        for (index, (features, _)) in samples {
            if let Some(feature_data) = features.as_slice() {
                // Convert to string representation for comparison
                let feature_key: Vec<String> = feature_data
                    .iter()
                    .map(|&x| format!("{x:.6}")) // Use 6 decimal places for float comparison
                    .collect();

                seen_features.entry(feature_key).or_default().push(*index);
            }
        }

        // Find duplicates
        for (_, indices) in seen_features {
            if indices.len() > 1 {
                for &index in &indices[1..] {
                    // Skip first occurrence
                    result.add_duplicate(index);
                }
            }
        }

        Ok(())
    }

    fn validate_outliers(
        &self,
        samples: &SampleList<T>,
        result: &mut ValidationResult,
    ) -> Result<()> {
        if samples.is_empty() {
            return Ok(());
        }

        // Collect feature values for statistical analysis
        let mut feature_values: Vec<Vec<T>> = Vec::new();
        let feature_size = if let Some((_, (features, _))) = samples.first() {
            if let Some(data) = features.as_slice() {
                data.len()
            } else {
                return Ok(()); // Can't analyze GPU tensors
            }
        } else {
            return Ok(());
        };

        // Initialize feature value vectors
        for _ in 0..feature_size {
            feature_values.push(Vec::new());
        }

        // Collect all feature values
        for (_, (features, _)) in samples {
            if let Some(data) = features.as_slice() {
                for (i, &value) in data.iter().enumerate() {
                    if i < feature_values.len() {
                        feature_values[i].push(value);
                    }
                }
            }
        }

        // Calculate mean and std for each feature
        let mut means = Vec::new();
        let mut stds = Vec::new();

        for values in &feature_values {
            if values.is_empty() {
                continue;
            }

            let mean = values.iter().copied().fold(T::zero(), |acc, x| acc + x)
                / T::from(values.len()).expect("values length should convert to float");
            means.push(mean);

            let variance = values
                .iter()
                .map(|&x| {
                    let diff = x - mean;
                    diff * diff
                })
                .fold(T::zero(), |acc, x| acc + x)
                / T::from(values.len()).expect("values length should convert to float");

            let std = variance.sqrt();
            stds.push(std);
        }

        // Check for outliers using Z-score
        let threshold = T::from(self.config.outlier_threshold)
            .expect("outlier threshold should convert to float");

        for (index, (features, _)) in samples {
            if let Some(data) = features.as_slice() {
                for (i, &value) in data.iter().enumerate() {
                    if i < means.len() && i < stds.len() {
                        let mean = means[i];
                        let std = stds[i];

                        if std > T::zero() {
                            let z_score = ((value - mean) / std).abs();
                            if z_score > threshold {
                                result.add_outlier(*index);
                                break; // One outlier per sample is enough
                            }
                        }
                    }
                }
            }
        }

        Ok(())
    }
}

pub trait DatasetValidationExt<T> {
    fn validate(&self, validator: &DataValidator<T>) -> Result<ValidationResult>;
    fn validate_with_config(&self, config: ValidationConfig) -> Result<ValidationResult>;
    fn is_valid(&self) -> Result<bool>;
}

impl<T, D: Dataset<T>> DatasetValidationExt<T> for D
where
    T: Clone
        + Default
        + PartialEq
        + PartialOrd
        + std::fmt::Display
        + scirs2_core::numeric::Float
        + Send
        + Sync
        + 'static,
{
    fn validate(&self, validator: &DataValidator<T>) -> Result<ValidationResult> {
        validator.validate(self)
    }

    fn validate_with_config(&self, config: ValidationConfig) -> Result<ValidationResult> {
        let validator = DataValidator::new(config);
        validator.validate(self)
    }

    fn is_valid(&self) -> Result<bool> {
        let config = ValidationConfig::default();
        let result = self.validate_with_config(config)?;
        Ok(!result.has_errors())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::TensorDataset;
    use tenflowers_core::Tensor;

    #[test]
    fn test_validation_config() {
        let config = ValidationConfig::default();
        assert!(config.check_schema);
        assert!(config.check_ranges);
        assert!(config.check_duplicates);
        assert!(config.check_outliers);
        assert_eq!(config.outlier_threshold, 3.0);
    }

    #[test]
    fn test_range_constraint() {
        let range = RangeConstraint::range(0.0f32, 1.0f32);
        assert_eq!(range.min_value, Some(0.0));
        assert_eq!(range.max_value, Some(1.0));

        let min_only = RangeConstraint::min(-1.0f32);
        assert_eq!(min_only.min_value, Some(-1.0));
        assert_eq!(min_only.max_value, None);

        let max_only = RangeConstraint::max(10.0f32);
        assert_eq!(max_only.min_value, None);
        assert_eq!(max_only.max_value, Some(10.0));
    }

    #[test]
    fn test_validation_result() {
        let mut result = ValidationResult::new();
        assert!(result.is_valid);
        assert!(!result.has_errors());

        result.add_schema_error("Schema error".to_string());
        assert!(!result.is_valid);
        assert!(result.has_errors());
        assert_eq!(result.schema_errors.len(), 1);

        result.add_duplicate(5);
        assert_eq!(result.duplicate_indices.len(), 1);
        assert_eq!(result.duplicate_indices[0], 5);
    }

    #[test]
    fn test_schema_validation() {
        let features = Tensor::<f32>::from_vec(vec![1.0, 2.0, 3.0, 4.0], &[2, 2])
            .expect("test: tensor creation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![0.0, 1.0], &[2])
            .expect("test: tensor creation should succeed");
        let dataset = TensorDataset::new(features, labels);

        let schema = SchemaInfo {
            feature_shape: vec![2], // Expect shape [2] after squeezing
            label_shape: vec![],    // Expect scalar after squeezing
            expected_feature_type: "f32".to_string(),
            expected_label_type: "f32".to_string(),
        };

        let validator = DataValidator::new(ValidationConfig::default()).with_schema(schema);

        let result = validator
            .validate(&dataset)
            .expect("test: operation should succeed");
        assert!(result.is_valid);
        assert!(!result.has_errors());
    }

    #[test]
    fn test_range_validation() {
        let features = Tensor::<f32>::from_vec(
            vec![0.5, 0.8, 1.2, 0.3], // 1.2 is above range [0, 1]
            &[2, 2],
        )
        .expect("test: operation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![0.0, 1.0], &[2])
            .expect("test: tensor creation should succeed");
        let dataset = TensorDataset::new(features, labels);

        let feature_range = RangeConstraint::range(0.0f32, 1.0f32);
        let validator =
            DataValidator::new(ValidationConfig::default()).with_feature_range(feature_range);

        let result = validator
            .validate(&dataset)
            .expect("test: operation should succeed");
        assert!(!result.is_valid);
        assert!(result.has_errors());
        assert!(!result.range_errors.is_empty());
    }

    #[test]
    fn test_duplicate_detection() {
        let features = Tensor::<f32>::from_vec(
            vec![1.0, 2.0, 1.0, 2.0, 3.0, 4.0], // First two samples are duplicates
            &[3, 2],
        )
        .expect("test: operation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![0.0, 1.0, 2.0], &[3])
            .expect("test: tensor creation should succeed");
        let dataset = TensorDataset::new(features, labels);

        let config = ValidationConfig {
            check_schema: false,
            check_ranges: false,
            check_duplicates: true,
            check_outliers: false,
            outlier_threshold: 3.0,
        };

        let validator = DataValidator::new(config);
        let result = validator
            .validate(&dataset)
            .expect("test: operation should succeed");

        assert!(!result.is_valid);
        assert!(result.has_errors());
        assert!(!result.duplicate_indices.is_empty());
    }

    #[test]
    fn test_outlier_detection() {
        let features = Tensor::<f32>::from_vec(
            vec![1.0, 1.0, 1.1, 1.0, 1.2, 1.0, 1.0, 1.0, 100.0, 1.0], // 100.0 is an outlier with more stable baseline
            &[5, 2],
        )
        .expect("test: operation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![0.0, 1.0, 2.0, 3.0, 4.0], &[5])
            .expect("test: tensor creation should succeed");
        let dataset = TensorDataset::new(features, labels);

        let config = ValidationConfig {
            check_schema: false,
            check_ranges: false,
            check_duplicates: false,
            check_outliers: true,
            outlier_threshold: 1.0, // Very low threshold to catch the outlier
        };

        let validator = DataValidator::new(config);
        let result = validator
            .validate(&dataset)
            .expect("test: operation should succeed");

        assert!(!result.is_valid);
        assert!(result.has_errors());
        assert!(!result.outlier_indices.is_empty());
    }

    #[test]
    fn test_dataset_validation_ext() {
        let features = Tensor::<f32>::from_vec(vec![0.5, 0.8, 0.3, 0.7], &[2, 2])
            .expect("test: tensor creation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![0.0, 1.0], &[2])
            .expect("test: tensor creation should succeed");
        let dataset = TensorDataset::new(features, labels);

        let is_valid = dataset.is_valid().expect("test: operation should succeed");
        assert!(is_valid);

        let config = ValidationConfig::default();
        let result = dataset
            .validate_with_config(config)
            .expect("test: operation should succeed");
        assert!(result.is_valid);
    }
}