File size: 20,315 Bytes
aa5d68d |
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 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 |
---
language:
- en
license: apache-2.0
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:843
- loss:MatryoshkaLoss
- loss:MultipleNegativesRankingLoss
base_model: BAAI/bge-base-en-v1.5
widget:
- source_sentence: (1) No person shall make attempt to commit an offence. Even if
it is impossible for an offence to be committed for which attempt is made, attempt
shall be considered to have been committed. Except as otherwise provided elsewhere
in this Act, a person who attempts, or causes attempt, to commit an offence shall
be punished with one half of the punishment specified for such offence. .
sentences:
- How is the punishment for an attempt determined?
- What are the different types of guarantees?
- What are the specific types of crimes that are considered 'strict liability'?
- source_sentence: ': (1) No person shall commit, or cause to be committed, cheating.
(2) For the purposes of sub-section (1), a person who dishonestly causes any kind
of loss, damage or injury to another person whom he or she makes believe in some
matter or to any other person or obtains any benefit for him or her or any one
else by omitting to do as per such belief or by inducement, fraudulent, dishonest
or otherwise deceptive act or preventing such other person from doing any act
shall be considered to commit cheating.'
sentences:
- How is 'fraudulent concealment' defined?
- What are the terms and restrictions that must be followed when producing explosives
under a license?
- What is the process for determining the appropriate penalty for a cheating offense?
- source_sentence: (1) No person shall restraint or otherwise obstruct or hinder a
person who, upon knowing that an offence has been committed or is about to be
committed, intends to give information or notice about such offence to the police
or competent authority. imprisonment for a term not exceeding two years or a fine
not exceeding twenty thousand rupees or both the sentences.
sentences:
- What actions constitute 'restraint, obstruction, or hindrance'?
- What are the consequences of engaging in such conduct?
- What are the different categories of victims, and how do the penalties vary based
on their age?
- source_sentence: This law prohibits the creation, use, possession, or sale of inaccurate
weighing, measuring, or quality-standard instruments. It also prohibits tampering
with seals or marks on these instruments, or manipulating their accuracy. Violations
carry a penalty of up to three years imprisonment and a fine. Instruments and
tools used in the offense are subject to forfeiture.
sentences:
- What are the penalties for using banned currency?
- What is the time frame for reporting an offense under this law?
- When does this law come into effect?
- source_sentence: This section lists factors that decrease the seriousness of a crime. These
include age (under 18 or over 75), lack of intent, provocation by the victim,
retaliation for a serious offense, confession and remorse, surrender to authorities,
compensation to the victim, diminished capacity, insignificant harm, assistance
in the judicial process, confession with a promise of no future crime, and crimes
committed under duress.
sentences:
- What constitutes "lack of intent" in this context?
- What is the difference between an attempt and the actual commission of a crime?
- What are the exceptions to the prohibition on property transactions in marriage?
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
- cosine_accuracy@1
- cosine_accuracy@3
- cosine_accuracy@5
- cosine_accuracy@10
- cosine_precision@1
- cosine_precision@3
- cosine_precision@5
- cosine_precision@10
- cosine_recall@1
- cosine_recall@3
- cosine_recall@5
- cosine_recall@10
- cosine_ndcg@10
- cosine_mrr@10
- cosine_map@100
model-index:
- name: BGE base Financial Matryoshka
results:
- task:
type: information-retrieval
name: Information Retrieval
dataset:
name: dim 128
type: dim_128
metrics:
- type: cosine_accuracy@1
value: 0.22748815165876776
name: Cosine Accuracy@1
- type: cosine_accuracy@3
value: 0.5592417061611374
name: Cosine Accuracy@3
- type: cosine_accuracy@5
value: 0.6872037914691943
name: Cosine Accuracy@5
- type: cosine_accuracy@10
value: 0.7962085308056872
name: Cosine Accuracy@10
- type: cosine_precision@1
value: 0.22748815165876776
name: Cosine Precision@1
- type: cosine_precision@3
value: 0.18641390205371247
name: Cosine Precision@3
- type: cosine_precision@5
value: 0.13744075829383884
name: Cosine Precision@5
- type: cosine_precision@10
value: 0.07962085308056871
name: Cosine Precision@10
- type: cosine_recall@1
value: 0.22748815165876776
name: Cosine Recall@1
- type: cosine_recall@3
value: 0.5592417061611374
name: Cosine Recall@3
- type: cosine_recall@5
value: 0.6872037914691943
name: Cosine Recall@5
- type: cosine_recall@10
value: 0.7962085308056872
name: Cosine Recall@10
- type: cosine_ndcg@10
value: 0.5057041685567575
name: Cosine Ndcg@10
- type: cosine_mrr@10
value: 0.4129203340103815
name: Cosine Mrr@10
- type: cosine_map@100
value: 0.4195949550112758
name: Cosine Map@100
---
# BGE base Financial Matryoshka
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [BAAI/bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5). 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.
## Model Details
### Model Description
- **Model Type:** Sentence Transformer
- **Base model:** [BAAI/bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) <!-- at revision a5beb1e3e68b9ab74eb54cfd186867f64f240e1a -->
- **Maximum Sequence Length:** 512 tokens
- **Output Dimensionality:** 768 dimensions
- **Similarity Function:** Cosine Similarity
<!-- - **Training Dataset:** Unknown -->
- **Language:** en
- **License:** apache-2.0
### Model Sources
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
### Full Model Architecture
```
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': True}) with Transformer model: BertModel
(1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, '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()
)
```
## Usage
### Direct Usage (Sentence Transformers)
First install the Sentence Transformers library:
```bash
pip install -U sentence-transformers
```
Then you can load this model and run inference.
```python
from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("sentence_transformers_model_id")
# Run inference
sentences = [
'This section lists factors that decrease the seriousness of a crime. These include age (under 18 or over 75), lack of intent, provocation by the victim, retaliation for a serious offense, confession and remorse, surrender to authorities, compensation to the victim, diminished capacity, insignificant harm, assistance in the judicial process, confession with a promise of no future crime, and crimes committed under duress.',
'What constitutes "lack of intent" in this context?',
'What are the exceptions to the prohibition on property transactions in marriage?',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]
```
<!--
### Direct Usage (Transformers)
<details><summary>Click to see the direct usage in Transformers</summary>
</details>
-->
<!--
### Downstream Usage (Sentence Transformers)
You can finetune this model on your own dataset.
<details><summary>Click to expand</summary>
</details>
-->
<!--
### Out-of-Scope Use
*List how the model may foreseeably be misused and address what users ought not to do with the model.*
-->
## Evaluation
### Metrics
#### Information Retrieval
* Dataset: `dim_128`
* Evaluated with [<code>InformationRetrievalEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.InformationRetrievalEvaluator)
| Metric | Value |
|:--------------------|:-----------|
| cosine_accuracy@1 | 0.2275 |
| cosine_accuracy@3 | 0.5592 |
| cosine_accuracy@5 | 0.6872 |
| cosine_accuracy@10 | 0.7962 |
| cosine_precision@1 | 0.2275 |
| cosine_precision@3 | 0.1864 |
| cosine_precision@5 | 0.1374 |
| cosine_precision@10 | 0.0796 |
| cosine_recall@1 | 0.2275 |
| cosine_recall@3 | 0.5592 |
| cosine_recall@5 | 0.6872 |
| cosine_recall@10 | 0.7962 |
| **cosine_ndcg@10** | **0.5057** |
| cosine_mrr@10 | 0.4129 |
| cosine_map@100 | 0.4196 |
<!--
## Bias, Risks and Limitations
*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
-->
<!--
### Recommendations
*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
-->
## Training Details
### Training Dataset
#### Unnamed Dataset
* Size: 843 training samples
* Columns: <code>positive</code> and <code>anchor</code>
* Approximate statistics based on the first 843 samples:
| | positive | anchor |
|:--------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|
| type | string | string |
| details | <ul><li>min: 9 tokens</li><li>mean: 66.68 tokens</li><li>max: 151 tokens</li></ul> | <ul><li>min: 7 tokens</li><li>mean: 14.77 tokens</li><li>max: 39 tokens</li></ul> |
* Samples:
| positive | anchor |
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------|
| <code>This law prohibits unlawful detention of individuals. It outlines penalties for unlawful confinement and obstruction of a person's movement. It also specifies a time limit for complaints related to certain offenses.</code> | <code>What is the process for reporting unlawful detention?</code> |
| <code>No complaint shall lie in relation to any of the offences under Section 290, after the expiry of three months from the date of commission of such offence, and in relation to any of the other offences under this Chapter, after the expiry of three months from the date of knowledge of commission of such act.</code> | <code>What are the time limits for reporting and prosecuting offenses related to animal cruelty?</code> |
| <code>(1) No person, being legally bound to receive a summons, process, notice, arrest warrant or order issued by the competent authority, shall abscond, with mala fide intention to avoid being served with such summons, process, notice, arrest warrant or order.</code> | <code>What is the legal definition of being "legally bound" to receive a document?</code> |
* Loss: [<code>MatryoshkaLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#matryoshkaloss) with these parameters:
```json
{
"loss": "MultipleNegativesRankingLoss",
"matryoshka_dims": [
128
],
"matryoshka_weights": [
1
],
"n_dims_per_step": -1
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `eval_strategy`: epoch
- `per_device_train_batch_size`: 32
- `per_device_eval_batch_size`: 16
- `gradient_accumulation_steps`: 16
- `learning_rate`: 2e-05
- `num_train_epochs`: 30
- `lr_scheduler_type`: cosine
- `warmup_ratio`: 0.1
- `tf32`: False
- `load_best_model_at_end`: True
- `optim`: adamw_torch_fused
- `batch_sampler`: no_duplicates
#### All Hyperparameters
<details><summary>Click to expand</summary>
- `overwrite_output_dir`: False
- `do_predict`: False
- `eval_strategy`: epoch
- `prediction_loss_only`: True
- `per_device_train_batch_size`: 32
- `per_device_eval_batch_size`: 16
- `per_gpu_train_batch_size`: None
- `per_gpu_eval_batch_size`: None
- `gradient_accumulation_steps`: 16
- `eval_accumulation_steps`: None
- `torch_empty_cache_steps`: None
- `learning_rate`: 2e-05
- `weight_decay`: 0.0
- `adam_beta1`: 0.9
- `adam_beta2`: 0.999
- `adam_epsilon`: 1e-08
- `max_grad_norm`: 1.0
- `num_train_epochs`: 30
- `max_steps`: -1
- `lr_scheduler_type`: cosine
- `lr_scheduler_kwargs`: {}
- `warmup_ratio`: 0.1
- `warmup_steps`: 0
- `log_level`: passive
- `log_level_replica`: warning
- `log_on_each_node`: True
- `logging_nan_inf_filter`: True
- `save_safetensors`: True
- `save_on_each_node`: False
- `save_only_model`: False
- `restore_callback_states_from_checkpoint`: False
- `no_cuda`: False
- `use_cpu`: False
- `use_mps_device`: False
- `seed`: 42
- `data_seed`: None
- `jit_mode_eval`: False
- `use_ipex`: False
- `bf16`: False
- `fp16`: False
- `fp16_opt_level`: O1
- `half_precision_backend`: auto
- `bf16_full_eval`: False
- `fp16_full_eval`: False
- `tf32`: False
- `local_rank`: 0
- `ddp_backend`: None
- `tpu_num_cores`: None
- `tpu_metrics_debug`: False
- `debug`: []
- `dataloader_drop_last`: False
- `dataloader_num_workers`: 0
- `dataloader_prefetch_factor`: None
- `past_index`: -1
- `disable_tqdm`: False
- `remove_unused_columns`: True
- `label_names`: None
- `load_best_model_at_end`: True
- `ignore_data_skip`: False
- `fsdp`: []
- `fsdp_min_num_params`: 0
- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
- `fsdp_transformer_layer_cls_to_wrap`: None
- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
- `deepspeed`: None
- `label_smoothing_factor`: 0.0
- `optim`: adamw_torch_fused
- `optim_args`: None
- `adafactor`: False
- `group_by_length`: False
- `length_column_name`: length
- `ddp_find_unused_parameters`: None
- `ddp_bucket_cap_mb`: None
- `ddp_broadcast_buffers`: False
- `dataloader_pin_memory`: True
- `dataloader_persistent_workers`: False
- `skip_memory_metrics`: True
- `use_legacy_prediction_loop`: False
- `push_to_hub`: False
- `resume_from_checkpoint`: None
- `hub_model_id`: None
- `hub_strategy`: every_save
- `hub_private_repo`: None
- `hub_always_push`: False
- `gradient_checkpointing`: False
- `gradient_checkpointing_kwargs`: None
- `include_inputs_for_metrics`: False
- `include_for_metrics`: []
- `eval_do_concat_batches`: True
- `fp16_backend`: auto
- `push_to_hub_model_id`: None
- `push_to_hub_organization`: None
- `mp_parameters`:
- `auto_find_batch_size`: False
- `full_determinism`: False
- `torchdynamo`: None
- `ray_scope`: last
- `ddp_timeout`: 1800
- `torch_compile`: False
- `torch_compile_backend`: None
- `torch_compile_mode`: None
- `dispatch_batches`: None
- `split_batches`: None
- `include_tokens_per_second`: False
- `include_num_input_tokens_seen`: False
- `neftune_noise_alpha`: None
- `optim_target_modules`: None
- `batch_eval_metrics`: False
- `eval_on_start`: False
- `use_liger_kernel`: False
- `eval_use_gather_object`: False
- `average_tokens_across_devices`: False
- `prompts`: None
- `batch_sampler`: no_duplicates
- `multi_dataset_batch_sampler`: proportional
</details>
### Training Logs
| Epoch | Step | Training Loss | dim_128_cosine_ndcg@10 |
|:----------:|:-----:|:-------------:|:----------------------:|
| **0.5926** | **1** | **-** | **0.3891** |
| 1.0 | 2 | - | 0.4127 |
| 2.0 | 4 | - | 0.4611 |
| 3.0 | 6 | - | 0.4676 |
| 4.0 | 8 | - | 0.4909 |
| 5.0 | 10 | 1.1743 | 0.4808 |
| 6.0 | 12 | - | 0.4891 |
| 7.0 | 14 | - | 0.5027 |
| 8.0 | 16 | - | 0.4979 |
| 9.0 | 18 | - | 0.5047 |
| 10.0 | 20 | 0.5481 | 0.5031 |
| 11.0 | 22 | - | 0.5057 |
* The bold row denotes the saved checkpoint.
### Framework Versions
- Python: 3.10.12
- Sentence Transformers: 3.3.1
- Transformers: 4.47.1
- PyTorch: 2.5.1+cu121
- Accelerate: 0.27.0
- Datasets: 3.2.0
- Tokenizers: 0.21.0
## Citation
### BibTeX
#### Sentence Transformers
```bibtex
@inproceedings{reimers-2019-sentence-bert,
title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
author = "Reimers, Nils and Gurevych, Iryna",
booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
month = "11",
year = "2019",
publisher = "Association for Computational Linguistics",
url = "https://arxiv.org/abs/1908.10084",
}
```
#### MatryoshkaLoss
```bibtex
@misc{kusupati2024matryoshka,
title={Matryoshka Representation Learning},
author={Aditya Kusupati and Gantavya Bhatt and Aniket Rege and Matthew Wallingford and Aditya Sinha and Vivek Ramanujan and William Howard-Snyder and Kaifeng Chen and Sham Kakade and Prateek Jain and Ali Farhadi},
year={2024},
eprint={2205.13147},
archivePrefix={arXiv},
primaryClass={cs.LG}
}
```
#### MultipleNegativesRankingLoss
```bibtex
@misc{henderson2017efficient,
title={Efficient Natural Language Response Suggestion for Smart Reply},
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},
year={2017},
eprint={1705.00652},
archivePrefix={arXiv},
primaryClass={cs.CL}
}
```
<!--
## Glossary
*Clearly define terms in order to be accessible across audiences.*
-->
<!--
## Model Card Authors
*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
-->
<!--
## Model Card Contact
*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
--> |