my-retriever-model

SentenceTransformer based on bkai-foundation-models/vietnamese-bi-encoder

This is a sentence-transformers model finetuned from bkai-foundation-models/vietnamese-bi-encoder. 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: bkai-foundation-models/vietnamese-bi-encoder <!-- at revision 84f9d9ada0d1a3c37557398b9ae9fcedcdf40be0 -->
• Maximum Sequence Length: 256 tokens
• Output Dimensionality: 768 dimensions
• Similarity Function: Cosine Similarity

<!-- - **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({'max_seq_length': 256, 'do_lower_case': False, 'architecture': 'RobertaModel'})
  (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})
)

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("sentence_transformers_model_id")
# Run inference
sentences = [
    'Tên chính thức của Án lệ số 57/2023/AL1 là gì?',
    'ÁN LỆ SỐ 57/2023/AL1 Về hành vi gian dối nhằm tiếp cận tài sản trong tội “Cướp giật tài sản” Được Hội đồng Thẩm phán Tòa án nhân dân tối cao thông qua vào các ngày 01, 02, 03 tháng 02 năm 2023 và được công bố theo Quyết định số 39/QĐ-CA ngày 24 tháng 02 năm 2023 của Chánh án Tòa án nhân dân tối cao. Nguồn án lệ: Bản án hình sự phúc thẩm số 590/2020/HS-PT ngày 18/12/2020 của Toà án nhân dân Thành phố Hồ Chí Minh về vụ án “Cướp giật tài sản” đối với bị cáo Nguyễn Thành Quốc B. Vị trí nội dung án lệ: Đoạn 4 phần “Nhận định của Tòa án”. Khái quát nội dung của án lệ: - Tình huống án lệ: Bị cáo dùng thủ đoạn gian dối để người quản lý tài sản chuyển giao tài sản cho bị cáo, sau đó lợi dụng sơ hở để nhanh chóng tẩu thoát. - Giải pháp pháp lý: Trường hợp này, bị cáo phải bị truy cứu trách nhiệm hình sự về tội “Cướp giật tài sản”. Quy định của pháp luật liên quan đến án lệ: Điều 171 Bộ luật Hình sự năm 2015 (sửa đổi, bổ sung năm 2017). Từ khoá của án lệ: “Cướp giật tài sản”; “Thủ đoạn gian dối để tiếp cận tài sản”.',
    'Vật chứng thu giữ gồm: - 01 (một) xe ô tô đầu kéo nhãn hiệu FREIGHTLINER, BKS: 77C-016.47, số loại: CL 120064S, sơn màu đỏ, số máy: 0933U0841843, số khung: 6CV36LX06844 cùng các giấy tờ liên quan đến xe; - 01 (một) giấy phép lái xe (thẻ nhựa) số: 520144004729, hạng FC giả mang tên Lưu Văn C; - 01 (một) giấy phép lái xe (thẻ nhựa) số: 5201600087, hạng C mang tên Phan Thành H do Sở GTVT tỉnh Bình Định cấp; - 01 (một) giấy chứng minh nhân dân số: 215341305, mang tên Phan Thành H do Công an tỉnh Bình Định cấp; - 01 (một) chiếc điện thoại di động hiệu ARBUTUS màu vàng, màn hình cảm ứng, số IMEI: 355052654004631, 355052654004649, máy đã qua sử dụng; - 01 (một) USB nhãn hiệu Kingston, dung lượng 8GB, trên bề mặt có chữ DT101 G2 có lưu trữ tập tin Video: IMG-1245.MOV thời lượng 00 phút 37 giây. - 01 (một) USB nhãn hiệu Apacer dung lượng 8GB lưu trữ 02 tập tin Video: IMG-0507.MOV thời lượng 02 phút 58 giây và Video: IMG-0509.MOV thời lượng 03 phút 04 giây. - 01 (một) USB nhãn hiệu Kingston, dung lượng 8GB, trên bề mặt có chữ DT101.G2 có lưu trữ tập tin Video: IMG-1689.MOV thời lượng 05 phút 10 giây. Cơ quan CSĐT Công an tỉnh Hà Tĩnh đã trả lại chiếc xe ô tô đầu kéo BKS: 77C-016.47 và các giấy tờ liên quan cho chủ sở hữu là Công ty TNHH vận tải và Thương mại tổng hợp T; 03 (ba) chiếc USB đang được lưu giữ theo hồ sơ vụ án, còn các vật chứng khác được chuyển đến Cục thi hành án dân sự tỉnh Hà Tĩnh để quản lý.',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.7021, 0.0674],
#         [0.7021, 1.0000, 0.0045],
#         [0.0674, 0.0045, 1.0000]])

<!-- ### 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.* --> <!-- ## 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: 5,088 training samples
• Columns: <code>sentence_0</code> and <code>sentence_1</code>
• Approximate statistics based on the first 1000 samples:

  	sentence_0	sentence_1
  type	string	string
  details	<ul><li>min: 10 tokens</li><li>mean: 27.7 tokens</li><li>max: 65 tokens</li></ul>	<ul><li>min: 27 tokens</li><li>mean: 173.73 tokens</li><li>max: 256 tokens</li></ul>

• Samples:

  sentence_0	sentence_1
  <code>Điều 15 Bộ luật Hình sự quy định về vấn đề gì?</code>	<code>[5] Theo Kết luận giám định pháp y thương tích số 68/TTPY ngày 16/01/2019 của Trung tâm Pháp y Sở Y tế H: “Anh Hồng Quốc A bị chấn thương sọ não, hiện sống thực vật... Tỷ lệ tổn hại sức khoẻ là 100%”. Như vậy, trong vụ án này, các bị cáo đã cố ý thực hiện hành vi nhằm tước đoạt đoạt tính mạng của bị hại nhưng hậu quả chết người không xảy ra, thuộc trường hợp phạm tội chưa đạt quy định tại Điều 15 Bộ luật Hình sự.”</code>
  <code>Năm 1981, Quân khu 7 đã cấp 'Giấy phép quyền sở hữu sử dụng' cho ai đối với căn nhà số 63 đường B?</code>	<code>[1] Nguồn gốc căn nhà số 63 (tầng 2) đường V, phường X, quận I (nay là đường B, phường H, quận I, Thành phố Hồ Chí Minh) là do Bộ tư lệnh Quân khu 7 tiếp quản, sử dụng từ sau ngày giải phóng Miền Nam. Năm 1981, Quân khu 7 cấp “Giấy phép quyền sở hữu sử dụng” số 092/QĐ ngày 16-4-1981 cho cụ Nguyễn Thanh T. Theo nội dung giấy phép, việc cấp nhà cho cụ T là “để tạo mọi điều kiện chỗ ăn, ở cho gia đình cán bộ, ổn định lâu dài và cấp do hoàn cảnh gia đình cán bộ không có nhà ở ”, tại thời điểm cấp bà Nguyễn Thị H và ông Nguyễn Văn T1 (con cụ T) sống chung với cụ T, có hộ khẩu thường trú tại căn nhà trên. Đến năm 1982, hai chị em bà Nguyễn Thị Kim L và ông Nguyễn Thanh H1 mới chuyển hộ khẩu về sống cùng cụ T. Như vậy, cụ T là người có công với cách mạng, nên được Quân khu 7 xét cấp nhà số 63 đường B nêu trên theo tiêu chuẩn của sĩ quan quân đội. Đến thời điểm cụ T chết năm 1995, cụ chưa làm thủ tục mua hóa giá nhà đối với nhà số 63 nêu trên. Theo quy định tại Điều 188 và Điều 634 Bộ luật Dân...</code>
  <code>Theo Đại diện Viện kiểm sát, hành vi phạm tội của bị cáo có tính chất, động cơ gì?</code>	<code>Đại diện Viện kiểm sát nhân dân cấp cao tại Hà Nội: Sau khi kiểm tra tính có căn cứ pháp luật của bản án sơ thẩm và xét hỏi làm rõ tại phiên tòa, thì thấy: Tòa án cấp sơ thẩm kết án bị cáo Q về tội: “Giết người” là hoàn toàn có căn cứ pháp luật, bị cáo không nhận tội giết người chỉ là nhằm trốn tránh trách nhiệm hình sự về tội nặng hơn mà thôi. Hành vi phạm tội của bị cáo có tính chất, động cơ đê hèn, vì bị cáo muốn nạn nhân chết hẳn thì bị cáo mới cho xe đi tiếp. Vì vậy, đề nghị Hội đồng xét xử không áp dụng điểm n khoản 1 Điều 93 như nội dung kháng nghị mà cần áp dụng điểm q khoản 1 Điều 93 Bộ luật Hình sự để xét xử bị cáo và đề nghị Hội đồng xét xử của Tòa án cấp phúc thẩm chấp nhận nội dung kháng nghị, để xử tăng mức hình phạt tù đối với bị cáo Q.</code>

• Loss: <code>MultipleNegativesRankingLoss</code> with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "gather_across_devices": false
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• per_device_train_batch_size: 16
• per_device_eval_batch_size: 16
• multi_dataset_batch_sampler: round_robin

All Hyperparameters

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

• overwrite_output_dir: False
• do_predict: False
• eval_strategy: no
• prediction_loss_only: True
• per_device_train_batch_size: 16
• per_device_eval_batch_size: 16
• per_gpu_train_batch_size: None
• per_gpu_eval_batch_size: None
• gradient_accumulation_steps: 1
• eval_accumulation_steps: None
• torch_empty_cache_steps: None
• learning_rate: 5e-05
• weight_decay: 0.0
• adam_beta1: 0.9
• adam_beta2: 0.999
• adam_epsilon: 1e-08
• max_grad_norm: 1
• num_train_epochs: 3
• max_steps: -1
• lr_scheduler_type: linear
• lr_scheduler_kwargs: {}
• warmup_ratio: 0.0
• 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
• bf16: False
• fp16: False
• fp16_opt_level: O1
• half_precision_backend: auto
• bf16_full_eval: False
• fp16_full_eval: False
• tf32: None
• 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: False
• 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}
• parallelism_config: 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
• project: huggingface
• trackio_space_id: trackio
• 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
• hub_revision: None
• 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
• include_tokens_per_second: False
• include_num_input_tokens_seen: no
• neftune_noise_alpha: None
• optim_target_modules: None
• batch_eval_metrics: False
• eval_on_start: False
• use_liger_kernel: False
• liger_kernel_config: None
• eval_use_gather_object: False
• average_tokens_across_devices: True
• prompts: None
• batch_sampler: batch_sampler
• multi_dataset_batch_sampler: round_robin
• router_mapping: {}
• learning_rate_mapping: {}

</details>

Training Logs

Framework Versions

• Python: 3.12.12
• Sentence Transformers: 5.1.2
• Transformers: 4.57.1
• PyTorch: 2.8.0+cu126
• Accelerate: 1.11.0
• Datasets: 4.0.0
• Tokenizers: 0.22.1

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