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
use serde::{Deserialize, Serialize};
use tch::Device;

use crate::pipelines::common::ModelType;
use crate::resources::ResourceProvider;
use crate::{Config, RustBertError};

#[cfg(feature = "remote")]
use crate::{
    albert::{AlbertConfigResources, AlbertModelResources, AlbertVocabResources},
    bert::{BertConfigResources, BertModelResources, BertVocabResources},
    distilbert::{DistilBertConfigResources, DistilBertModelResources, DistilBertVocabResources},
    pipelines::sentence_embeddings::resources::{
        SentenceEmbeddingsConfigResources, SentenceEmbeddingsModelType,
        SentenceEmbeddingsModulesConfigResources, SentenceEmbeddingsPoolingConfigResources,
        SentenceEmbeddingsTokenizerConfigResources,
    },
    pipelines::sentence_embeddings::{
        SentenceEmbeddingsDenseConfigResources, SentenceEmbeddingsDenseResources,
    },
    resources::RemoteResource,
    roberta::{
        RobertaConfigResources, RobertaMergesResources, RobertaModelResources,
        RobertaVocabResources,
    },
    t5::{T5ConfigResources, T5ModelResources, T5VocabResources},
};

/// # Configuration for sentence embeddings
///
/// Contains information regarding the transformer model to load, the optional extra
/// layers, and device to place the model on.
pub struct SentenceEmbeddingsConfig {
    /// Modules configuration resource, contains layers definition
    pub modules_config_resource: Box<dyn ResourceProvider + Send>,
    /// Transformer model type
    pub transformer_type: ModelType,
    /// Transformer model configuration resource
    pub transformer_config_resource: Box<dyn ResourceProvider + Send>,
    /// Transformer weights resource
    pub transformer_weights_resource: Box<dyn ResourceProvider + Send>,
    /// Pooling layer configuration resource
    pub pooling_config_resource: Box<dyn ResourceProvider + Send>,
    /// Optional dense layer configuration resource
    pub dense_config_resource: Option<Box<dyn ResourceProvider + Send>>,
    /// Optional dense layer weights resource
    pub dense_weights_resource: Option<Box<dyn ResourceProvider + Send>>,
    /// Sentence BERT specific configuration resource
    pub sentence_bert_config_resource: Box<dyn ResourceProvider + Send>,
    /// Transformer's tokenizer configuration resource
    pub tokenizer_config_resource: Box<dyn ResourceProvider + Send>,
    /// Transformer's tokenizer vocab resource
    pub tokenizer_vocab_resource: Box<dyn ResourceProvider + Send>,
    /// Optional transformer's tokenizer merges resource
    pub tokenizer_merges_resource: Option<Box<dyn ResourceProvider + Send>>,
    /// Device to place the transformer model on
    pub device: Device,
}

#[cfg(feature = "remote")]
impl From<SentenceEmbeddingsModelType> for SentenceEmbeddingsConfig {
    fn from(model_type: SentenceEmbeddingsModelType) -> Self {
        match model_type {
            SentenceEmbeddingsModelType::DistiluseBaseMultilingualCased => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                transformer_type: ModelType::DistilBert,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    DistilBertConfigResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    DistilBertModelResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                dense_config_resource: Some(Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsDenseConfigResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                ))),
                dense_weights_resource: Some(Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsDenseResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                ))),
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    DistilBertVocabResources::DISTILUSE_BASE_MULTILINGUAL_CASED,
                )),
                tokenizer_merges_resource: None,
                device: Device::cuda_if_available(),
            },

            SentenceEmbeddingsModelType::BertBaseNliMeanTokens => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                transformer_type: ModelType::Bert,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    BertConfigResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    BertModelResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                dense_config_resource: None,
                dense_weights_resource: None,
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    BertVocabResources::BERT_BASE_NLI_MEAN_TOKENS,
                )),
                tokenizer_merges_resource: None,
                device: Device::cuda_if_available(),
            },

            SentenceEmbeddingsModelType::AllMiniLmL12V2 => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::ALL_MINI_LM_L12_V2,
                )),
                transformer_type: ModelType::Bert,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    BertConfigResources::ALL_MINI_LM_L12_V2,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    BertModelResources::ALL_MINI_LM_L12_V2,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::ALL_MINI_LM_L12_V2,
                )),
                dense_config_resource: None,
                dense_weights_resource: None,
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::ALL_MINI_LM_L12_V2,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::ALL_MINI_LM_L12_V2,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    BertVocabResources::ALL_MINI_LM_L12_V2,
                )),
                tokenizer_merges_resource: None,
                device: Device::cuda_if_available(),
            },

            SentenceEmbeddingsModelType::AllMiniLmL6V2 => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::ALL_MINI_LM_L6_V2,
                )),
                transformer_type: ModelType::Bert,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    BertConfigResources::ALL_MINI_LM_L6_V2,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    BertModelResources::ALL_MINI_LM_L6_V2,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::ALL_MINI_LM_L6_V2,
                )),
                dense_config_resource: None,
                dense_weights_resource: None,
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::ALL_MINI_LM_L6_V2,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::ALL_MINI_LM_L6_V2,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    BertVocabResources::ALL_MINI_LM_L6_V2,
                )),
                tokenizer_merges_resource: None,
                device: Device::cuda_if_available(),
            },

            SentenceEmbeddingsModelType::AllDistilrobertaV1 => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::ALL_DISTILROBERTA_V1,
                )),
                transformer_type: ModelType::Roberta,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    RobertaConfigResources::ALL_DISTILROBERTA_V1,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    RobertaModelResources::ALL_DISTILROBERTA_V1,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::ALL_DISTILROBERTA_V1,
                )),
                dense_config_resource: None,
                dense_weights_resource: None,
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::ALL_DISTILROBERTA_V1,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::ALL_DISTILROBERTA_V1,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    RobertaVocabResources::ALL_DISTILROBERTA_V1,
                )),
                tokenizer_merges_resource: Some(Box::new(RemoteResource::from_pretrained(
                    RobertaMergesResources::ALL_DISTILROBERTA_V1,
                ))),
                device: Device::cuda_if_available(),
            },

            SentenceEmbeddingsModelType::ParaphraseAlbertSmallV2 => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                transformer_type: ModelType::Albert,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    AlbertConfigResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    AlbertModelResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                dense_config_resource: None,
                dense_weights_resource: None,
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    AlbertVocabResources::PARAPHRASE_ALBERT_SMALL_V2,
                )),
                tokenizer_merges_resource: None,
                device: Device::cuda_if_available(),
            },

            SentenceEmbeddingsModelType::SentenceT5Base => SentenceEmbeddingsConfig {
                modules_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsModulesConfigResources::SENTENCE_T5_BASE,
                )),
                transformer_type: ModelType::T5,
                transformer_config_resource: Box::new(RemoteResource::from_pretrained(
                    T5ConfigResources::SENTENCE_T5_BASE,
                )),
                transformer_weights_resource: Box::new(RemoteResource::from_pretrained(
                    T5ModelResources::SENTENCE_T5_BASE,
                )),
                pooling_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsPoolingConfigResources::SENTENCE_T5_BASE,
                )),
                dense_config_resource: Some(Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsDenseConfigResources::SENTENCE_T5_BASE,
                ))),
                dense_weights_resource: Some(Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsDenseResources::SENTENCE_T5_BASE,
                ))),
                sentence_bert_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsConfigResources::SENTENCE_T5_BASE,
                )),
                tokenizer_config_resource: Box::new(RemoteResource::from_pretrained(
                    SentenceEmbeddingsTokenizerConfigResources::SENTENCE_T5_BASE,
                )),
                tokenizer_vocab_resource: Box::new(RemoteResource::from_pretrained(
                    T5VocabResources::SENTENCE_T5_BASE,
                )),
                tokenizer_merges_resource: None,
                device: Device::cuda_if_available(),
            },
        }
    }
}

/// Configuration for the modules that define the model's layers
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SentenceEmbeddingsModulesConfig(pub Vec<SentenceEmbeddingsModuleConfig>);

impl std::ops::Deref for SentenceEmbeddingsModulesConfig {
    type Target = Vec<SentenceEmbeddingsModuleConfig>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl std::ops::DerefMut for SentenceEmbeddingsModulesConfig {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl From<Vec<SentenceEmbeddingsModuleConfig>> for SentenceEmbeddingsModulesConfig {
    fn from(source: Vec<SentenceEmbeddingsModuleConfig>) -> Self {
        Self(source)
    }
}

impl Config for SentenceEmbeddingsModulesConfig {}

impl SentenceEmbeddingsModulesConfig {
    pub fn validate(self) -> Result<Self, RustBertError> {
        match self.get(0) {
            Some(SentenceEmbeddingsModuleConfig {
                module_type: SentenceEmbeddingsModuleType::Transformer,
                ..
            }) => (),
            Some(_) => {
                return Err(RustBertError::InvalidConfigurationError(
                    "First module defined in modules.json must be a Transformer".to_string(),
                ));
            }
            None => {
                return Err(RustBertError::InvalidConfigurationError(
                    "No modules found in modules.json".to_string(),
                ));
            }
        }

        match self.get(1) {
            Some(SentenceEmbeddingsModuleConfig {
                module_type: SentenceEmbeddingsModuleType::Pooling,
                ..
            }) => (),
            Some(_) => {
                return Err(RustBertError::InvalidConfigurationError(
                    "Second module defined in modules.json must be a Pooling".to_string(),
                ));
            }
            None => {
                return Err(RustBertError::InvalidConfigurationError(
                    "Pooling module not found in second position in modules.json".to_string(),
                ));
            }
        }

        Ok(self)
    }

    pub fn transformer_module(&self) -> &SentenceEmbeddingsModuleConfig {
        self.get(0).as_ref().unwrap()
    }

    pub fn pooling_module(&self) -> &SentenceEmbeddingsModuleConfig {
        self.get(1).as_ref().unwrap()
    }

    pub fn dense_module(&self) -> Option<&SentenceEmbeddingsModuleConfig> {
        for i in 2..=3 {
            if let Some(SentenceEmbeddingsModuleConfig {
                module_type: SentenceEmbeddingsModuleType::Dense,
                ..
            }) = self.get(i)
            {
                return self.get(i);
            }
        }
        None
    }

    pub fn has_normalization(&self) -> bool {
        for i in 2..=3 {
            if let Some(SentenceEmbeddingsModuleConfig {
                module_type: SentenceEmbeddingsModuleType::Normalize,
                ..
            }) = self.get(i)
            {
                return true;
            }
        }
        false
    }
}

/// Configuration defining a single module (model's layer)
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SentenceEmbeddingsModuleConfig {
    pub idx: usize,
    pub name: String,
    pub path: String,
    #[serde(rename = "type")]
    #[serde(with = "serde_sentence_embeddings_module_type")]
    pub module_type: SentenceEmbeddingsModuleType,
}

/// Available module types, based on Sentence-Transformers
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum SentenceEmbeddingsModuleType {
    Transformer,
    Pooling,
    Dense,
    Normalize,
}

mod serde_sentence_embeddings_module_type {
    use super::SentenceEmbeddingsModuleType;
    use serde::{de, Deserializer, Serializer};

    pub fn serialize<S>(
        module_type: &SentenceEmbeddingsModuleType,
        serializer: S,
    ) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&format!("sentence_transformers.models.{module_type:?}"))
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<SentenceEmbeddingsModuleType, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct SentenceEmbeddingsModuleTypeVisitor;

        impl de::Visitor<'_> for SentenceEmbeddingsModuleTypeVisitor {
            type Value = SentenceEmbeddingsModuleType;

            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("a sentence embeddings module type")
            }

            fn visit_str<E: de::Error>(self, s: &str) -> Result<Self::Value, E> {
                s.split('.')
                    .last()
                    .map(|s| serde_json::from_value(serde_json::Value::String(s.to_string())))
                    .transpose()
                    .map_err(de::Error::custom)?
                    .ok_or_else(|| format!("Invalid SentenceEmbeddingsModuleType: {s}"))
                    .map_err(de::Error::custom)
            }
        }

        deserializer.deserialize_str(SentenceEmbeddingsModuleTypeVisitor)
    }
}

/// Configuration for Sentence-Transformers specific parameters
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SentenceEmbeddingsSentenceBertConfig {
    pub max_seq_length: usize,
    pub do_lower_case: bool,
}

impl Config for SentenceEmbeddingsSentenceBertConfig {}

/// Configuration for transformer's tokenizer
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SentenceEmbeddingsTokenizerConfig {
    pub add_prefix_space: Option<bool>,
    pub strip_accents: Option<bool>,
    pub do_lower_case: Option<bool>,
}

impl Config for SentenceEmbeddingsTokenizerConfig {}