KasuleTrevor commited on
Commit
b063c4f
·
verified ·
1 Parent(s): e54ce91

Add new SentenceTransformer model.

Browse files
.gitattributes CHANGED
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ tokenizer.json filter=lfs diff=lfs merge=lfs -text
1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 768,
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 ADDED
@@ -0,0 +1,353 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: FacebookAI/xlm-roberta-base
3
+ library_name: sentence-transformers
4
+ pipeline_tag: sentence-similarity
5
+ tags:
6
+ - sentence-transformers
7
+ - sentence-similarity
8
+ - feature-extraction
9
+ - generated_from_trainer
10
+ - dataset_size:7106
11
+ - loss:MultipleNegativesRankingLoss
12
+ widget:
13
+ - source_sentence: why should a farmer castrate his/her animals
14
+ sentences:
15
+ - In what situations should farmers consider castrating their animals?
16
+ - How can I prevent annual parasite attacks on my chickens?
17
+ - In what ways can a farmer ascertain the viability of coffee berries?
18
+ - source_sentence: what are the ecological requirements for sesame production
19
+ sentences:
20
+ - What ecological conditions are necessary for growing sesame?
21
+ - Which is the best spacing in tomato transplanting?(for each type of tomatoes)
22
+ - what is the best season for planting cassava
23
+ - source_sentence: What causes very watery milk in cows?
24
+ sentences:
25
+ - What results in cows having exceptionally watery milk?
26
+ - What can I do for my sow that has given birth and has no milk?
27
+ - What type of tomato seeds should I use for planting?
28
+ - source_sentence: the two females are from the same mother and then the male is from
29
+ another mother
30
+ sentences:
31
+ - How does grey leaf spot disease spread?
32
+ - How is mulching implemented in coffee plant care?
33
+ - The two female offspring share a mother, and the male offspring has a separate
34
+ mother
35
+ - source_sentence: What is anaplasmosis as applied in animal health
36
+ sentences:
37
+ - What is anaplasmosis in the context of animal health?
38
+ - What is the primary requirement for tomatoes?
39
+ - What causes chickens to reduce their feed intake at times?
40
+ ---
41
+
42
+ # SentenceTransformer based on FacebookAI/xlm-roberta-base
43
+
44
+ This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [FacebookAI/xlm-roberta-base](https://huggingface.co/FacebookAI/xlm-roberta-base). It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
45
+
46
+ ## Model Details
47
+
48
+ ### Model Description
49
+ - **Model Type:** Sentence Transformer
50
+ - **Base model:** [FacebookAI/xlm-roberta-base](https://huggingface.co/FacebookAI/xlm-roberta-base) <!-- at revision e73636d4f797dec63c3081bb6ed5c7b0bb3f2089 -->
51
+ - **Maximum Sequence Length:** 512 tokens
52
+ - **Output Dimensionality:** 768 tokens
53
+ - **Similarity Function:** Cosine Similarity
54
+ <!-- - **Training Dataset:** Unknown -->
55
+ <!-- - **Language:** Unknown -->
56
+ <!-- - **License:** Unknown -->
57
+
58
+ ### Model Sources
59
+
60
+ - **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
61
+ - **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
62
+ - **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
63
+
64
+ ### Full Model Architecture
65
+
66
+ ```
67
+ SentenceTransformer(
68
+ (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: XLMRobertaModel
69
+ (1): Pooling({'word_embedding_dimension': 768, '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})
70
+ )
71
+ ```
72
+
73
+ ## Usage
74
+
75
+ ### Direct Usage (Sentence Transformers)
76
+
77
+ First install the Sentence Transformers library:
78
+
79
+ ```bash
80
+ pip install -U sentence-transformers
81
+ ```
82
+
83
+ Then you can load this model and run inference.
84
+ ```python
85
+ from sentence_transformers import SentenceTransformer
86
+
87
+ # Download from the 🤗 Hub
88
+ model = SentenceTransformer("KasuleTrevor/Roberta-base-lug-QQ")
89
+ # Run inference
90
+ sentences = [
91
+ 'What is anaplasmosis as applied in animal health',
92
+ 'What is anaplasmosis in the context of animal health?',
93
+ 'What is the primary requirement for tomatoes?',
94
+ ]
95
+ embeddings = model.encode(sentences)
96
+ print(embeddings.shape)
97
+ # [3, 768]
98
+
99
+ # Get the similarity scores for the embeddings
100
+ similarities = model.similarity(embeddings, embeddings)
101
+ print(similarities.shape)
102
+ # [3, 3]
103
+ ```
104
+
105
+ <!--
106
+ ### Direct Usage (Transformers)
107
+
108
+ <details><summary>Click to see the direct usage in Transformers</summary>
109
+
110
+ </details>
111
+ -->
112
+
113
+ <!--
114
+ ### Downstream Usage (Sentence Transformers)
115
+
116
+ You can finetune this model on your own dataset.
117
+
118
+ <details><summary>Click to expand</summary>
119
+
120
+ </details>
121
+ -->
122
+
123
+ <!--
124
+ ### Out-of-Scope Use
125
+
126
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
127
+ -->
128
+
129
+ <!--
130
+ ## Bias, Risks and Limitations
131
+
132
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
133
+ -->
134
+
135
+ <!--
136
+ ### Recommendations
137
+
138
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
139
+ -->
140
+
141
+ ## Training Details
142
+
143
+ ### Training Dataset
144
+
145
+ #### Unnamed Dataset
146
+
147
+
148
+ * Size: 7,106 training samples
149
+ * Columns: <code>sentence_0</code> and <code>sentence_1</code>
150
+ * Approximate statistics based on the first 1000 samples:
151
+ | | sentence_0 | sentence_1 |
152
+ |:--------|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|
153
+ | type | string | string |
154
+ | details | <ul><li>min: 7 tokens</li><li>mean: 16.59 tokens</li><li>max: 77 tokens</li></ul> | <ul><li>min: 7 tokens</li><li>mean: 17.84 tokens</li><li>max: 116 tokens</li></ul> |
155
+ * Samples:
156
+ | sentence_0 | sentence_1 |
157
+ |:-------------------------------------------------------------------------|:-------------------------------------------------------------------------------|
158
+ | <code>What makes tomatoes fade at various stages and finally die?</code> | <code>What makes tomatoes fade at various stages and finally die?</code> |
159
+ | <code>Which concentrates are needed to boost the chickens fast?</code> | <code>What concentrates are required to enhance chicken growth quickly?</code> |
160
+ | <code>How long does avocado take to mature to be harvested?</code> | <code>How long does avocado take to mature to be harvested?</code> |
161
+ * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
162
+ ```json
163
+ {
164
+ "scale": 20.0,
165
+ "similarity_fct": "cos_sim"
166
+ }
167
+ ```
168
+
169
+ ### Training Hyperparameters
170
+ #### Non-Default Hyperparameters
171
+
172
+ - `num_train_epochs`: 1
173
+ - `multi_dataset_batch_sampler`: round_robin
174
+
175
+ #### All Hyperparameters
176
+ <details><summary>Click to expand</summary>
177
+
178
+ - `overwrite_output_dir`: False
179
+ - `do_predict`: False
180
+ - `eval_strategy`: no
181
+ - `prediction_loss_only`: True
182
+ - `per_device_train_batch_size`: 8
183
+ - `per_device_eval_batch_size`: 8
184
+ - `per_gpu_train_batch_size`: None
185
+ - `per_gpu_eval_batch_size`: None
186
+ - `gradient_accumulation_steps`: 1
187
+ - `eval_accumulation_steps`: None
188
+ - `torch_empty_cache_steps`: None
189
+ - `learning_rate`: 5e-05
190
+ - `weight_decay`: 0.0
191
+ - `adam_beta1`: 0.9
192
+ - `adam_beta2`: 0.999
193
+ - `adam_epsilon`: 1e-08
194
+ - `max_grad_norm`: 1
195
+ - `num_train_epochs`: 1
196
+ - `max_steps`: -1
197
+ - `lr_scheduler_type`: linear
198
+ - `lr_scheduler_kwargs`: {}
199
+ - `warmup_ratio`: 0.0
200
+ - `warmup_steps`: 0
201
+ - `log_level`: passive
202
+ - `log_level_replica`: warning
203
+ - `log_on_each_node`: True
204
+ - `logging_nan_inf_filter`: True
205
+ - `save_safetensors`: True
206
+ - `save_on_each_node`: False
207
+ - `save_only_model`: False
208
+ - `restore_callback_states_from_checkpoint`: False
209
+ - `no_cuda`: False
210
+ - `use_cpu`: False
211
+ - `use_mps_device`: False
212
+ - `seed`: 42
213
+ - `data_seed`: None
214
+ - `jit_mode_eval`: False
215
+ - `use_ipex`: False
216
+ - `bf16`: False
217
+ - `fp16`: False
218
+ - `fp16_opt_level`: O1
219
+ - `half_precision_backend`: auto
220
+ - `bf16_full_eval`: False
221
+ - `fp16_full_eval`: False
222
+ - `tf32`: None
223
+ - `local_rank`: 0
224
+ - `ddp_backend`: None
225
+ - `tpu_num_cores`: None
226
+ - `tpu_metrics_debug`: False
227
+ - `debug`: []
228
+ - `dataloader_drop_last`: False
229
+ - `dataloader_num_workers`: 0
230
+ - `dataloader_prefetch_factor`: None
231
+ - `past_index`: -1
232
+ - `disable_tqdm`: False
233
+ - `remove_unused_columns`: True
234
+ - `label_names`: None
235
+ - `load_best_model_at_end`: False
236
+ - `ignore_data_skip`: False
237
+ - `fsdp`: []
238
+ - `fsdp_min_num_params`: 0
239
+ - `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
240
+ - `fsdp_transformer_layer_cls_to_wrap`: None
241
+ - `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
242
+ - `deepspeed`: None
243
+ - `label_smoothing_factor`: 0.0
244
+ - `optim`: adamw_torch
245
+ - `optim_args`: None
246
+ - `adafactor`: False
247
+ - `group_by_length`: False
248
+ - `length_column_name`: length
249
+ - `ddp_find_unused_parameters`: None
250
+ - `ddp_bucket_cap_mb`: None
251
+ - `ddp_broadcast_buffers`: False
252
+ - `dataloader_pin_memory`: True
253
+ - `dataloader_persistent_workers`: False
254
+ - `skip_memory_metrics`: True
255
+ - `use_legacy_prediction_loop`: False
256
+ - `push_to_hub`: False
257
+ - `resume_from_checkpoint`: None
258
+ - `hub_model_id`: None
259
+ - `hub_strategy`: every_save
260
+ - `hub_private_repo`: False
261
+ - `hub_always_push`: False
262
+ - `gradient_checkpointing`: False
263
+ - `gradient_checkpointing_kwargs`: None
264
+ - `include_inputs_for_metrics`: False
265
+ - `eval_do_concat_batches`: True
266
+ - `fp16_backend`: auto
267
+ - `push_to_hub_model_id`: None
268
+ - `push_to_hub_organization`: None
269
+ - `mp_parameters`:
270
+ - `auto_find_batch_size`: False
271
+ - `full_determinism`: False
272
+ - `torchdynamo`: None
273
+ - `ray_scope`: last
274
+ - `ddp_timeout`: 1800
275
+ - `torch_compile`: False
276
+ - `torch_compile_backend`: None
277
+ - `torch_compile_mode`: None
278
+ - `dispatch_batches`: None
279
+ - `split_batches`: None
280
+ - `include_tokens_per_second`: False
281
+ - `include_num_input_tokens_seen`: False
282
+ - `neftune_noise_alpha`: None
283
+ - `optim_target_modules`: None
284
+ - `batch_eval_metrics`: False
285
+ - `eval_on_start`: False
286
+ - `use_liger_kernel`: False
287
+ - `eval_use_gather_object`: False
288
+ - `batch_sampler`: batch_sampler
289
+ - `multi_dataset_batch_sampler`: round_robin
290
+
291
+ </details>
292
+
293
+ ### Training Logs
294
+ | Epoch | Step | Training Loss |
295
+ |:------:|:----:|:-------------:|
296
+ | 0.5624 | 500 | 0.0105 |
297
+
298
+
299
+ ### Framework Versions
300
+ - Python: 3.10.12
301
+ - Sentence Transformers: 3.2.0
302
+ - Transformers: 4.45.2
303
+ - PyTorch: 2.1.0+cu118
304
+ - Accelerate: 1.0.1
305
+ - Datasets: 3.0.1
306
+ - Tokenizers: 0.20.1
307
+
308
+ ## Citation
309
+
310
+ ### BibTeX
311
+
312
+ #### Sentence Transformers
313
+ ```bibtex
314
+ @inproceedings{reimers-2019-sentence-bert,
315
+ title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
316
+ author = "Reimers, Nils and Gurevych, Iryna",
317
+ booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
318
+ month = "11",
319
+ year = "2019",
320
+ publisher = "Association for Computational Linguistics",
321
+ url = "https://arxiv.org/abs/1908.10084",
322
+ }
323
+ ```
324
+
325
+ #### MultipleNegativesRankingLoss
326
+ ```bibtex
327
+ @misc{henderson2017efficient,
328
+ title={Efficient Natural Language Response Suggestion for Smart Reply},
329
+ author={Matthew Henderson and Rami Al-Rfou and Brian Strope and Yun-hsuan Sung and Laszlo Lukacs and Ruiqi Guo and Sanjiv Kumar and Balint Miklos and Ray Kurzweil},
330
+ year={2017},
331
+ eprint={1705.00652},
332
+ archivePrefix={arXiv},
333
+ primaryClass={cs.CL}
334
+ }
335
+ ```
336
+
337
+ <!--
338
+ ## Glossary
339
+
340
+ *Clearly define terms in order to be accessible across audiences.*
341
+ -->
342
+
343
+ <!--
344
+ ## Model Card Authors
345
+
346
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
347
+ -->
348
+
349
+ <!--
350
+ ## Model Card Contact
351
+
352
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
353
+ -->
config.json ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "FacebookAI/xlm-roberta-base",
3
+ "architectures": [
4
+ "XLMRobertaModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "bos_token_id": 0,
8
+ "classifier_dropout": null,
9
+ "eos_token_id": 2,
10
+ "hidden_act": "gelu",
11
+ "hidden_dropout_prob": 0.1,
12
+ "hidden_size": 768,
13
+ "initializer_range": 0.02,
14
+ "intermediate_size": 3072,
15
+ "layer_norm_eps": 1e-05,
16
+ "max_position_embeddings": 514,
17
+ "model_type": "xlm-roberta",
18
+ "num_attention_heads": 12,
19
+ "num_hidden_layers": 12,
20
+ "output_past": true,
21
+ "pad_token_id": 1,
22
+ "position_embedding_type": "absolute",
23
+ "torch_dtype": "float32",
24
+ "transformers_version": "4.45.2",
25
+ "type_vocab_size": 1,
26
+ "use_cache": true,
27
+ "vocab_size": 250002
28
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.2.0",
4
+ "transformers": "4.45.2",
5
+ "pytorch": "2.1.0+cu118"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": null
10
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:f0532c5f91065b935f609faf704d8ef8a2b31f291c4d1dfc5501665de78aa8b3
3
+ size 1112197096
modules.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 512,
3
+ "do_lower_case": false
4
+ }
special_tokens_map.json ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "bos_token": "<s>",
3
+ "cls_token": "<s>",
4
+ "eos_token": "</s>",
5
+ "mask_token": {
6
+ "content": "<mask>",
7
+ "lstrip": true,
8
+ "normalized": false,
9
+ "rstrip": false,
10
+ "single_word": false
11
+ },
12
+ "pad_token": "<pad>",
13
+ "sep_token": "</s>",
14
+ "unk_token": "<unk>"
15
+ }
tokenizer.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:883b037111086fd4dfebbbc9b7cee11e1517b5e0c0514879478661440f137085
3
+ size 17082987
tokenizer_config.json ADDED
@@ -0,0 +1,54 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "<s>",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "1": {
12
+ "content": "<pad>",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "2": {
20
+ "content": "</s>",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "3": {
28
+ "content": "<unk>",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "250001": {
36
+ "content": "<mask>",
37
+ "lstrip": true,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "bos_token": "<s>",
45
+ "clean_up_tokenization_spaces": false,
46
+ "cls_token": "<s>",
47
+ "eos_token": "</s>",
48
+ "mask_token": "<mask>",
49
+ "model_max_length": 512,
50
+ "pad_token": "<pad>",
51
+ "sep_token": "</s>",
52
+ "tokenizer_class": "XLMRobertaTokenizer",
53
+ "unk_token": "<unk>"
54
+ }