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

//! Caching utilities for datasets
//!
//! This module provides efficient caching mechanisms to reduce data loading overhead
//! and improve dataset iteration performance.

pub mod dataset;
pub mod extension;
pub mod lru;
pub mod telemetry;

#[cfg(feature = "serialize")]
pub mod persistent;

// Re-export public types for convenience
pub use dataset::{CacheStats, CachedDataset, WarmingStrategy};
pub use extension::CacheExt;
pub use lru::{LruCache, ThreadSafeLruCache};
pub use telemetry::{
    AggregatedStats, AlertSeverity, AlertThresholds, AlertType, CacheEvent, CacheEventType,
    CacheTelemetryCollector, CacheTelemetryMetrics, EnhancedTelemetryCollector, MetricsSnapshot,
    PerformanceAlert, PerformanceBaselines, TelemetryConfig,
};

#[cfg(feature = "serialize")]
pub use persistent::{PersistentCache, PersistentlyCachedDataset, TensorPersistentCache};

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

    #[test]
    fn test_lru_cache_basic() {
        let mut cache = LruCache::new(2);

        cache.insert("a", 1);
        cache.insert("b", 2);

        assert_eq!(cache.get(&"a"), Some(1));
        assert_eq!(cache.get(&"b"), Some(2));
        assert_eq!(cache.len(), 2);
    }

    #[test]
    fn test_lru_cache_eviction() {
        let mut cache = LruCache::new(2);

        cache.insert("a", 1);
        cache.insert("b", 2);
        cache.insert("c", 3); // Should evict "a"

        assert_eq!(cache.get(&"a"), None);
        assert_eq!(cache.get(&"b"), Some(2));
        assert_eq!(cache.get(&"c"), Some(3));
        assert_eq!(cache.len(), 2);
    }

    #[test]
    fn test_lru_cache_access_ordering() {
        let mut cache = LruCache::new(2);

        cache.insert("a", 1);
        cache.insert("b", 2);

        // Access "a" to make it more recently used
        let _ = cache.get(&"a");

        cache.insert("c", 3); // Should evict "b", not "a"

        assert_eq!(cache.get(&"a"), Some(1));
        assert_eq!(cache.get(&"b"), None);
        assert_eq!(cache.get(&"c"), Some(3));
    }

    #[test]
    fn test_cached_dataset() {
        let features = Tensor::<f32>::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[3, 2])
            .expect("test: tensor creation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![10.0, 20.0, 30.0], &[3])
            .expect("test: tensor creation should succeed");

        let dataset = TensorDataset::new(features, labels);
        let cached_dataset = dataset.cached(2);

        assert_eq!(cached_dataset.len(), 3);

        // First access - should be cache miss
        let (features1, _label1) = cached_dataset.get(0).expect("index should be in bounds");
        assert_eq!(features1.shape().dims(), &[2]);

        // Second access to same index - should be cache hit
        let (features2, _label2) = cached_dataset.get(0).expect("index should be in bounds");
        assert_eq!(features2.shape().dims(), &[2]);

        let stats = cached_dataset
            .cache_stats()
            .expect("test: cache stats should succeed");
        assert_eq!(stats.total_requests, 2);
        assert_eq!(stats.hits, 1);
        assert_eq!(stats.misses, 1);
        assert!((stats.hit_ratio() - 0.5).abs() < 1e-6);
    }

    #[test]
    fn test_cache_warming_sequential() {
        let features =
            Tensor::<f32>::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0], &[4, 2])
                .expect("test: tensor creation should succeed");
        let labels = Tensor::<f32>::from_vec(vec![10.0, 20.0, 30.0, 40.0], &[4])
            .expect("test: tensor creation should succeed");

        let dataset = TensorDataset::new(features, labels);
        let cached_dataset = dataset
            .cached_with_warming(4, WarmingStrategy::Sequential { start: 0, count: 2 })
            .expect("test: operation should succeed");

        // These should be cache hits since we pre-warmed indices 0 and 1
        let _ = cached_dataset.get(0).expect("index should be in bounds");
        let _ = cached_dataset.get(1).expect("index should be in bounds");

        let stats = cached_dataset
            .cache_stats()
            .expect("test: cache stats should succeed");
        assert!(stats.hits >= 2);
    }

    #[test]
    fn test_warming_strategy_indices() {
        let strategy = WarmingStrategy::Sequential { start: 1, count: 3 };
        let indices = strategy.generate_indices(10);
        assert_eq!(indices, vec![1, 2, 3]);

        let strategy = WarmingStrategy::Specific(vec![0, 2, 4]);
        let indices = strategy.generate_indices(10);
        assert_eq!(indices, vec![0, 2, 4]);

        let strategy = WarmingStrategy::Random {
            count: 3,
            seed: Some(42),
        };
        let indices = strategy.generate_indices(10);
        assert_eq!(indices.len(), 3);

        // Test with same seed should give same result
        let strategy2 = WarmingStrategy::Random {
            count: 3,
            seed: Some(42),
        };
        let indices2 = strategy2.generate_indices(10);
        assert_eq!(indices, indices2);
    }

    #[cfg(feature = "serialize")]
    #[test]
    fn test_persistent_cache_basic() {
        use std::env;

        let cache_dir = env::temp_dir().join("test_persistent_cache");
        let _ = std::fs::remove_dir_all(&cache_dir); // Clean up if exists

        let mut cache = PersistentCache::<usize, String>::new(&cache_dir, 2)
            .expect("test: persistent cache creation should succeed");

        // Test insertion and retrieval
        cache
            .insert(0, "value0".to_string())
            .expect("test: insert should succeed");
        cache
            .insert(1, "value1".to_string())
            .expect("test: insert should succeed");

        assert_eq!(
            cache.get(&0).expect("test: get should succeed"),
            Some("value0".to_string())
        );
        assert_eq!(
            cache.get(&1).expect("test: get should succeed"),
            Some("value1".to_string())
        );
        assert_eq!(cache.len(), 2);

        // Test eviction
        cache
            .insert(2, "value2".to_string())
            .expect("test: insert should succeed");
        assert_eq!(cache.len(), 2);

        // Clean up
        let _ = std::fs::remove_dir_all(&cache_dir);
    }

    #[cfg(feature = "serialize")]
    #[test]
    fn test_persistent_cache_persistence() {
        use std::env;

        let cache_dir = env::temp_dir().join("test_persistent_cache_persistence");
        let _ = std::fs::remove_dir_all(&cache_dir); // Clean up if exists

        // Create cache and add some data
        {
            let mut cache = PersistentCache::<usize, String>::new(&cache_dir, 3)
                .expect("test: persistent cache creation should succeed");
            cache
                .insert(0, "persistent_value0".to_string())
                .expect("test: insert should succeed");
            cache
                .insert(1, "persistent_value1".to_string())
                .expect("test: insert should succeed");
        }

        // Create new cache instance and verify data persists
        {
            let mut cache = PersistentCache::<usize, String>::new(&cache_dir, 3)
                .expect("test: persistent cache creation should succeed");
            assert_eq!(
                cache.get(&0).expect("test: get should succeed"),
                Some("persistent_value0".to_string())
            );
            assert_eq!(
                cache.get(&1).expect("test: get should succeed"),
                Some("persistent_value1".to_string())
            );
        }

        // Clean up
        let _ = std::fs::remove_dir_all(&cache_dir);
    }

    #[cfg(feature = "serialize")]
    #[test]
    fn test_persistently_cached_dataset() {
        use std::env;

        let cache_dir = env::temp_dir().join("test_persistently_cached_dataset");
        let _ = std::fs::remove_dir_all(&cache_dir); // Clean up if exists

        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![10.0, 20.0], &[2])
            .expect("test: tensor creation should succeed");

        let dataset = TensorDataset::new(features, labels);
        let cached_dataset = PersistentlyCachedDataset::new(dataset, &cache_dir, 2)
            .expect("test: operation should succeed");

        // First access - should be cache miss
        let (features1, _) = cached_dataset.get(0).expect("index should be in bounds");
        assert_eq!(features1.shape().dims(), &[2]);

        // Second access to same index - should be cache hit now that serialization works
        let (features2, _) = cached_dataset.get(0).expect("index should be in bounds");
        assert_eq!(features2.shape().dims(), &[2]);

        let stats = cached_dataset
            .cache_stats()
            .expect("test: cache stats should succeed");
        assert_eq!(stats.total_requests, 2);
        assert_eq!(stats.hits, 1); // Second access should be a hit
        assert_eq!(stats.misses, 1); // First access should be a miss

        // Clean up
        let _ = std::fs::remove_dir_all(&cache_dir);
    }
}