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

Model Details

Model Description

• Model Type: Sentence Transformer
• Base model: bkai-foundation-models/vietnamese-bi-encoder
• Maximum Sequence Length: 256 tokens
• Output Dimensionality: 768 dimensions
• Similarity Function: Cosine Similarity
• Supported Modality: Text

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': 'RobertaModel'})
  (1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', '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
queries = [
    'Hồ_sơ đề_nghị cấp lại Giấy_phép và năng định cho nhân_viên bảo_dưỡng tàu_bay trong trường_hợp hết hạn gồm những nội_dung gì ?',
]
documents = [
    'NỘI_DUNG THỦ_TỤC HÀNH_CHÍNH CÔNG_BỐ SỬA_ĐỔI \n ... \n 2 . Cấp lại Giấy_phép và năng định cho nhân_viên bảo_dưỡng tàu_bay ( AMT ) \n ... \n 2.3 . Thành_phần , số_lượng hồ_sơ : \n a ) Thành_phần : \n * Trường_hợp hết hạn : \n 1 . Bản_sao hoặc biểu_mẫu điện_tử đơn đề_nghị cấp lại nêu rõ lý_do theo quy_định tại khoản h Phụ_lục 1 Điều 7.350 . \n 2 . Bản_sao hoặc bản_sao điện_tử tài_liệu duy_trì kinh_nghiệm với các nội_dung áp_dụng cho năng định của người đề_nghị . \n * Trường_hợp Giấy_phép mất , rách : \n 1 . Bản_sao hoặc biểu_mẫu điện_tử đơn đề_nghị cấp lại nêu rõ lý_do theo quy_định tại khoản h Phụ_lục 1 Điều 7.350 . \n 2 . Bản_sao hoặc bản_sao điện_tử giấy_phép và năng định đã được cấp ( nếu có ) . ” \n 2.4 . Thời_hạn giải_quyết : 07 ngày , kể từ ngày nhận được hồ_sơ hợp_lệ . \n 2.5 . Đối_tượng thực_hiện thủ_tục hành_chính : Cá_nhân , tổ_chức \n ...',
    'Hồ_sơ , trình_tự , thủ_tục cấp Giấy_phép xuất_khẩu , nhập_khẩu tiền chất công_nghiệp \n ... \n 7 . Hồ_sơ , thủ_tục gia_hạn Giấy_phép \n a ) Giấy_phép được gia_hạn trong trường_hợp hết thời_hạn ghi trong Giấy_phép xuất_khẩu , nhập_khẩu quy_định tại khoản 4 Điều này nhưng việc xuất_khẩu , nhập_khẩu chưa thực_hiện được hoặc thực_hiện chưa xong . Giấy_phép chỉ được gia_hạn một lần ; \n b ) Trước khi Giấy_phép hết hạn tối_thiểu 05 ngày làm_việc , tổ_chức , cá_nhân có nhu_cầu gia_hạn Giấy_phép phải lập 01 bộ hồ_sơ đề_nghị gia_hạn Giấy_phép gửi cơ_quan cấp phép qua đường bưu_điện hoặc gửi trực_tiếp hoặc qua hệ_thống dịch_vụ công trực_tuyến ; \n c ) Hồ_sơ đề_nghị gia_hạn Giấy_phép bao_gồm : Văn_bản đề_nghị gia_hạn Giấy_phép xuất_khẩu , nhập_khẩu tiền chất công_nghiệp ; bản_sao Giấy_phép xuất_khẩu , nhập_khẩu tiền chất công_nghiệp đã được cấp ; \n d ) Trong thời_hạn 05 ngày làm_việc kể từ ngày nhận đủ hồ_sơ hợp_lệ , cơ_quan cấp phép kiểm_tra , gia_hạn Giấy_phép cho tổ_chức , cá_nhân . Trường_hợp không gia_hạn Giấy_phép , cơ_quan có thẩm_quyền cấp phép phải có văn_bản trả_lời , nêu rõ lý_do ; \n đ ) Giấy_phép xuất_khẩu , nhập_khẩu được gia_hạn không quá 06 tháng kể từ ngày cấp phép gia_hạn .',
    'Hình_thức phòng xử_án \n 1 . Phòng xử án phải được bố_trí Quốc_huy nước Cộng_hòa xã_hội chủ_nghĩa Việt_Nam trên nền ốp gỗ ở chính giữa , phía sau và ở trên vị_trí của Hội_đồng xét_xử , Hội_đồng giải_quyết việc dân_sự , phá_sản , Thẩm_phán chủ tọa phiên_tòa , chủ_trì phiên họp . \n 2 . Phòng xử án được bố_trí hai bục , trừ phòng xử án và giải_quyết các vụ_việc thuộc thẩm_quyền của Tòa_gia_đình và người chưa thành_niên . Vị_trí của Hội_đồng xét_xử , Hội_đồng giải_quyết việc dân_sự , phá_sản , Thẩm_phán chủ tọa phiên_tòa , chủ_trì phiên họp ở trên bục cao nhất ; bục thứ hai là vị_trí của những người tiến_hành tố_tụng khác , người tham_gia tố_tụng và người tham_dự phiên_tòa , phiên họp . \n 3 . Phòng xử án phải bảo_đảm không_gian để tiến_hành phiên_tòa , phiên họp và hàng_rào ngăn_cách giữa khu_vực của những người tiến_hành tố_tụng , người tham_gia tố_tụng với khu_vực của người tham_dự phiên_tòa , phiên họp ; phải bố_trí lối đi riêng của Hội_đồng xét_xử , Hội_đồng giải_quyết việc dân_sự , phá_sản , Thẩm_phán chủ tọa phiên_tòa , chủ_trì phiên họp ; lối đi của những người tiến_hành tố_tụng khác , người tham_gia tố_tụng , người tham_dự phiên_tòa , phiên họp ; tường trong phòng xử án có nền màu vàng . \n 4 . Sơ_đồ vị_trí của những người tiến_hành tố_tụng , người tham_gia tố_tụng , người tham_dự phiên_tòa , phiên họp trong phòng xử án được thực_hiện theo Phụ_lục số 01 ban_hành kèm theo Thông_tư này . \n 5 . Trường_hợp xét_xử lưu_động thì phòng xử án phải bố_trí Quốc_huy nước Cộng_hòa xã_hội chủ_nghĩa Việt_Nam trên phông_nền màu xanh ở chính giữa , phía sau và ở trên vị_trí của Hội_đồng xét_xử . Bàn của những người tiến_hành tố_tụng được phủ khăn có màu giống với màu phông_nền .',
]
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.8618,  0.2589, -0.0398]])

Training Details

Training Dataset

Unnamed Dataset

• Size: 117,759 training samples
• Columns: query, positive, and label
• Approximate statistics based on the first 100 samples:

  	query	positive	label
  type	string	string	int
  modality	text	text
  details	min: 9 tokensmean: 17.82 tokensmax: 29 tokens	min: 33 tokensmean: 173.73 tokensmax: 256 tokens	0: ~0.96%1: ~0.96%2: ~0.96%3: ~0.96%4: ~0.96%5: ~0.96%6: ~1.92%7: ~0.96%8: ~0.96%9: ~0.96%10: ~0.96%11: ~0.96%12: ~0.96%13: ~0.96%14: ~0.96%15: ~0.96%16: ~0.96%17: ~0.96%18: ~0.96%19: ~0.96%20: ~0.96%21: ~0.96%22: ~0.96%23: ~0.96%24: ~0.96%25: ~0.96%26: ~1.92%27: ~0.96%28: ~0.96%29: ~0.96%30: ~0.96%31: ~0.96%32: ~0.96%33: ~0.96%34: ~0.96%35: ~0.96%36: ~0.96%37: ~0.96%38: ~0.96%39: ~0.96%40: ~0.96%41: ~0.96%42: ~0.96%43: ~0.96%44: ~0.96%45: ~0.96%46: ~0.96%47: ~0.96%48: ~0.96%49: ~1.92%50: ~0.96%51: ~0.96%52: ~0.96%53: ~0.96%54: ~0.96%55: ~1.92%56: ~0.96%57: ~0.96%58: ~0.96%59: ~0.96%60: ~0.96%61: ~0.96%62: ~0.96%63: ~0.96%64: ~0.96%65: ~0.96%66: ~0.96%67: ~0.96%68: ~0.96%69: ~0.96%70: ~0.96%71: ~0.96%72: ~0.96%73: ~0.96%74: ~0.96%75: ~0.96%76: ~0.96%77: ~0.96%78: ~0.96%79: ~1.92%80: ~0.96%81: ~0.96%82: ~0.96%83: ~0.96%84: ~0.96%85: ~0.96%86: ~0.96%87: ~0.96%88: ~0.96%89: ~0.96%90: ~0.96%91: ~0.96%92: ~0.96%93: ~0.96%94: ~1.92%95: ~0.96%96: ~0.96%97: ~0.96%

• Samples:

  query	positive	label
  Người học ngành quản_lý khai_thác công_trình thủy_lợi trình_độ cao_đẳng phải có khả_năng học_tập và nâng cao_trình_độ như thế_nào ?	Khả_năng học_tập , nâng cao_trình_độ - Khối_lượng khối_lượng kiến_thức tối_thiểu , yêu_cầu về năng_lực mà người học phải đạt được sau khi tốt_nghiệp ngành , nghề Mộc xây_dựng và trang_trí nội_thất , trình_độ cao_đẳng có_thể tiếp_tục phát_triển ở các trình_độ cao hơn ; - Người học sau tốt_nghiệp có năng_lực tự học , tự cập_nhật những tiến_bộ khoa_học công_nghệ trong phạm_vi ngành , nghề để nâng cao_trình_độ hoặc học liên_thông lên trình_độ cao hơn trong cùng ngành , nghề hoặc trong nhóm ngành , nghề hoặc trong cùng lĩnh_vực đào_tạo . / . Người học ngành mộc xây_dựng và trang_trí nội_thất trình_độ cao_đẳng phải có khả_năng học_tập , nâng cao_trình_độ như thế sau : - Khối_lượng khối_lượng kiến_thức tối_thiểu , yêu_cầu về năng_lực mà người học phải đạt được sau khi tốt_nghiệp ngành , nghề Mộc xây_dựng và trang_trí nội_thất , trình_độ cao_đẳng có_thể tiếp_tục phát_triển ở các trình_độ cao hơn ; - Người học sau tốt_nghiệp có năng_lực tự học , tự cập_nhật những tiến_bộ khoa_học công...	0
  Nội_dung lồng_ghép vấn_đề bình_đẳng giới trong xây_dựng văn_bản quy_phạm_pháp_luật được quy_định thế_nào ?	Nội_dung lồng_ghép vấn_đề bình_đẳng giới trong xây_dựng văn_bản quy_phạm_pháp_luật Trong phạm_vi điều_chỉnh của văn_bản quy_phạm_pháp_luật : 1 . Xác_định nội_dung liên_quan đến vấn_đề bình_đẳng giới hoặc vấn_đề bất_bình_đẳng giới , phân_biệt đối_xử về giới . 2 . Quy_định các biện_pháp cần_thiết để thực_hiện bình_đẳng giới hoặc để giải_quyết vấn_đề bất_bình_đẳng giới , phân_biệt đối_xử về giới ; dự_báo tác_động của các quy_định đó đối_với nam và nữ sau khi được ban_hành . 3 . Xác_định nguồn nhân_lực , tài_chính cần_thiết để triển_khai các biện_pháp thực_hiện bình_đẳng giới hoặc để giải_quyết vấn_đề bất_bình_đẳng giới , phân_biệt đối_xử về giới .	1
  Điều_kiện để giáo_viên trong cơ_sở giáo_dục mầm_non , tiểu_học ngoài công_lập bị ảnh_hưởng bởi Covid - 19 được hưởng chính_sách hỗ_trợ là gì ?	Điều_kiện được hưởng Cán_bộ quản_lý , giáo_viên , nhân_viên được hưởng chính_sách khi bảo_đảm các điều_kiện sau : 1 . Là người đang làm_việc tại cơ_sở giáo_dục ngoài công_lập trước khi cơ_sở phải tạm dừng hoạt_động theo yêu_cầu của cơ_quan nhà_nước có thẩm_quyền để phòng , chống dịch COVID - 19 tính từ ngày 01 tháng 5 năm 2021 đến hết ngày 31 tháng 12 năm 2021 . 2 . Nghỉ_việc không hưởng lương từ 01 tháng trở_lên tính từ ngày 01 tháng 5 năm 2021 đến hết ngày 31 tháng 12 năm 2021 . 3 . Chưa được hưởng chính_sách hỗ_trợ đối_với người lao_động tạm hoãn hợp_đồng lao_động , nghỉ_việc không hưởng lương theo quy_định tại khoản 4 , khoản 5 , khoản 6 Mục II Nghị_quyết số 68 / NQ - CP ngày 01 tháng 7 năm 2021 của Chính_phủ về một_số chính_sách hỗ_trợ người lao_động và người sử_dụng lao_động gặp khó_khăn do đại_dịch COVID - 19 , Nghị_quyết số 126 / NQ - CP ngày 08 tháng 10 năm 2021 của Chính_phủ sửa_đổi , bổ_sung Nghị_quyết số 68 / NQ - CP ngày 01 tháng 7 năm 2021 của Chính_phủ về một_số ...	2

• Loss: vnlegal_rag_v2.training.losses.MultiPositiveContrastiveLoss

Evaluation Dataset

Unnamed Dataset

• Size: 13,364 evaluation samples
• Columns: query and positive
• Approximate statistics based on the first 100 samples:

  	query	positive
  type	string	string
  modality	text	text
  details	min: 10 tokensmean: 18.64 tokensmax: 33 tokens	min: 19 tokensmean: 173.97 tokensmax: 256 tokens

• Samples:

  query	positive
  Sản_phẩm phần_mềm có được hưởng ưu_đãi về thời_gian miễn thuế , giảm thuế hay không ? Nếu được thì trong vòng bao_nhiêu năm ?	" Điều 20 . Ưu_đãi về thời_gian miễn thuế , giảm thuế 1 . Miễn thuế bốn năm , giảm 50 % số thuế phải nộp trong chín năm tiếp_theo đối_với : a ) Thu_nhập của doanh_nghiệp từ thực_hiện dự_án đầu_tư quy_định tại khoản 1 Điều 19 Thông_tư số 78 / 2014 / TT - BTC ( được sửa_đổi , bổ_sung tại Khoản 1 Điều 11 Thông_tư này ) . "
  Hồ_sơ_tuyển_chọn Thẩm_phán Tòa_án nhân_dân cấp huyện phải được giao lại cho Chánh_án Tòa_án nhân_dân cấp tỉnh quản_lý khi nào ?	Sau khi Hội_đồng đã thực_hiện xong việc tuyển_chọn không phụ_thuộc vào kết_quả đa_số thành_viên Hội_đồng đồng_ý hoặc không đồng_ý đề_nghị Chánh_án Tòa_án nhân_dân tối_cao bổ_nhiệm Thẩm_phán , thì các hồ_sơ và bản_sao hồ_sơ phải được giao lại cho Chánh_án Tòa_án nhân_dân cấp tỉnh hoặc Chánh_án Tòa_án quân_sự Trung_ương để quản_lý .
  Kiểm_định viên chất_lượng giáo_dục nghề_nghiệp phải có kinh_nghiệm trong những lĩnh_vực gì ?	Phần II. NỘI_DUNG CỤ_THỂ CỦA TỪNG THỦ_TỤC HÀNH_CHÍNH A. Thủ_tục hành_chính cấp trung_ương ... 5 . Thủ_tục : Cấp thẻ kiểm_định viên chất_lượng giáo_dục nghề_nghiệp . ... 5.10 . Yêu_cầu , điều_kiện thực_hiện thủ_tục hành_chính : a ) Đáp_ứng các tiêu_chuẩn kiểm_định viên chất_lượng giáo_dục nghề_nghiệp - Có phẩm_chất đạo_đức tốt , có đủ sức_khỏe đáp_ứng yêu_cầu công_việc . - Có bằng tốt_nghiệp đại_học trở lên . - Có ít_nhất 05 năm kinh_nghiệm về quản_lý , giảng_dạy , nghiên_cứu trong lĩnh_vực giáo_dục , giáo_dục nghề_nghiệp hoặc làm_việc về ngành , nghề có liên_quan đến chuyên_môn , nghiệp_vụ được đào_tạo . - Hoàn_thành khóa đào_tạo kiểm_định viên chất_lượng giáo_dục nghề_nghiệp do Tổng_cục Giáo_dục nghề_nghiệp hoặc do đơn_vị được Tổng_cục Giáo_dục nghề_nghiệp giao nhiệm_vụ tổ_chức . - Có trình_độ ngoại_ngữ từ bậc 2 theo quy_định của Bộ Giáo_dục và Đào_tạo ban_hành Khung năng_lực ngoại_ngữ 6 bậc dùng cho Việt_Nam hoặc tương_đương trở lên . - Đạt chuẩn kỹ_năng sử_dụ...

• Loss: vnlegal_rag_v2.training.losses.MultiPositiveContrastiveLoss

Training Hyperparameters

Non-Default Hyperparameters

• per_device_train_batch_size: 512
• num_train_epochs: 10
• learning_rate: 4e-05
• weight_decay: 0.02
• bf16: True
• log_level: error
• per_device_eval_batch_size: 512
• load_best_model_at_end: True

All Hyperparameters

• per_device_train_batch_size: 512
• num_train_epochs: 10
• max_steps: -1
• learning_rate: 4e-05
• lr_scheduler_type: linear
• lr_scheduler_kwargs: None
• warmup_steps: 0
• optim: adamw_torch_fused
• optim_args: None
• weight_decay: 0.02
• adam_beta1: 0.9
• adam_beta2: 0.999
• adam_epsilon: 1e-08
• optim_target_modules: None
• gradient_accumulation_steps: 1
• average_tokens_across_devices: True
• max_grad_norm: 1.0
• label_smoothing_factor: 0.0
• bf16: True
• fp16: False
• 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: error
• 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: 512
• 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: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': 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: None
• fsdp_config: None
• deepspeed: None
• debug: []
• skip_memory_metrics: True
• do_predict: False
• resume_from_checkpoint: None
• warmup_ratio: None
• local_rank: -1
• prompts: None
• multi_dataset_batch_sampler: proportional
• router_mapping: {}
• learning_rate_mapping: {}

Training Logs

• The bold row denotes the saved checkpoint.

Training Time

• Training: 1.0 hours
• Evaluation: 4.7 minutes
• Total: 1.1 hours

Framework Versions

• Python: 3.12.13
• Sentence Transformers: 5.5.1
• Transformers: 5.10.1
• PyTorch: 2.11.0+cu128
• Accelerate: 1.13.0
• Datasets: 4.0.0
• 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",
}