vecboost 0.2.0

High-performance embedding vector service written in Rust
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
// Copyright (c) 2025-2026 Kirky.X
//
// Licensed under the MIT License
// See LICENSE file in the project root for full license information.

use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::fmt;
use std::path::PathBuf;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ModelType {
    Predefined(PredefinedModelType),
    Custom(String),
}

#[derive(Debug, Clone, PartialEq)]
pub enum PredefinedModelType {
    Bert,
    Roberta,
    M2Bert,
    SentenceBert,
}

impl<'de> Deserialize<'de> for PredefinedModelType {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        match s.to_lowercase().as_str() {
            "bert" => Ok(PredefinedModelType::Bert),
            "roberta" => Ok(PredefinedModelType::Roberta),
            "m2-bert" | "m2bert" => Ok(PredefinedModelType::M2Bert),
            "sentence-bert" => Ok(PredefinedModelType::SentenceBert),
            _ => Err(serde::de::Error::unknown_variant(
                &s,
                &["bert", "roberta", "m2-bert", "sentence-bert"],
            )),
        }
    }
}

impl Serialize for PredefinedModelType {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            PredefinedModelType::Bert => serializer.serialize_str("bert"),
            PredefinedModelType::Roberta => serializer.serialize_str("roberta"),
            PredefinedModelType::M2Bert => serializer.serialize_str("m2-bert"),
            PredefinedModelType::SentenceBert => serializer.serialize_str("sentence-bert"),
        }
    }
}

impl fmt::Display for ModelType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ModelType::Predefined(t) => write!(f, "{}", t.as_str()),
            ModelType::Custom(name) => write!(f, "{}", name),
        }
    }
}

impl PredefinedModelType {
    pub fn as_str(&self) -> &'static str {
        match self {
            PredefinedModelType::Bert => "bert",
            PredefinedModelType::Roberta => "roberta",
            PredefinedModelType::M2Bert => "m2-bert",
            PredefinedModelType::SentenceBert => "sentence-bert",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Precision {
    Fp32,
    Fp16,
    Int8,
}

impl fmt::Display for Precision {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Precision::Fp32 => write!(f, "fp32"),
            Precision::Fp16 => write!(f, "fp16"),
            Precision::Int8 => write!(f, "int8"),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InferenceContext {
    pub model_name: String,
    pub model_type: ModelType,
    pub engine_type: EngineType,
    pub device: DeviceType,
    pub precision: Precision,
    pub batch_size: usize,
    pub max_sequence_length: usize,
}

impl Default for InferenceContext {
    fn default() -> Self {
        Self {
            model_name: "default".to_string(),
            model_type: ModelType::Predefined(PredefinedModelType::M2Bert),
            engine_type: EngineType::Candle,
            device: DeviceType::Cpu,
            precision: Precision::Fp32,
            batch_size: 32,
            max_sequence_length: 8192,
        }
    }
}

impl InferenceContext {
    pub fn with_config(config: &ModelConfig, precision: Precision) -> Self {
        Self {
            model_name: config.name.clone(),
            model_type: ModelType::Predefined(PredefinedModelType::M2Bert),
            engine_type: config.engine_type.clone(),
            device: config.device.clone(),
            precision,
            batch_size: config.max_batch_size,
            max_sequence_length: 8192,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum EngineType {
    Candle,
    #[cfg(feature = "onnx")]
    Onnx,
}

impl fmt::Display for EngineType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            EngineType::Candle => write!(f, "candle"),
            #[cfg(feature = "onnx")]
            EngineType::Onnx => write!(f, "onnx"),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, utoipa::ToSchema)]
#[serde(rename_all = "lowercase")]
pub enum DeviceType {
    Cpu,
    Cuda,
    Metal,
    #[serde(rename = "amd")]
    Amd,
    #[serde(rename = "opencl")]
    OpenCL,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub enum PoolingMode {
    #[default]
    Mean,
    Max,
    Cls,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ModelConfig {
    pub name: String,
    pub engine_type: EngineType,
    pub model_path: PathBuf,
    pub tokenizer_path: Option<PathBuf>,
    pub device: DeviceType,
    pub max_batch_size: usize,
    pub pooling_mode: Option<PoolingMode>,
    pub expected_dimension: Option<usize>,
    pub memory_limit_bytes: Option<u64>,
    pub oom_fallback_enabled: bool,
    pub model_sha256: Option<String>,
}

impl Default for ModelConfig {
    fn default() -> Self {
        Self {
            name: "default".to_string(),
            engine_type: EngineType::Candle,
            model_path: PathBuf::from("models/default"),
            tokenizer_path: None,
            device: DeviceType::Cpu,
            max_batch_size: 32,
            pooling_mode: None,
            expected_dimension: None,
            memory_limit_bytes: None,
            oom_fallback_enabled: true,
            model_sha256: None,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ModelRepository {
    pub models: Vec<ModelConfig>,
}

impl Default for ModelRepository {
    fn default() -> Self {
        Self {
            models: vec![ModelConfig::default()],
        }
    }
}

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

    #[test]
    fn test_model_config_default() {
        let config = ModelConfig::default();
        assert_eq!(config.name, "default");
        assert_eq!(config.engine_type, EngineType::Candle);
        assert_eq!(config.device, DeviceType::Cpu);
        assert_eq!(config.max_batch_size, 32);
        assert_eq!(config.expected_dimension, None);
        assert_eq!(config.memory_limit_bytes, None);
        assert!(config.oom_fallback_enabled);
    }

    #[test]
    fn test_model_config_with_dimension() {
        let config = ModelConfig {
            name: "bge-m3".to_string(),
            engine_type: EngineType::Candle,
            model_path: PathBuf::from("/models/bge-m3"),
            tokenizer_path: Some(PathBuf::from("/models/bge-m3-tokenizer")),
            device: DeviceType::Cuda,
            max_batch_size: 64,
            pooling_mode: Some(PoolingMode::Mean),
            expected_dimension: Some(1024),
            memory_limit_bytes: Some(8 * 1024 * 1024 * 1024),
            oom_fallback_enabled: true,
            model_sha256: None,
        };

        assert_eq!(config.name, "bge-m3");
        assert_eq!(config.expected_dimension, Some(1024));
        assert_eq!(config.memory_limit_bytes, Some(8 * 1024 * 1024 * 1024));
    }

    #[test]
    fn test_model_config_serialization() {
        let config = ModelConfig {
            name: "bge-m3".to_string(),
            engine_type: EngineType::Candle,
            model_path: PathBuf::from("/models/bge-m3"),
            tokenizer_path: Some(PathBuf::from("/models/bge-m3-tokenizer")),
            device: DeviceType::Cuda,
            max_batch_size: 64,
            pooling_mode: Some(PoolingMode::Mean),
            expected_dimension: Some(1024),
            memory_limit_bytes: Some(8 * 1024 * 1024 * 1024),
            oom_fallback_enabled: true,
            model_sha256: None,
        };

        let json = serde_json::to_string(&config).unwrap();
        let decoded: ModelConfig = serde_json::from_str(&json).unwrap();

        assert_eq!(decoded.name, "bge-m3");
        assert_eq!(decoded.engine_type, EngineType::Candle);
        assert_eq!(decoded.device, DeviceType::Cuda);
        assert_eq!(decoded.expected_dimension, Some(1024));
        assert_eq!(decoded.memory_limit_bytes, Some(8 * 1024 * 1024 * 1024));
    }

    #[test]
    fn test_model_repository_default() {
        let repo = ModelRepository::default();
        assert_eq!(repo.models.len(), 1);
        assert_eq!(repo.models[0].name, "default");
    }

    #[test]
    fn test_engine_type_serialization() {
        let candle = EngineType::Candle;

        let candle_json = serde_json::to_string(&candle).unwrap();

        assert_eq!(candle_json, "\"candle\"");

        #[cfg(feature = "onnx")]
        {
            let onnx = EngineType::Onnx;
            let onnx_json = serde_json::to_string(&onnx).unwrap();
            assert_eq!(onnx_json, "\"onnx\"");
        }
    }

    #[test]
    fn test_device_type_serialization() {
        let cpu = DeviceType::Cpu;
        let cuda = DeviceType::Cuda;
        let metal = DeviceType::Metal;

        let cpu_json = serde_json::to_string(&cpu).unwrap();
        let cuda_json = serde_json::to_string(&cuda).unwrap();
        let metal_json = serde_json::to_string(&metal).unwrap();

        assert_eq!(cpu_json, "\"cpu\"");
        assert_eq!(cuda_json, "\"cuda\"");
        assert_eq!(metal_json, "\"metal\"");
    }

    #[test]
    fn test_model_type_serialization() {
        let bert = ModelType::Predefined(PredefinedModelType::Bert);
        let roberta = ModelType::Predefined(PredefinedModelType::Roberta);
        let m2_bert = ModelType::Predefined(PredefinedModelType::M2Bert);
        let sentence_bert = ModelType::Predefined(PredefinedModelType::SentenceBert);
        let custom = ModelType::Custom("custom_model".to_string());

        assert_eq!(serde_json::to_string(&bert).unwrap(), "\"bert\"");
        assert_eq!(serde_json::to_string(&roberta).unwrap(), "\"roberta\"");
        assert_eq!(serde_json::to_string(&m2_bert).unwrap(), "\"m2-bert\"");
        assert_eq!(
            serde_json::to_string(&sentence_bert).unwrap(),
            "\"sentence-bert\""
        );
        assert_eq!(serde_json::to_string(&custom).unwrap(), "\"custom_model\"");
    }

    #[test]
    fn test_precision_serialization() {
        let fp32 = Precision::Fp32;
        let fp16 = Precision::Fp16;
        let int8 = Precision::Int8;

        assert_eq!(serde_json::to_string(&fp32).unwrap(), "\"fp32\"");
        assert_eq!(serde_json::to_string(&fp16).unwrap(), "\"fp16\"");
        assert_eq!(serde_json::to_string(&int8).unwrap(), "\"int8\"");
    }

    #[test]
    fn test_inference_context_default() {
        let context = InferenceContext::default();

        assert_eq!(context.model_name, "default");
        assert_eq!(
            context.model_type,
            ModelType::Predefined(PredefinedModelType::M2Bert)
        );
        assert_eq!(context.engine_type, EngineType::Candle);
        assert_eq!(context.device, DeviceType::Cpu);
        assert_eq!(context.precision, Precision::Fp32);
        assert_eq!(context.batch_size, 32);
        assert_eq!(context.max_sequence_length, 8192);
    }

    #[test]
    fn test_inference_context_with_config() {
        let config = ModelConfig {
            name: "bge-m3".to_string(),
            engine_type: EngineType::Candle,
            model_path: PathBuf::from("/models/bge-m3"),
            tokenizer_path: Some(PathBuf::from("/models/bge-m3-tokenizer")),
            device: DeviceType::Cuda,
            max_batch_size: 64,
            pooling_mode: Some(PoolingMode::Mean),
            expected_dimension: Some(1024),
            memory_limit_bytes: None,
            oom_fallback_enabled: true,
            model_sha256: None,
        };

        let context = InferenceContext::with_config(&config, Precision::Fp16);

        assert_eq!(context.model_name, "bge-m3");
        assert_eq!(context.engine_type, EngineType::Candle);
        assert_eq!(context.device, DeviceType::Cuda);
        assert_eq!(context.precision, Precision::Fp16);
        assert_eq!(context.batch_size, 64);
    }

    #[test]
    fn test_inference_context_serialization() {
        let context = InferenceContext::default();
        let json = serde_json::to_string(&context).unwrap();
        let decoded: InferenceContext = serde_json::from_str(&json).unwrap();

        assert_eq!(decoded.model_name, "default");
        assert_eq!(
            decoded.model_type,
            ModelType::Predefined(PredefinedModelType::M2Bert)
        );
        assert_eq!(decoded.precision, Precision::Fp32);
    }

    #[test]
    fn test_model_type_display() {
        assert_eq!(
            ModelType::Predefined(PredefinedModelType::Bert).to_string(),
            "bert"
        );
        assert_eq!(
            ModelType::Predefined(PredefinedModelType::Roberta).to_string(),
            "roberta"
        );
        assert_eq!(
            ModelType::Predefined(PredefinedModelType::M2Bert).to_string(),
            "m2-bert"
        );
        assert_eq!(
            ModelType::Predefined(PredefinedModelType::SentenceBert).to_string(),
            "sentence-bert"
        );
        assert_eq!(
            ModelType::Custom("custom".to_string()).to_string(),
            "custom"
        );
    }

    #[test]
    fn test_precision_display() {
        assert_eq!(Precision::Fp32.to_string(), "fp32");
        assert_eq!(Precision::Fp16.to_string(), "fp16");
        assert_eq!(Precision::Int8.to_string(), "int8");
    }
}