autoagents-llamacpp 0.3.7

Agent Framework for Building Autonomous Agents
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

//! Model source definitions for llama.cpp backend.

use serde::{Deserialize, Serialize};

/// Source type for loading models.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ModelSource {
    /// Local GGUF file path.
    Gguf {
        /// Path to a GGUF model file.
        model_path: String,
    },
    /// HuggingFace repository ID.
    HuggingFace {
        /// HuggingFace repo ID (e.g. "org/model").
        repo_id: String,
        /// Optional GGUF filename override.
        filename: Option<String>,
        /// Optional MTMD mmproj filename override.
        mmproj_filename: Option<String>,
    },
}

impl ModelSource {
    /// Convenience constructor for a local GGUF model.
    pub fn gguf(model_path: impl Into<String>) -> Self {
        Self::Gguf {
            model_path: model_path.into(),
        }
    }

    /// Convenience constructor for a HuggingFace model repository.
    pub fn huggingface(repo_id: impl Into<String>) -> Self {
        Self::HuggingFace {
            repo_id: repo_id.into(),
            filename: None,
            mmproj_filename: None,
        }
    }

    /// Convenience constructor for a HuggingFace repo with a GGUF filename override.
    pub fn huggingface_with_filename(
        repo_id: impl Into<String>,
        filename: impl Into<String>,
    ) -> Self {
        Self::HuggingFace {
            repo_id: repo_id.into(),
            filename: Some(filename.into()),
            mmproj_filename: None,
        }
    }

    /// Convenience constructor for a HuggingFace repo with a GGUF + mmproj filename override.
    pub fn huggingface_with_mmproj(
        repo_id: impl Into<String>,
        filename: impl Into<String>,
        mmproj_filename: impl Into<String>,
    ) -> Self {
        Self::HuggingFace {
            repo_id: repo_id.into(),
            filename: Some(filename.into()),
            mmproj_filename: Some(mmproj_filename.into()),
        }
    }

    /// Return the model path for this source.
    pub fn model_path(&self) -> Option<&str> {
        match self {
            ModelSource::Gguf { model_path } => Some(model_path),
            ModelSource::HuggingFace { .. } => None,
        }
    }
}

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

    #[test]
    fn test_model_source_path() {
        let source = ModelSource::gguf("test.gguf");
        assert_eq!(source.model_path(), Some("test.gguf"));
    }

    #[test]
    fn test_model_source_hf() {
        let source = ModelSource::huggingface("org/model");
        assert!(source.model_path().is_none());
        assert_eq!(
            source,
            ModelSource::HuggingFace {
                repo_id: "org/model".to_string(),
                filename: None,
                mmproj_filename: None,
            }
        );
    }
}