tomaarsen HF Staff commited on
Commit
02dbe98
·
verified ·
1 Parent(s): 7d1aa07

Add new SentenceTransformer model

Browse files

Hello!

*This pull request has been automatically generated from the [`push_to_hub`](https://sbert.net/docs/package_reference/sentence_transformer/SentenceTransformer.html#sentence_transformers.SentenceTransformer.push_to_hub) method from the Sentence Transformers library.*

## Full Model Architecture:
```
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False, 'architecture': 'BertModel'})
(1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
(2): Normalize()
)
```

## Tip:
Consider testing this pull request before merging by loading the model from this PR with the `revision` argument:
```python
from sentence_transformers import SentenceTransformer

# TODO: Fill in the PR number
pr_number = 2
model = SentenceTransformer(
"clips/e5-small-trm",
revision=f"refs/pr/{pr_number}",
backend="torch",
)

# Verify that everything works as expected
embeddings = model.encode(["The weather is lovely today.", "It's so sunny outside!", "He drove to the stadium."])
print(embeddings.shape)

similarities = model.similarity(embeddings, embeddings)
print(similarities)
```

1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 384,
3
+ "pooling_mode_cls_token": false,
4
+ "pooling_mode_mean_tokens": true,
5
+ "pooling_mode_max_tokens": false,
6
+ "pooling_mode_mean_sqrt_len_tokens": false,
7
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md CHANGED
@@ -1,10 +1,12 @@
1
  ---
2
  license: mit
3
- language:
4
- - nl
5
  base_model:
6
  - intfloat/multilingual-e5-small
7
  pipeline_tag: sentence-similarity
 
 
 
8
  ---
9
  # E5-small-trm
10
 
@@ -70,14 +72,29 @@ print(scores.tolist())
70
  Below is an example for usage with sentence_transformers.
71
  ```python
72
  from sentence_transformers import SentenceTransformer
73
- model = SentenceTransformer('clips/e5-small-trm')
74
- input_texts = [
75
- 'query: hoeveel eiwitten moet een vrouw eten',
76
- 'query: top definieer',
77
- "passage: Als algemene richtlijn geldt dat de gemiddelde eiwitbehoefte voor vrouwen van 19 tot 70 jaar volgens de CDC 46 gram per dag bedraagt. Maar, zoals je in deze tabel kunt zien, moet je dit verhogen als je zwanger bent of traint voor een marathon. Bekijk de onderstaande tabel om te zien hoeveel eiwitten je dagelijks zou moeten eten.",
78
- "passage: Definitie van top voor leerlingen Engels. : 1 het hoogste punt van een berg : de top van een berg. : 2 het hoogste niveau. : 3 een bijeenkomst of reeks bijeenkomsten tussen de leiders van twee of meer regeringen."
 
 
 
 
 
 
 
 
79
  ]
80
- embeddings = model.encode(input_texts, normalize_embeddings=True)
 
 
 
 
 
 
 
81
  ```
82
 
83
 
 
1
  ---
2
  license: mit
3
+ language: nl
 
4
  base_model:
5
  - intfloat/multilingual-e5-small
6
  pipeline_tag: sentence-similarity
7
+ library_name: sentence-transformers
8
+ tags:
9
+ - transformers
10
  ---
11
  # E5-small-trm
12
 
 
72
  Below is an example for usage with sentence_transformers.
73
  ```python
74
  from sentence_transformers import SentenceTransformer
75
+
76
+ # Load the model from Hugging Face
77
+ model = SentenceTransformer("clips/e5-small-trm")
78
+
79
+ # Perform inference using encode_query/encode_document for retrieval,
80
+ # or encode_query for general purpose embeddings. Prompt prefixes
81
+ # are automatically added with these two methods.
82
+ queries = [
83
+ 'hoeveel eiwitten moet een vrouw eten',
84
+ 'top definieer',
85
+ ]
86
+ documents = [
87
+ 'Als algemene richtlijn geldt dat de gemiddelde eiwitbehoefte voor vrouwen van 19 tot 70 jaar volgens de CDC 46 gram per dag bedraagt. Maar, zoals je in deze tabel kunt zien, moet je dit verhogen als je zwanger bent of traint voor een marathon. Bekijk de onderstaande tabel om te zien hoeveel eiwitten je dagelijks zou moeten eten.',
88
+ 'Definitie van top voor leerlingen Engels. : 1 het hoogste punt van een berg : de top van een berg. : 2 het hoogste niveau. : 3 een bijeenkomst of reeks bijeenkomsten tussen de leiders van twee of meer regeringen.',
89
  ]
90
+ query_embeddings = model.encode_query(queries)
91
+ document_embeddings = model.encode_document(documents)
92
+ print(query_embeddings.shape, document_embeddings.shape)
93
+ # (2, 384) (2, 384)
94
+
95
+ similarities = model.similarity(query_embeddings, document_embeddings)
96
+ # tensor([[0.9170, 0.7387],
97
+ # [0.7429, 0.9058]])
98
  ```
99
 
100
 
config_sentence_transformers.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "model_type": "SentenceTransformer",
3
+ "__version__": {
4
+ "sentence_transformers": "5.1.0",
5
+ "transformers": "4.56.1",
6
+ "pytorch": "2.7.1+cu126"
7
+ },
8
+ "prompts": {
9
+ "query": "query: ",
10
+ "document": "passage: "
11
+ },
12
+ "default_prompt_name": null,
13
+ "similarity_fn_name": "cosine"
14
+ }
modules.json ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "idx": 0,
4
+ "name": "0",
5
+ "path": "",
6
+ "type": "sentence_transformers.models.Transformer"
7
+ },
8
+ {
9
+ "idx": 1,
10
+ "name": "1",
11
+ "path": "1_Pooling",
12
+ "type": "sentence_transformers.models.Pooling"
13
+ },
14
+ {
15
+ "idx": 2,
16
+ "name": "2",
17
+ "path": "2_Normalize",
18
+ "type": "sentence_transformers.models.Normalize"
19
+ }
20
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 512,
3
+ "do_lower_case": false
4
+ }