numrs2 0.3.3

A Rust implementation inspired by NumPy for numerical computing (NumRS2)
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
//! # Model Registry
//!
//! Multi-model management system with versioning, A/B testing, and hot model reloading.

use super::{Model, Result, ServingError};
use crate::array::Array;
use std::collections::HashMap;
use std::sync::{Arc, RwLock};
use std::time::Instant;

/// Model metadata
#[derive(Clone, Debug)]
pub struct ModelMetadata {
    /// Model name
    pub name: String,

    /// Model version
    pub version: String,

    /// Model description
    pub description: Option<String>,

    /// Model tags for categorization
    pub tags: Vec<String>,

    /// Model load timestamp
    pub loaded_at: Instant,

    /// Model warmup status
    pub warmed_up: bool,

    /// Model size in bytes (if available)
    pub size_bytes: Option<usize>,
}

impl ModelMetadata {
    /// Create new model metadata
    pub fn new(name: String, version: String) -> Self {
        Self {
            name,
            version,
            description: None,
            tags: Vec::new(),
            loaded_at: Instant::now(),
            warmed_up: false,
            size_bytes: None,
        }
    }

    /// Set description
    pub fn with_description(mut self, description: String) -> Self {
        self.description = Some(description);
        self
    }

    /// Add tag
    pub fn with_tag(mut self, tag: String) -> Self {
        self.tags.push(tag);
        self
    }

    /// Add multiple tags
    pub fn with_tags(mut self, tags: Vec<String>) -> Self {
        self.tags.extend(tags);
        self
    }

    /// Set model size
    pub fn with_size(mut self, size_bytes: usize) -> Self {
        self.size_bytes = Some(size_bytes);
        self
    }
}

/// Model version entry
struct ModelVersion {
    model: Box<dyn Model>,
    metadata: ModelMetadata,
}

/// A/B testing configuration
#[derive(Clone, Debug)]
pub struct ABTestConfig {
    /// Version A name
    pub version_a: String,

    /// Version B name
    pub version_b: String,

    /// Traffic split percentage for version A (0.0 to 1.0)
    pub split_percent: f64,

    /// Number of requests routed to version A
    pub requests_a: usize,

    /// Number of requests routed to version B
    pub requests_b: usize,
}

impl ABTestConfig {
    /// Create new A/B test configuration
    pub fn new(version_a: String, version_b: String, split_percent: f64) -> Result<Self> {
        if !(0.0..=1.0).contains(&split_percent) {
            return Err(ServingError::ValidationError {
                field: "split_percent".to_string(),
                message: "Split percentage must be between 0.0 and 1.0".to_string(),
            });
        }

        Ok(Self {
            version_a,
            version_b,
            split_percent,
            requests_a: 0,
            requests_b: 0,
        })
    }

    /// Get version based on split percentage and request count
    pub fn get_version(&self) -> &str {
        let total = self.requests_a + self.requests_b;
        if total == 0 {
            return &self.version_a;
        }

        let actual_split = self.requests_a as f64 / total as f64;
        if actual_split < self.split_percent {
            &self.version_a
        } else {
            &self.version_b
        }
    }
}

/// Model registry for multi-model management
pub struct ModelRegistry {
    models: RwLock<HashMap<String, HashMap<String, ModelVersion>>>,
    default_versions: RwLock<HashMap<String, String>>,
    ab_tests: RwLock<HashMap<String, ABTestConfig>>,
}

impl ModelRegistry {
    /// Create new model registry
    pub fn new() -> Self {
        Self {
            models: RwLock::new(HashMap::new()),
            default_versions: RwLock::new(HashMap::new()),
            ab_tests: RwLock::new(HashMap::new()),
        }
    }

    /// Register a new model
    pub fn register(
        &self,
        name: &str,
        version: &str,
        model: Box<dyn Model>,
        metadata: Option<ModelMetadata>,
    ) -> Result<()> {
        let mut models = self
            .models
            .write()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models write lock".to_string(),
            })?;

        let model_metadata =
            metadata.unwrap_or_else(|| ModelMetadata::new(name.to_string(), version.to_string()));

        let version_entry = ModelVersion {
            model,
            metadata: model_metadata,
        };

        models
            .entry(name.to_string())
            .or_insert_with(HashMap::new)
            .insert(version.to_string(), version_entry);

        // Set as default version if this is the first version
        let mut default_versions =
            self.default_versions
                .write()
                .map_err(|_| ServingError::ConcurrencyError {
                    message: "Failed to acquire default_versions write lock".to_string(),
                })?;

        if !default_versions.contains_key(name) {
            default_versions.insert(name.to_string(), version.to_string());
        }

        Ok(())
    }

    /// Unregister a model version
    pub fn unregister(&self, name: &str, version: &str) -> Result<()> {
        let mut models = self
            .models
            .write()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models write lock".to_string(),
            })?;

        if let Some(versions) = models.get_mut(name) {
            versions.remove(version);

            // Remove model entry if no versions left
            if versions.is_empty() {
                models.remove(name);

                let mut default_versions =
                    self.default_versions
                        .write()
                        .map_err(|_| ServingError::ConcurrencyError {
                            message: "Failed to acquire default_versions write lock".to_string(),
                        })?;
                default_versions.remove(name);
            }
        }

        Ok(())
    }

    /// Get model by name and version
    pub fn get(&self, name: &str, version: Option<&str>) -> Result<Arc<RwLock<Box<dyn Model>>>> {
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        let versions = models
            .get(name)
            .ok_or_else(|| ServingError::ModelNotFound {
                model_name: name.to_string(),
                version: version.map(String::from),
            })?;

        let version_str = if let Some(v) = version {
            v.to_string()
        } else {
            let default_versions =
                self.default_versions
                    .read()
                    .map_err(|_| ServingError::ConcurrencyError {
                        message: "Failed to acquire default_versions read lock".to_string(),
                    })?;

            default_versions
                .get(name)
                .ok_or_else(|| ServingError::ModelNotFound {
                    model_name: name.to_string(),
                    version: None,
                })?
                .clone()
        };

        // Note: We can't return a direct reference to the model due to lock lifetime
        // In a real implementation, you'd use Arc<RwLock<Box<dyn Model>>>
        Err(ServingError::Other {
            message: "Direct model access not supported - use get_metadata or invoke methods"
                .to_string(),
        })
    }

    /// Get model metadata
    pub fn get_metadata(&self, name: &str, version: Option<&str>) -> Result<ModelMetadata> {
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        let versions = models
            .get(name)
            .ok_or_else(|| ServingError::ModelNotFound {
                model_name: name.to_string(),
                version: version.map(String::from),
            })?;

        let version_str = if let Some(v) = version {
            v.to_string()
        } else {
            let default_versions =
                self.default_versions
                    .read()
                    .map_err(|_| ServingError::ConcurrencyError {
                        message: "Failed to acquire default_versions read lock".to_string(),
                    })?;

            default_versions
                .get(name)
                .ok_or_else(|| ServingError::ModelNotFound {
                    model_name: name.to_string(),
                    version: None,
                })?
                .clone()
        };

        let version_entry =
            versions
                .get(&version_str)
                .ok_or_else(|| ServingError::ModelNotFound {
                    model_name: name.to_string(),
                    version: Some(version_str),
                })?;

        Ok(version_entry.metadata.clone())
    }

    /// Set default version for a model
    pub fn set_default_version(&self, name: &str, version: &str) -> Result<()> {
        // Verify model and version exist
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        let versions = models
            .get(name)
            .ok_or_else(|| ServingError::ModelNotFound {
                model_name: name.to_string(),
                version: Some(version.to_string()),
            })?;

        if !versions.contains_key(version) {
            return Err(ServingError::InvalidVersion {
                model_name: name.to_string(),
                version: version.to_string(),
                message: "Version not found".to_string(),
            });
        }

        drop(models);

        let mut default_versions =
            self.default_versions
                .write()
                .map_err(|_| ServingError::ConcurrencyError {
                    message: "Failed to acquire default_versions write lock".to_string(),
                })?;

        default_versions.insert(name.to_string(), version.to_string());
        Ok(())
    }

    /// Get default version for a model
    pub fn get_default_version(&self, name: &str) -> Result<String> {
        let default_versions =
            self.default_versions
                .read()
                .map_err(|_| ServingError::ConcurrencyError {
                    message: "Failed to acquire default_versions read lock".to_string(),
                })?;

        default_versions
            .get(name)
            .cloned()
            .ok_or_else(|| ServingError::ModelNotFound {
                model_name: name.to_string(),
                version: None,
            })
    }

    /// List all registered models
    pub fn list_models(&self) -> Result<Vec<String>> {
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        Ok(models.keys().cloned().collect())
    }

    /// List all versions of a model
    pub fn list_versions(&self, name: &str) -> Result<Vec<String>> {
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        let versions = models
            .get(name)
            .ok_or_else(|| ServingError::ModelNotFound {
                model_name: name.to_string(),
                version: None,
            })?;

        Ok(versions.keys().cloned().collect())
    }

    /// Create A/B test between two versions
    pub fn create_ab_test(
        &self,
        model_name: &str,
        version_a: &str,
        version_b: &str,
        split_percent: f64,
    ) -> Result<()> {
        // Verify both versions exist
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        let versions = models
            .get(model_name)
            .ok_or_else(|| ServingError::ModelNotFound {
                model_name: model_name.to_string(),
                version: None,
            })?;

        if !versions.contains_key(version_a) {
            return Err(ServingError::InvalidVersion {
                model_name: model_name.to_string(),
                version: version_a.to_string(),
                message: "Version A not found".to_string(),
            });
        }

        if !versions.contains_key(version_b) {
            return Err(ServingError::InvalidVersion {
                model_name: model_name.to_string(),
                version: version_b.to_string(),
                message: "Version B not found".to_string(),
            });
        }

        drop(models);

        let config =
            ABTestConfig::new(version_a.to_string(), version_b.to_string(), split_percent)?;

        let mut ab_tests = self
            .ab_tests
            .write()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire ab_tests write lock".to_string(),
            })?;

        ab_tests.insert(model_name.to_string(), config);
        Ok(())
    }

    /// Get A/B test configuration
    pub fn get_ab_test(&self, model_name: &str) -> Result<ABTestConfig> {
        let ab_tests = self
            .ab_tests
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire ab_tests read lock".to_string(),
            })?;

        ab_tests
            .get(model_name)
            .cloned()
            .ok_or_else(|| ServingError::Other {
                message: format!("No A/B test configured for model '{}'", model_name),
            })
    }

    /// Remove A/B test
    pub fn remove_ab_test(&self, model_name: &str) -> Result<()> {
        let mut ab_tests = self
            .ab_tests
            .write()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire ab_tests write lock".to_string(),
            })?;

        ab_tests.remove(model_name);
        Ok(())
    }

    /// Get total number of registered models
    pub fn model_count(&self) -> Result<usize> {
        let models = self
            .models
            .read()
            .map_err(|_| ServingError::ConcurrencyError {
                message: "Failed to acquire models read lock".to_string(),
            })?;

        Ok(models.len())
    }
}

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

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

    // Mock model for testing
    struct MockModel {
        name: String,
        version: String,
    }

    impl MockModel {
        fn new(name: &str, version: &str) -> Self {
            Self {
                name: name.to_string(),
                version: version.to_string(),
            }
        }
    }

    impl Model for MockModel {
        fn forward(&self, input: &Array<f64>) -> Result<Array<f64>> {
            Ok(input.clone())
        }

        fn name(&self) -> &str {
            &self.name
        }

        fn input_shape(&self) -> Vec<Option<usize>> {
            vec![None, Some(3)]
        }

        fn output_shape(&self) -> Vec<Option<usize>> {
            vec![None, Some(3)]
        }
    }

    #[test]
    fn test_registry_creation() {
        let registry = ModelRegistry::new();
        assert_eq!(registry.model_count().expect("test: valid model count"), 0);
    }

    #[test]
    fn test_register_model() {
        let registry = ModelRegistry::new();
        let model = Box::new(MockModel::new("test_model", "v1.0"));

        registry
            .register("test_model", "v1.0", model, None)
            .expect("Registration should succeed");

        assert_eq!(
            registry
                .model_count()
                .expect("test: valid model count after registration"),
            1
        );
    }

    #[test]
    fn test_register_multiple_versions() {
        let registry = ModelRegistry::new();
        let model_v1 = Box::new(MockModel::new("test_model", "v1.0"));
        let model_v2 = Box::new(MockModel::new("test_model", "v2.0"));

        registry
            .register("test_model", "v1.0", model_v1, None)
            .expect("Registration should succeed");
        registry
            .register("test_model", "v2.0", model_v2, None)
            .expect("Registration should succeed");

        let versions = registry
            .list_versions("test_model")
            .expect("List versions should succeed");
        assert_eq!(versions.len(), 2);
    }

    #[test]
    fn test_unregister_model() {
        let registry = ModelRegistry::new();
        let model = Box::new(MockModel::new("test_model", "v1.0"));

        registry
            .register("test_model", "v1.0", model, None)
            .expect("Registration should succeed");

        registry
            .unregister("test_model", "v1.0")
            .expect("Unregistration should succeed");

        assert_eq!(registry.model_count().expect("test: valid model count"), 0);
    }

    #[test]
    fn test_get_metadata() {
        let registry = ModelRegistry::new();
        let model = Box::new(MockModel::new("test_model", "v1.0"));

        let metadata = ModelMetadata::new("test_model".to_string(), "v1.0".to_string())
            .with_description("Test model".to_string())
            .with_tag("test".to_string());

        registry
            .register("test_model", "v1.0", model, Some(metadata.clone()))
            .expect("Registration should succeed");

        let retrieved_metadata = registry
            .get_metadata("test_model", Some("v1.0"))
            .expect("Get metadata should succeed");

        assert_eq!(retrieved_metadata.name, "test_model");
        assert_eq!(retrieved_metadata.version, "v1.0");
        assert_eq!(
            retrieved_metadata.description,
            Some("Test model".to_string())
        );
    }

    #[test]
    fn test_default_version() {
        let registry = ModelRegistry::new();
        let model_v1 = Box::new(MockModel::new("test_model", "v1.0"));
        let model_v2 = Box::new(MockModel::new("test_model", "v2.0"));

        registry
            .register("test_model", "v1.0", model_v1, None)
            .expect("Registration should succeed");
        registry
            .register("test_model", "v2.0", model_v2, None)
            .expect("Registration should succeed");

        // First version should be default
        let default = registry
            .get_default_version("test_model")
            .expect("Get default version should succeed");
        assert_eq!(default, "v1.0");

        // Change default version
        registry
            .set_default_version("test_model", "v2.0")
            .expect("Set default version should succeed");

        let new_default = registry
            .get_default_version("test_model")
            .expect("Get default version should succeed");
        assert_eq!(new_default, "v2.0");
    }

    #[test]
    fn test_list_models() {
        let registry = ModelRegistry::new();
        let model1 = Box::new(MockModel::new("model1", "v1.0"));
        let model2 = Box::new(MockModel::new("model2", "v1.0"));

        registry
            .register("model1", "v1.0", model1, None)
            .expect("Registration should succeed");
        registry
            .register("model2", "v1.0", model2, None)
            .expect("Registration should succeed");

        let models = registry.list_models().expect("List models should succeed");
        assert_eq!(models.len(), 2);
        assert!(models.contains(&"model1".to_string()));
        assert!(models.contains(&"model2".to_string()));
    }

    #[test]
    fn test_ab_test_creation() {
        let registry = ModelRegistry::new();
        let model_v1 = Box::new(MockModel::new("test_model", "v1.0"));
        let model_v2 = Box::new(MockModel::new("test_model", "v2.0"));

        registry
            .register("test_model", "v1.0", model_v1, None)
            .expect("Registration should succeed");
        registry
            .register("test_model", "v2.0", model_v2, None)
            .expect("Registration should succeed");

        registry
            .create_ab_test("test_model", "v1.0", "v2.0", 0.5)
            .expect("A/B test creation should succeed");

        let ab_test = registry
            .get_ab_test("test_model")
            .expect("Get A/B test should succeed");

        assert_eq!(ab_test.version_a, "v1.0");
        assert_eq!(ab_test.version_b, "v2.0");
        assert_eq!(ab_test.split_percent, 0.5);
    }

    #[test]
    fn test_ab_test_invalid_split() {
        let config_result = ABTestConfig::new("v1".to_string(), "v2".to_string(), 1.5);
        assert!(config_result.is_err());
    }

    #[test]
    fn test_ab_test_version_selection() {
        let config = ABTestConfig::new("v1".to_string(), "v2".to_string(), 0.5)
            .expect("Config creation should succeed");

        // First request should go to version A
        let version = config.get_version();
        assert_eq!(version, "v1");
    }

    #[test]
    fn test_remove_ab_test() {
        let registry = ModelRegistry::new();
        let model_v1 = Box::new(MockModel::new("test_model", "v1.0"));
        let model_v2 = Box::new(MockModel::new("test_model", "v2.0"));

        registry
            .register("test_model", "v1.0", model_v1, None)
            .expect("Registration should succeed");
        registry
            .register("test_model", "v2.0", model_v2, None)
            .expect("Registration should succeed");

        registry
            .create_ab_test("test_model", "v1.0", "v2.0", 0.5)
            .expect("A/B test creation should succeed");

        registry
            .remove_ab_test("test_model")
            .expect("Remove A/B test should succeed");

        assert!(registry.get_ab_test("test_model").is_err());
    }

    #[test]
    fn test_model_metadata_builder() {
        let metadata = ModelMetadata::new("test".to_string(), "v1.0".to_string())
            .with_description("Test description".to_string())
            .with_tag("tag1".to_string())
            .with_tag("tag2".to_string())
            .with_size(1024);

        assert_eq!(metadata.name, "test");
        assert_eq!(metadata.version, "v1.0");
        assert_eq!(metadata.description, Some("Test description".to_string()));
        assert_eq!(metadata.tags.len(), 2);
        assert_eq!(metadata.size_bytes, Some(1024));
    }
}