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
use core::fmt;
use std::str::FromStr;

#[derive(Clone, Debug)]
pub struct GGufFileName {
    model: String,
    version: Version,
    parameters: ParameterScale,
    encoding_scheme: String,
    shard: Shard,
}

#[derive(Clone, Debug)]
pub enum GGufFileNameError {
    InvalidNameExt,
    InvalidShard,
    EncodingSchemeNotExists,
    ParametersNotExists,
    InvalidParameters,
    InvalidVersion,
}

impl FromStr for GGufFileName {
    type Err = GGufFileNameError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let Some(s) = s.strip_suffix(".gguf") else {
            return Err(Self::Err::InvalidNameExt);
        };
        let s = s.split('-').collect::<Vec<_>>();
        // 解析分片信息
        let (s, shard) = if let [s @ .., index, "of", total] = &*s {
            let index = index.parse().map_err(|_| Self::Err::InvalidShard)?;
            let total = total.parse().map_err(|_| Self::Err::InvalidShard)?;
            (s, Shard { index, total })
        } else {
            (&*s, Shard::SINGLE)
        };
        // 解析编码方案
        let (s, encoding_scheme) = if let [s @ .., scheme] = s {
            (s, scheme.to_string())
        } else {
            return Err(Self::Err::EncodingSchemeNotExists);
        };
        // 解析参数量
        let (s, parameters) = if let [s @ .., params] = s {
            let (experts_count, params) = if let Some((experts, params)) = params.split_once('x') {
                (
                    experts.parse().map_err(|_| Self::Err::InvalidParameters)?,
                    params,
                )
            } else {
                (0, *params)
            };
            let (count, prefix) = match params.as_bytes() {
                [c @ .., b'Q'] => (c, ScalePrefix::Q),
                [c @ .., b'T'] => (c, ScalePrefix::T),
                [c @ .., b'B'] => (c, ScalePrefix::B),
                [c @ .., b'M'] => (c, ScalePrefix::M),
                [c @ .., b'K'] => (c, ScalePrefix::K),
                _ => return Err(Self::Err::InvalidParameters),
            };
            let count = std::str::from_utf8(count)
                .map_err(|_| Self::Err::InvalidParameters)?
                .parse()
                .map_err(|_| Self::Err::InvalidParameters)?;
            (
                s,
                ParameterScale {
                    experts_count,
                    count,
                    prefix,
                },
            )
        } else {
            return Err(Self::Err::ParametersNotExists);
        };
        // 解析版本
        let (s, version) = if let [head @ .., version] = s {
            if let Ok(version) = version.parse::<Version>() {
                (head, version)
            } else {
                (s, Version::PRERELEASE)
            }
        } else {
            return Err(Self::Err::InvalidVersion);
        };
        Ok(Self {
            model: s.join(" "),
            version,
            parameters,
            encoding_scheme,
            shard,
        })
    }
}

impl fmt::Display for GGufFileName {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.model.replace(' ', "-"))?;
        if self.version != Version::PRERELEASE {
            write!(f, "-v{}.{}", self.version.major, self.version.minor)?;
        }
        write!(f, "-{}-{}", self.parameters, self.encoding_scheme)?;
        if self.shard != Shard::SINGLE {
            write!(f, "-{:05}-of-{:05}", self.shard.index, self.shard.total)?;
        }
        write!(f, ".gguf")
    }
}

#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Version {
    major: u32,
    minor: u32,
}

impl FromStr for Version {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let (major, minor) = s.strip_prefix('v').ok_or(())?.split_once('.').ok_or(())?;
        Ok(Self {
            major: major.parse().map_err(|_| ())?,
            minor: minor.parse().map_err(|_| ())?,
        })
    }
}

impl Version {
    pub const PRERELEASE: Self = Self { major: 0, minor: 0 };
}

#[derive(Clone, PartialEq, Debug)]
pub struct ParameterScale {
    experts_count: u32,
    count: f32,
    prefix: ScalePrefix,
}

#[derive(Clone, Copy, PartialEq, Eq, Debug)]
#[repr(u8)]
pub enum ScalePrefix {
    Q,
    T,
    B,
    M,
    K,
}

impl fmt::Display for ParameterScale {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if self.experts_count != 0 {
            write!(f, "{}x", self.experts_count)?;
        }
        write!(f, "{}", self.count)?;
        match self.prefix {
            ScalePrefix::Q => write!(f, "Q"),
            ScalePrefix::T => write!(f, "T"),
            ScalePrefix::B => write!(f, "B"),
            ScalePrefix::M => write!(f, "M"),
            ScalePrefix::K => write!(f, "K"),
        }
    }
}

#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub struct Shard {
    index: u16,
    total: u16,
}

impl Shard {
    pub const SINGLE: Self = Self { index: 0, total: 1 };
}

#[test]
fn test_parse_filename() {
    assert!(matches!(
        "Mixtral-v0.1-8x7B-Q2_K".parse::<GGufFileName>(),
        Err(GGufFileNameError::InvalidNameExt)
    ));
    assert!(matches!(
        "Mixtral-v0.1-8x7B.gguf".parse::<GGufFileName>(),
        Err(GGufFileNameError::InvalidParameters)
    ));
    assert!(matches!(
        "Mixtral-v0.1-8x7H-Q2_K.gguf".parse::<GGufFileName>(),
        Err(GGufFileNameError::InvalidParameters)
    ));
    let Ok(name) = "Mixtral-8x7B-Q2_K.gguf".parse::<GGufFileName>() else {
        panic!()
    };
    assert_eq!(name.model, "Mixtral");
    assert_eq!(name.version, Version::PRERELEASE);
    assert_eq!(
        name.parameters,
        ParameterScale {
            experts_count: 8,
            count: 7.0,
            prefix: ScalePrefix::B,
        }
    );
    assert_eq!(name.encoding_scheme, "Q2_K");
}