entrenar 0.7.13

Training & Optimization library with autograd, LoRA, quantization, and model merging
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
//! Offline model registry implementation.

use sha2::{Digest, Sha256};
use std::fs;
use std::io::Read;
use std::path::{Path, PathBuf};

use crate::error::{Error, Result};

use super::manifest::RegistryManifest;
use super::types::{ModelEntry, ModelSource};

/// Offline model registry
#[derive(Debug)]
pub struct OfflineModelRegistry {
    /// Root path for model storage
    pub root_path: PathBuf,
    /// Registry manifest
    pub manifest: RegistryManifest,
    /// Manifest file path
    manifest_path: PathBuf,
}

impl OfflineModelRegistry {
    /// Create a new registry at the given root path
    pub fn new(root: PathBuf) -> Self {
        let manifest_path = root.join("manifest.json");
        let manifest = if manifest_path.exists() {
            Self::load_manifest(&manifest_path).unwrap_or_default()
        } else {
            RegistryManifest::new()
        };

        Self { root_path: root, manifest, manifest_path }
    }

    /// Create registry at default location (~/.entrenar/models/)
    pub fn default_location() -> Self {
        let home = dirs::home_dir().unwrap_or_else(|| PathBuf::from("."));
        Self::new(home.join(".entrenar").join("models"))
    }

    /// Load manifest from file
    fn load_manifest(path: &Path) -> Result<RegistryManifest> {
        let content = fs::read_to_string(path)?;
        serde_json::from_str(&content).map_err(|e| Error::Io(format!("Invalid manifest data: {e}")))
    }

    /// Save manifest to file
    pub fn save_manifest(&self) -> Result<()> {
        // Ensure parent directory exists
        if let Some(parent) = self.manifest_path.parent() {
            fs::create_dir_all(parent)?;
        }

        let content = serde_json::to_string_pretty(&self.manifest)
            .map_err(|e| Error::Io(format!("Failed to serialize manifest: {e}")))?;
        fs::write(&self.manifest_path, content)?;
        Ok(())
    }

    /// Add a model entry to the registry
    pub fn add_model(&mut self, entry: ModelEntry) {
        self.manifest.add(entry);
    }

    /// Mirror a model from HuggingFace Hub (simulated for offline scenarios)
    ///
    /// In a real implementation, this would download the model.
    /// For air-gapped scenarios, models are pre-downloaded and registered.
    pub fn mirror_from_hub(&mut self, repo_id: &str) -> Result<ModelEntry> {
        // Create model entry with HuggingFace source
        let name = repo_id.split('/').next_back().unwrap_or(repo_id);
        let local_path = self.root_path.join(name);

        let entry = ModelEntry::new(
            name,
            "1.0",
            "", // Checksum computed after download
            0,  // Size computed after download
            ModelSource::huggingface(repo_id),
        )
        .with_local_path(&local_path);

        self.manifest.add(entry.clone());
        Ok(entry)
    }

    /// Register a local model file
    pub fn register_local(&mut self, name: &str, path: &Path) -> Result<ModelEntry> {
        if !path.exists() {
            return Err(Error::ConfigError(format!("Model file not found: {}", path.display())));
        }

        let metadata = fs::metadata(path)?;
        let size_bytes = metadata.len();

        // Compute SHA-256
        let sha256 = Self::compute_file_sha256(path)?;

        // Determine format from extension
        let format = path.extension().and_then(|e| e.to_str()).map(String::from);

        let entry = ModelEntry::new(name, "local", sha256, size_bytes, ModelSource::local(path))
            .with_local_path(path);

        let entry = if let Some(fmt) = format { entry.with_format(fmt) } else { entry };

        self.manifest.add(entry.clone());
        self.manifest.mark_synced();
        self.save_manifest()?;

        Ok(entry)
    }

    /// Compute SHA-256 hash of a file
    fn compute_file_sha256(path: &Path) -> Result<String> {
        let mut file = fs::File::open(path)?;
        let mut hasher = Sha256::new();
        let mut buffer = [0u8; 8192];

        loop {
            let bytes_read = file.read(&mut buffer)?;
            if bytes_read == 0 {
                break;
            }
            hasher.update(&buffer[..bytes_read]);
        }

        Ok(format!("{:x}", hasher.finalize()))
    }

    /// Load a model by name, returning its local path
    pub fn load(&self, name: &str) -> Result<PathBuf> {
        let entry = self
            .manifest
            .find(name)
            .ok_or_else(|| Error::ConfigError(format!("Model not found: {name}")))?;

        let path = entry
            .local_path
            .as_ref()
            .ok_or_else(|| Error::ConfigError(format!("Model not available locally: {name}")))?;

        if !path.exists() {
            return Err(Error::ConfigError(format!("Model file missing: {}", path.display())));
        }

        Ok(path.clone())
    }

    /// Verify a model entry's checksum
    pub fn verify(&self, entry: &ModelEntry) -> Result<bool> {
        let path = entry
            .local_path
            .as_ref()
            .ok_or_else(|| Error::ConfigError("Model has no local path".into()))?;

        if !path.exists() {
            return Ok(false);
        }

        if entry.sha256.is_empty() {
            // No checksum to verify against
            return Ok(true);
        }

        let computed = Self::compute_file_sha256(path)?;
        Ok(computed == entry.sha256)
    }

    /// List all available (locally cached) models
    pub fn list_available(&self) -> Vec<&ModelEntry> {
        self.manifest.available()
    }

    /// List all models in registry
    pub fn list_all(&self) -> &[ModelEntry] {
        &self.manifest.models
    }

    /// Get a model entry by name
    pub fn get(&self, name: &str) -> Option<&ModelEntry> {
        self.manifest.find(name)
    }

    /// Remove a model from registry (does not delete files)
    pub fn remove(&mut self, name: &str) -> Option<ModelEntry> {
        let pos = self.manifest.models.iter().position(|m| m.name == name)?;
        Some(self.manifest.models.remove(pos))
    }

    /// Get total size of all models
    pub fn total_size(&self) -> u64 {
        self.manifest.total_size_bytes()
    }

    /// Get root path
    pub fn root(&self) -> &Path {
        &self.root_path
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;
    use std::io::Write;
    use std::sync::atomic::{AtomicU64, Ordering};

    static TEST_COUNTER: AtomicU64 = AtomicU64::new(0);

    fn temp_registry_dir() -> PathBuf {
        let id = TEST_COUNTER.fetch_add(1, Ordering::SeqCst);
        let dir =
            std::env::temp_dir().join(format!("entrenar_offline_test_{}_{id}", std::process::id()));
        let _ = std::fs::remove_dir_all(&dir);
        std::fs::create_dir_all(&dir).unwrap();
        dir
    }

    #[test]
    fn test_new_empty_registry() {
        let dir = temp_registry_dir();
        let reg = OfflineModelRegistry::new(dir.clone());
        assert!(reg.manifest.models.is_empty());
        assert_eq!(reg.root(), dir.as_path());
        assert_eq!(reg.total_size(), 0);
        assert!(reg.list_all().is_empty());
        assert!(reg.list_available().is_empty());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_new_loads_existing_manifest() {
        let dir = temp_registry_dir();
        let manifest_path = dir.join("manifest.json");
        let manifest = RegistryManifest::new();
        let content = serde_json::to_string_pretty(&manifest).unwrap();
        std::fs::write(&manifest_path, content).unwrap();

        let reg = OfflineModelRegistry::new(dir.clone());
        assert!(reg.manifest.models.is_empty());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_new_with_corrupted_manifest_falls_back() {
        let dir = temp_registry_dir();
        let manifest_path = dir.join("manifest.json");
        std::fs::write(&manifest_path, "not valid json").unwrap();

        let reg = OfflineModelRegistry::new(dir.clone());
        assert!(reg.manifest.models.is_empty()); // falls back to default
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_add_model() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry =
            ModelEntry::new("test-model", "1.0", "abc123", 1024, ModelSource::local("/tmp/model"));
        reg.add_model(entry);
        assert_eq!(reg.list_all().len(), 1);
        assert_eq!(reg.list_all()[0].name, "test-model");
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_get_model() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("mymodel", "2.0", "sha", 2048, ModelSource::local("/tmp/m"));
        reg.add_model(entry);

        assert!(reg.get("mymodel").is_some());
        assert_eq!(reg.get("mymodel").unwrap().version, "2.0");
        assert!(reg.get("nonexistent").is_none());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_remove_model() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("removeme", "1.0", "hash", 512, ModelSource::local("/tmp"));
        reg.add_model(entry);
        assert_eq!(reg.list_all().len(), 1);

        let removed = reg.remove("removeme");
        assert!(removed.is_some());
        assert_eq!(removed.unwrap().name, "removeme");
        assert!(reg.list_all().is_empty());

        // Remove nonexistent
        assert!(reg.remove("nonexistent").is_none());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_save_manifest() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("saved", "1.0", "sha256", 100, ModelSource::local("/tmp"));
        reg.add_model(entry);
        reg.save_manifest().unwrap();

        // Verify file was written
        let manifest_path = dir.join("manifest.json");
        assert!(manifest_path.exists());

        // Load it back
        let reg2 = OfflineModelRegistry::new(dir.clone());
        assert_eq!(reg2.list_all().len(), 1);
        assert_eq!(reg2.list_all()[0].name, "saved");
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_mirror_from_hub() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = reg.mirror_from_hub("org/my-model").unwrap();
        assert_eq!(entry.name, "my-model");
        assert_eq!(reg.list_all().len(), 1);
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_mirror_from_hub_no_slash() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = reg.mirror_from_hub("simple-model").unwrap();
        assert_eq!(entry.name, "simple-model");
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_register_local_file() {
        let dir = temp_registry_dir();
        let model_file = dir.join("model.safetensors");
        let mut f = std::fs::File::create(&model_file).unwrap();
        f.write_all(b"fake model data for testing").unwrap();

        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = reg.register_local("local-model", &model_file).unwrap();
        assert_eq!(entry.name, "local-model");
        assert_eq!(entry.version, "local");
        assert!(!entry.sha256.is_empty());
        assert!(entry.size_bytes > 0);
        assert_eq!(entry.format, Some("safetensors".to_string()));
        assert!(reg.list_all().len() == 1);
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_register_local_file_not_found() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let result = reg.register_local("missing", Path::new("/tmp/nonexistent_model_xyz"));
        assert!(result.is_err());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_register_local_no_extension() {
        let dir = temp_registry_dir();
        let model_file = dir.join("model_no_ext");
        std::fs::write(&model_file, b"data").unwrap();

        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = reg.register_local("noext", &model_file).unwrap();
        assert!(entry.format.is_none());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_load_model_found() {
        let dir = temp_registry_dir();
        let model_file = dir.join("loadable.bin");
        std::fs::write(&model_file, b"model content").unwrap();

        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("loadable", "1.0", "", 100, ModelSource::local(&model_file))
            .with_local_path(&model_file);
        reg.add_model(entry);

        let path = reg.load("loadable").unwrap();
        assert_eq!(path, model_file);
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_load_model_not_found() {
        let dir = temp_registry_dir();
        let reg = OfflineModelRegistry::new(dir.clone());
        assert!(reg.load("nonexistent").is_err());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_load_model_no_local_path() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("no-path", "1.0", "", 0, ModelSource::huggingface("org/model"));
        reg.add_model(entry);
        assert!(reg.load("no-path").is_err());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_load_model_file_missing() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("gone", "1.0", "", 0, ModelSource::local("/tmp/gone_xyz"))
            .with_local_path("/tmp/gone_xyz");
        reg.add_model(entry);
        assert!(reg.load("gone").is_err());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_verify_no_local_path() {
        let dir = temp_registry_dir();
        let reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("no-path", "1.0", "sha", 0, ModelSource::huggingface("org/m"));
        assert!(reg.verify(&entry).is_err());
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_verify_file_missing() {
        let dir = temp_registry_dir();
        let reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("missing", "1.0", "sha", 0, ModelSource::local("/tmp/nope"))
            .with_local_path("/tmp/nope_xyz_verify");
        let result = reg.verify(&entry).unwrap();
        assert!(!result); // file doesn't exist
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_verify_empty_checksum() {
        let dir = temp_registry_dir();
        let model_file = dir.join("verify_empty.bin");
        std::fs::write(&model_file, b"data").unwrap();

        let reg = OfflineModelRegistry::new(dir.clone());
        let entry = ModelEntry::new("verify-empty", "1.0", "", 0, ModelSource::local(&model_file))
            .with_local_path(&model_file);
        let result = reg.verify(&entry).unwrap();
        assert!(result); // empty checksum always passes
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_verify_checksum_match() {
        let dir = temp_registry_dir();
        let model_file = dir.join("verify_match.bin");
        std::fs::write(&model_file, b"test content for sha256").unwrap();

        // Compute actual sha256
        let computed = OfflineModelRegistry::compute_file_sha256(&model_file).unwrap();

        let reg = OfflineModelRegistry::new(dir.clone());
        let entry =
            ModelEntry::new("verify-match", "1.0", &computed, 0, ModelSource::local(&model_file))
                .with_local_path(&model_file);
        let result = reg.verify(&entry).unwrap();
        assert!(result);
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_verify_checksum_mismatch() {
        let dir = temp_registry_dir();
        let model_file = dir.join("verify_mismatch.bin");
        std::fs::write(&model_file, b"some data").unwrap();

        let reg = OfflineModelRegistry::new(dir.clone());
        let entry =
            ModelEntry::new("mismatch", "1.0", "wrong_hash", 0, ModelSource::local(&model_file))
                .with_local_path(&model_file);
        let result = reg.verify(&entry).unwrap();
        assert!(!result);
        let _ = std::fs::remove_dir_all(&dir);
    }

    #[test]
    fn test_total_size() {
        let dir = temp_registry_dir();
        let mut reg = OfflineModelRegistry::new(dir.clone());
        reg.add_model(ModelEntry::new("m1", "1.0", "", 100, ModelSource::local("/tmp")));
        reg.add_model(ModelEntry::new("m2", "1.0", "", 200, ModelSource::local("/tmp")));
        reg.add_model(ModelEntry::new("m3", "1.0", "", 300, ModelSource::local("/tmp")));
        assert_eq!(reg.total_size(), 600);
        let _ = std::fs::remove_dir_all(&dir);
    }
}