maximmikhalevich/e5_large_for_law_RAG_2

SentenceTransformer based on intfloat/multilingual-e5-base

This is a sentence-transformers model finetuned from intfloat/multilingual-e5-base. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for retrieval.

Model Details

Model Description

• —Model Type: Sentence Transformer
• —Base model: intfloat/multilingual-e5-base <!-- at revision d128750597153bb5987e10b1c3493a34e5a4502a -->
• —Maximum Sequence Length: 512 tokens
• —Output Dimensionality: 768 dimensions
• —Similarity Function: Cosine Similarity
• —Supported Modality: Text <!-- - Training Dataset: Unknown --> <!-- - Language: Unknown --> <!-- - License: Unknown -->

Model Sources

• —Documentation: Sentence Transformers Documentation
• —Repository: Sentence Transformers on GitHub
• —Hugging Face: Sentence Transformers on Hugging Face

Full Model Architecture

SentenceTransformer(
  (0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'XLMRobertaModel'})
  (1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', 'include_prompt': True})
  (2): Normalize({})
)

Usage

Direct Usage (Sentence Transformers)

First install the Sentence Transformers library:

pip install -U sentence-transformers

Then you can load this model and run inference.

from sentence_transformers import SentenceTransformer

# Download from the 🤗 Hub
model = SentenceTransformer("maximmikhalevich/e5_large_for_law_RAG_2")
# Run inference
queries = [
    'query: Чем наказывается управление транспортным средством, на котором незаконно установлен опознавательный фонарь по КоАП РФ?',
]
documents = [
    'passage: Управление транспортным средством, на котором незаконно установлен опознавательный фонарь легкового такси или опознавательный знак "Инвалид", - влечет наложение административного штрафа на водителя в размере пяти тысяч рублей с конфискацией предмета административного правонарушения. — Статья 12.5 КоАП РФ, часть 4.1.',
    'passage: Управление транспортным средством с заведомо неисправными тормозной системой (за исключением стояночного тормоза), рулевым управлением или сцепным устройством (в составе поезда) - влечет наложение административного штрафа в размере пятисот рублей. — Статья 12.5 КоАП РФ, часть 2.',
    'passage: Опережение транспортных средств при проезде пешеходных переходов осуществляется с учетом требований пункта 14.2 Правил. — пункт 10.5 ПДД РФ.',
]
query_embeddings = model.encode_query(queries)
document_embeddings = model.encode_document(documents)
print(query_embeddings.shape, document_embeddings.shape)
# [1, 768] [3, 768]

# Get the similarity scores for the embeddings
similarities = model.similarity(query_embeddings, document_embeddings)
print(similarities)
# tensor([[0.8487, 0.6378, 0.5359]])

<!--

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: legal-eval
• —Evaluated with <code>InformationRetrievalEvaluator</code>

<!--

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: 632 training samples
• —Columns: <code>anchor</code>, <code>positive</code>, and <code>negative</code>
• —Approximate statistics based on the first 100 samples: | | anchor | positive | negative | |:---------|:-----------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------| | type | string | string | string | | modality | text | text | text | | details | <ul><li>min: 13 tokens</li><li>mean: 31.99 tokens</li><li>max: 57 tokens</li></ul> | <ul><li>min: 28 tokens</li><li>mean: 92.92 tokens</li><li>max: 278 tokens</li></ul> | <ul><li>min: 29 tokens</li><li>mean: 85.54 tokens</li><li>max: 278 tokens</li></ul> |
• —Samples: | anchor | positive | negative | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | <code>query: Что обязан делать водитель по правилу «применение аварийной сигнализации и знака аварийной остановки» (пункт 6.1 ПДД)?</code> | <code>passage: Аварийная световая сигнализация должна быть включена: при дорожно-транспортном происшествии; при вынужденной остановке в местах, где остановка запрещена; при ослеплении водителя светом фар; при буксировке (на буксируемом механическом транспортном средстве); при посадке детей в транспортное средство, имеющее опознавательные знаки «Перевозка детей»[2], и высадке из него. Водитель должен включать аварийную световую сигнализацию и в других случаях для предупреждения участников движения об опасности, которую может создать транспортное средство. — пункт 6.1 ПДД РФ.</code> | <code>passage: При отсутствии или неисправности аварийной световой сигнализации на буксируемом механическом транспортном средстве на его задней части должен быть закреплен знак аварийной остановки. — пункт 6.3 ПДД РФ.</code> | | <code>query: Какая ответственность за невыполнение водителем транспортного средства требования о прохождении медицинского освидетельствования на состояние опь?</code> | <code>passage: Невыполнение водителем транспортного средства законного требования уполномоченного должностного лица о прохождении медицинского освидетельствования на состояние опьянения, если такие действия (бездействие) не содержат уголовно наказуемого деяния, — влечет наложение административного штрафа в размере сорока пяти тысяч рублей с лишением права управления транспортными средствами на срок от полутора до двух лет. — Статья 12.26 КоАП РФ, часть 1.</code> | <code>passage: Невыполнение водителем транспортного средства, не имеющим права управления транспортными средствами либо лишенным права управления транспортными средствами, законного требования уполномоченного должностного лица о прохождении медицинского освидетельствования на состояние опьянения, если такие действия (бездействие) не содержат уголовно наказуемого деяния, — влечет административный арест на срок от десяти до пятнадцати суток или наложение административного штрафа на лиц, в отношении которых в соответствии с настоящим Кодексом не может применяться административный арест, в размере сорока пяти тысяч рублей. — Статья 12.26 КоАП РФ, часть 2.</code> | | <code>query: Что обязан делать водитель по правилу «начало движения, маневрирование» (пункт 7.10 ПДД)?</code> | <code>passage: При наличии полосы торможения водитель, намеревающийся повернуть, должен своевременно перестроиться на эту полосу и снижать скорость только на ней. При наличии в месте въезда на дорогу полосы разгона водитель должен двигаться по ней и перестраиваться на соседнюю полосу, уступая дорогу транспортным средствам, движущимся по этой дороге. — пункт 7.10 ПДД РФ.</code> | <code>passage: При перестроении водитель должен уступить дорогу транспортным средствам, движущимся попутно без изменения направления движения. При одновременном перестроении транспортных средств, движущихся попутно, водитель должен уступить дорогу транспортному средству, находящемуся справа. — пункт 7.4 ПДД РФ.</code> |
• —Loss: <code>MultipleNegativesRankingLoss</code> with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "gather_across_devices": false,
      "directions": [
          "query_to_doc"
      ],
      "partition_mode": "joint",
      "hardness_mode": null,
      "hardness_strength": 0.0
  }

Evaluation Dataset

Unnamed Dataset

• —Size: 111 evaluation samples
• —Columns: <code>anchor</code>, <code>positive</code>, and <code>negative</code>
• —Approximate statistics based on the first 100 samples: | | anchor | positive | negative | |:---------|:-----------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------| | type | string | string | string | | modality | text | text | text | | details | <ul><li>min: 13 tokens</li><li>mean: 29.57 tokens</li><li>max: 61 tokens</li></ul> | <ul><li>min: 33 tokens</li><li>mean: 87.16 tokens</li><li>max: 247 tokens</li></ul> | <ul><li>min: 33 tokens</li><li>mean: 80.69 tokens</li><li>max: 408 tokens</li></ul> |
• —Samples: | anchor | positive | negative | |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | <code>query: Что говорится в ПДД РФ про «водитель может покидать свое место или оставлять транспортное средство, если им приняты необходимые меры»?</code> | <code>passage: Водитель может покидать свое место или оставлять транспортное средство, если им приняты необходимые меры, исключающие самопроизвольное движение транспортного средства или использование его в отсутствие водителя. — пункт 11.8 ПДД РФ.</code> | <code>passage: Остановка запрещается: на трамвайных путях, а также в непосредственной близости от них, если это создаст помехи движению трамваев; на железнодорожных переездах, в тоннелях, а также на эстакадах, мостах, путепроводах (если для движения в данном направлении имеется менее трех полос) и под ними; в местах, где расстояние между сплошной линией разметки (кроме обозначающей край проезжей части), разделительной полосой или противоположным краем проезжей части и остановившимся транспортным средством менее 3 м; на пешеходных переходах и ближе 5 м перед ними; на проезжей части вблизи опасных поворотов и выпуклых переломов продольного профиля дороги при видимости дороги менее 100 м хотя бы в одном направлении; на пересечении проезжих частей и ближе 5 м от края пересекаемой проезжей части, за исключением стороны напротив бокового проезда трехсторонних пересечений (перекрестков), имеющих сплошную линию разметки или разделительную полос; ближе 15 метров от мест остановки маршрутных транспорт...</code> | | <code>query: Что предусмотрено УК РФ за деяния, предусмотренные частью первой настоящей статьи, повлекшие по неосторожности причинение средней тяжести вреда здоровью?</code> | <code>passage: Деяния, предусмотренные частью первой настоящей статьи, повлекшие по неосторожности причинение средней тяжести вреда здоровью — Статья 267 УК РФ, часть 3.</code> | <code>passage: Деяния, предусмотренные частью первой настоящей статьи, повлекшие по неосторожности смерть человека — Статья 267 УК РФ, часть 5.</code> | | <code>query: Какая ответственность за превышение установленной скорости движения транспортного средства на величину более 60, но не более 80 километров в час?</code> | <code>passage: Превышение установленной скорости движения транспортного средства на величину более 60, но не более 80 километров в час — влечет наложение административного штрафа в размере от трех тысяч до трех тысяч семисот пятидесяти рублей или лишение права управления транспортными средствами на срок от четырех до шести месяцев. — Статья 12.9 КоАП РФ, часть 4.</code> | <code>passage: Превышение установленной скорости движения транспортного средства на величину более 20, но не более 40 километров в час — влечет наложение административного штрафа в размере семисот пятидесяти рублей. — Статья 12.9 КоАП РФ, часть 2.</code> |
• —Loss: <code>MultipleNegativesRankingLoss</code> with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "gather_across_devices": false,
      "directions": [
          "query_to_doc"
      ],
      "partition_mode": "joint",
      "hardness_mode": null,
      "hardness_strength": 0.0
  }

Training Hyperparameters

Non-Default Hyperparameters

• —learning_rate: 5e-06
• —warmup_steps: 0.2
• —gradient_accumulation_steps: 4
• —fp16: True
• —per_device_eval_batch_size: 32
• —load_best_model_at_end: True
• —batch_sampler: no_duplicates

All Hyperparameters

<details><summary>Click to expand</summary>

• —per_device_train_batch_size: 8
• —num_train_epochs: 3
• —max_steps: -1
• —learning_rate: 5e-06
• —lr_scheduler_type: linear
• —lr_scheduler_kwargs: None
• —warmup_steps: 0.2
• —optim: adamwtorchfused
• —optim_args: None
• —weight_decay: 0.0
• —adam_beta1: 0.9
• —adam_beta2: 0.999
• —adam_epsilon: 1e-08
• —optim_target_modules: None
• —gradient_accumulation_steps: 4
• —average_tokens_across_devices: True
• —max_grad_norm: 1.0
• —label_smoothing_factor: 0.0
• —bf16: False
• —fp16: True
• —bf16_full_eval: False
• —fp16_full_eval: False
• —tf32: None
• —gradient_checkpointing: False
• —gradient_checkpointing_kwargs: None
• —torch_compile: False
• —torch_compile_backend: None
• —torch_compile_mode: None
• —use_liger_kernel: False
• —liger_kernel_config: None
• —use_cache: False
• —neftune_noise_alpha: None
• —torch_empty_cache_steps: None
• —auto_find_batch_size: False
• —log_on_each_node: True
• —logging_nan_inf_filter: True
• —include_num_input_tokens_seen: no
• —log_level: passive
• —log_level_replica: warning
• —disable_tqdm: False
• —project: huggingface
• —trackio_space_id: None
• —trackio_bucket_id: None
• —trackio_static_space_id: None
• —per_device_eval_batch_size: 32
• —prediction_loss_only: True
• —eval_on_start: False
• —eval_do_concat_batches: True
• —eval_use_gather_object: False
• —eval_accumulation_steps: None
• —include_for_metrics: []
• —batch_eval_metrics: False
• —save_only_model: False
• —save_on_each_node: False
• —enable_jit_checkpoint: False
• —push_to_hub: False
• —hub_private_repo: None
• —hub_model_id: None
• —hub_strategy: every_save
• —hub_always_push: False
• —hub_revision: None
• —load_best_model_at_end: True
• —ignore_data_skip: False
• —restore_callback_states_from_checkpoint: False
• —full_determinism: False
• —seed: 42
• —data_seed: None
• —use_cpu: False
• —accelerator_config: {'splitbatches': False, 'dispatchbatches': None, 'evenbatches': True, 'useseedablesampler': True, 'nonblocking': False, 'gradientaccumulationkwargs': None}
• —parallelism_config: None
• —dataloader_drop_last: False
• —dataloader_num_workers: 0
• —dataloader_pin_memory: True
• —dataloader_persistent_workers: False
• —dataloader_prefetch_factor: None
• —remove_unused_columns: True
• —label_names: None
• —train_sampling_strategy: random
• —length_column_name: length
• —ddp_find_unused_parameters: None
• —ddp_bucket_cap_mb: None
• —ddp_broadcast_buffers: False
• —ddp_static_graph: None
• —ddp_backend: None
• —ddp_timeout: 1800
• —fsdp: []
• —fsdp_config: {'minnumparams': 0, 'xla': False, 'xlafsdpv2': False, 'xlafsdpgrad_ckpt': False}
• —deepspeed: None
• —debug: []
• —skip_memory_metrics: True
• —do_predict: False
• —resume_from_checkpoint: None
• —warmup_ratio: None
• —local_rank: -1
• —prompts: None
• —batch_sampler: no_duplicates
• —multi_dataset_batch_sampler: proportional
• —router_mapping: {}
• —learning_rate_mapping: {}

</details>

Training Logs

• —The bold row denotes the saved checkpoint.

Training Time

• —Training: 36.2 minutes

Framework Versions

• —Python: 3.12.13
• —Sentence Transformers: 5.5.1
• —Transformers: 5.9.0
• —PyTorch: 2.10.0+cu128
• —Accelerate: 1.13.0
• —Datasets: 4.8.5
• —Tokenizers: 0.22.2

Citation

BibTeX

Sentence Transformers

@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",
}

MultipleNegativesRankingLoss

@misc{oord2019representationlearningcontrastivepredictive,
      title={Representation Learning with Contrastive Predictive Coding},
      author={Aaron van den Oord and Yazhe Li and Oriol Vinyals},
      year={2019},
      eprint={1807.03748},
      archivePrefix={arXiv},
      primaryClass={cs.LG},
      url={https://arxiv.org/abs/1807.03748},
}

<!--

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. -->