CoolFace
Modelpublic

namnguyenba2003/Vietnamese_Law_Embedding_finetuned_v3

sourceHugging Faceapache-2.0updated 1y agoView on Hugging Face
0likes235downloads
Model Card

VietnameseEmbeddingfinetuned

This is a sentence-transformers model finetuned from AITeamVN/Vietnamese_Embedding on the json dataset. It maps sentences & paragraphs to a 1024-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: AITeamVN/Vietnamese_Embedding <!-- at revision fcbbb905e6c3757d421aaa5db6fd7c53d038f6fb -->
  • —Maximum Sequence Length: 8192 tokens
  • —Output Dimensionality: 1024 dimensions
  • —Similarity Function: Cosine Similarity
  • —Training Dataset:
  • —json
  • —Language: vi
  • —License: apache-2.0

Model Sources

Full Model Architecture

SentenceTransformer(
  (0): Transformer({'max_seq_length': 8192, 'do_lower_case': False}) with Transformer model: XLMRobertaModel 
  (1): Pooling({'word_embedding_dimension': 1024, '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("namnguyenba2003/VietnamLegalText-SBERT-finetuned_v3")
# Run inference
sentences = [
    'dịch vụ trợ giúp được sản xuất ra; d.2.4) Khoản trợ giúp do người mua thuê thì trị giá của khoản trợ giúp là chi phí thuê; d.2.5) Khoản trợ giúp là hàng hóa đã qua sử dụng thì trị giá của khoản trợ giúp là trị giá còn lại của hàng hóa đó; d.2.6) Hàng hóa trợ giúp được người mua gia công, chế biến trước khi chuyển cho người bán để sử dụng vào sản xuất hàng hóa nhập khẩu thì phải cộng thêm phần giá trị tăng thêm do gia công, chế biến vào trị giá của khoản trợ giúp; d.2.7) Khoản trợ giúp được người mua, bán giảm giá cho người xuất khẩu thì phải cộng thêm phần trị giá được giảm vào trị giá hải quan; d.2.8) Trường hợp sau khi sản xuất ra hàng hóa nhập khẩu còn thu được nguyên, vật liệu thừa,',
    'Nếu người nhập khẩu nhận được hàng hóa trợ giúp từ người bán, họ phải cộng thêm khoản chi phí nào vào trị giá hải quan?',
    'Theo quy định, người hành nghề khám bệnh, chữa bệnh phải tư vấn, cung cấp những thông tin gì cho người bệnh?',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 1024]

# 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
json
  {
      "truncate_dim": 1024
  }
MetricValue
cosine_accuracy@10.7261
cosine_accuracy@30.7918
cosine_accuracy@50.8784
cosine_accuracy@100.9367
cosine_precision@10.7261
cosine_precision@30.6491
cosine_precision@50.4559
cosine_precision@100.2516
cosine_recall@10.2997
cosine_recall@30.7386
cosine_recall@50.8469
cosine_recall@100.9297
cosine_ndcg@100.8344
cosine_mrr@100.7791
cosine_map@1000.8067
Information Retrieval
json
  {
      "truncate_dim": 768
  }
MetricValue
cosine_accuracy@10.7234
cosine_accuracy@30.7906
cosine_accuracy@50.8784
cosine_accuracy@100.9351
cosine_precision@10.7234
cosine_precision@30.6475
cosine_precision@50.4565
cosine_precision@100.2514
cosine_recall@10.2979
cosine_recall@30.7355
cosine_recall@50.8464
cosine_recall@100.9284
cosine_ndcg@100.8323
cosine_mrr@100.7767
cosine_map@1000.8044
Information Retrieval
json
  {
      "truncate_dim": 512
  }
MetricValue
cosine_accuracy@10.7187
cosine_accuracy@30.7813
cosine_accuracy@50.8714
cosine_accuracy@100.9359
cosine_precision@10.7187
cosine_precision@30.6423
cosine_precision@50.4514
cosine_precision@100.251
cosine_recall@10.2962
cosine_recall@30.7303
cosine_recall@50.838
cosine_recall@100.9269
cosine_ndcg@100.8288
cosine_mrr@100.7722
cosine_map@1000.8001
Information Retrieval
json
  {
      "truncate_dim": 256
  }
MetricValue
cosine_accuracy@10.7047
cosine_accuracy@30.7685
cosine_accuracy@50.8605
cosine_accuracy@100.9223
cosine_precision@10.7047
cosine_precision@30.6313
cosine_precision@50.4453
cosine_precision@100.2481
cosine_recall@10.2894
cosine_recall@30.7169
cosine_recall@50.8282
cosine_recall@100.9158
cosine_ndcg@100.8164
cosine_mrr@100.7589
cosine_map@1000.7882
Information Retrieval
json
  {
      "truncate_dim": 128
  }
MetricValue
cosine_accuracy@10.6814
cosine_accuracy@30.7444
cosine_accuracy@50.8361
cosine_accuracy@100.9037
cosine_precision@10.6814
cosine_precision@30.6088
cosine_precision@50.4321
cosine_precision@100.2425
cosine_recall@10.2816
cosine_recall@30.6935
cosine_recall@50.8051
cosine_recall@100.8953
cosine_ndcg@100.7945
cosine_mrr@100.736
cosine_map@1000.7674

<!--

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

json
  • —Dataset: json
  • —Size: 20,594 training samples
  • —Columns: <code>positive</code> and <code>anchor</code>
  • —Approximate statistics based on the first 1000 samples: | | positive | anchor | |:--------|:--------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------| | type | string | string | | details | <ul><li>min: 112 tokens</li><li>mean: 207.75 tokens</li><li>max: 298 tokens</li></ul> | <ul><li>min: 16 tokens</li><li>mean: 36.41 tokens</li><li>max: 90 tokens</li></ul> |
  • —Samples: | positive | anchor | |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------| | <code>Việc xác định ưu đãi thuế thu nhập doanh nghiệp đối với thu nhập từ hoạt động dịch vụ vận tải của doanh nghiệp căn cứ theo địa bàn thành lập dự án đầu tư (địa bàn tỉnh Sơn La - thuộc địa bàn có điều kiện kinh tế xã hội đặc biệt khó khăn) và có điểm đi hoặc điểm đến thuộc địa bàn thành lập dự án đầu tư (địa bàn tỉnh Sơn La), cụ thể như sau: + Thu nhập từ hoạt động dịch vụ vận tải đối với các tuyến xe được hưởng ưu đãi thuế thu nhập doanh nghiệp do có điểm đi hoặc điểm đến tại địa bàn tỉnh Sơn La: tuyến xe cố định (đi từ Sơn La đến thành phố Hà Nội và ngược lại; đi từ Sơn La đến thành phố Hạ Long và ngược lại) và tuyến xe chạy theo các hợp đồng (đi từ Sơn La đến thành phố Đà Nẵng và ngược lại; đi từ thành phố Bắc Ninh đến Sơn La). + Thu nhập từ hoạt động dịch vụ vận tải đối với tuyến xe không được hưởng ưu đãi thuế thu nhập doanh nghiệp do điểm đi hoặc điểm đến không thuộc địa bàn tỉnh Sơn La: tuyến xe đi từ thành phố Hà Nội đến thành phố Đà Nẵng và ngược lại.</code> | <code>Doanh nghiệp cần đáp ứng những điều kiện gì để được hưởng ưu đãi thuế thu nhập doanh nghiệp khi kinh doanh dịch vụ vận tải?</code> | | <code>đ) Các khoản chi khác cho cán bộ, nhân viên theo quy định của pháp luật.<br>4. Chi phí quản lý của Quỹ BVMTVN<br>a) Chi phí khấu hao tài sản cố định theo quy định của pháp luật; thuê tài sản cố định; chi mua bảo hiểm tài sản; chi sửa chữa, bảo dưỡng tài sản; chi thuê, mua công cụ, dụng cụ lao động, tài sản, thiết bị, văn phòng phẩm phục vụ hoạt động của Quỹ BVMTVN; chi bù đắp tổn thất tài sản theo quy định;<br>b) Chi phí dịch vụ mua ngoài: Tiền điện, nước, điện thoại, bưu chính viễn thông; kiểm toán, dịch vụ pháp lý; chi trả tiền sử dụng các tài liệu kỹ thuật, bằng sáng chế, các dịch vụ kỹ thuật; chi phí vận chuyển; phòng cháy chữa cháy;<br>c) Chi công tác phí, chi phụ cấp tàu xe cho cán bộ và nhân viên của Quỹ BVMTVN đi công tác trong và ngoài nước theo chế độ của Nhà nước quy định đối với doanh nghiệp do nhà nước nắm giữ 100% vốn điều lệ;</code> | <code>Pháp luật quy định những khoản chi nào khác cho cán bộ, nhân viên của Quỹ Bảo vệ môi trường Việt Nam ngoài lương, thưởng?</code> | | <code>Điều 7. Quyền yêu cầu cấp Phiếu lý lịch tư pháp<br>1. Công dân Việt Nam, người nước ngoài đã hoặc đang cư trú tại Việt Nam có quyền yêu cầu cấp Phiếu lý lịch tư pháp của mình.<br>2. Cơ quan tiến hành tố tụng có quyền yêu cầu cấp Phiếu lý lịch tư pháp để phục vụ công tác điều tra, truy tố, xét xử.<br>3. Cơ quan nhà nước, tổ chức chính trị, tổ chức chính trị - xã hội có quyền yêu cầu cấp Phiếu lý lịch tư pháp để phục vụ công tác quản lý nhân sự, hoạt động đăng ký kinh doanh, thành lập, quản lý doanh nghiệp, hợp tác xã.</code> | <code>Công dân Việt Nam và người nước ngoài đang cư trú tại Việt Nam có thể yêu cầu cấp Phiếu lý lịch tư pháp của mình vì mục đích gì?</code> |
  • —Loss: <code>MatryoshkaLoss</code> with these parameters:
json
  {
      "loss": "MultipleNegativesRankingLoss",
      "matryoshka_dims": [
          1024,
          768,
          512,
          256,
          128
      ],
      "matryoshka_weights": [
          1,
          1,
          1,
          1,
          1
      ],
      "n_dims_per_step": -1
  }

Training Hyperparameters

Non-Default Hyperparameters
  • —eval_strategy: epoch
  • —per_device_train_batch_size: 16
  • —per_device_eval_batch_size: 16
  • —gradient_accumulation_steps: 16
  • —learning_rate: 2e-05
  • —num_train_epochs: 4
  • —lr_scheduler_type: cosine
  • —warmup_ratio: 0.1
  • —fp16: True
  • —dataloader_num_workers: 4
  • —load_best_model_at_end: True
  • —optim: adamwtorchfused
  • —ddp_find_unused_parameters: False
  • —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: 16
  • —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: 4
  • —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: True
  • —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: 4
  • —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: {'minnumparams': 0, 'xla': False, 'xlafsdpv2': False, 'xlafsdpgrad_ckpt': False}
  • —fsdp_transformer_layer_cls_to_wrap: None
  • —accelerator_config: {'splitbatches': False, 'dispatchbatches': None, 'evenbatches': True, 'useseedablesampler': True, 'nonblocking': False, 'gradientaccumulationkwargs': None}
  • —deepspeed: None
  • —label_smoothing_factor: 0.0
  • —optim: adamwtorchfused
  • —optim_args: None
  • —adafactor: False
  • —group_by_length: False
  • —length_column_name: length
  • —ddp_find_unused_parameters: False
  • —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: False
  • —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: False
  • —prompts: None
  • —batch_sampler: no_duplicates
  • —multi_dataset_batch_sampler: proportional

</details>

Training Logs

EpochStepTraining Lossdim_1024_cosine_ndcg@10dim_768_cosine_ndcg@10dim_512_cosine_ndcg@10dim_256_cosine_ndcg@10dim_128_cosine_ndcg@10
0.1242100.2657-----
0.2484200.1285-----
0.3727300.0943-----
0.4969400.0949-----
0.6211500.0623-----
0.7453600.0742-----
0.8696700.0703-----
0.9938800.0594-----
1.081-0.82140.81810.81620.80210.7837
1.1118900.0452-----
1.23601000.054-----
1.36021100.0568-----
1.48451200.0416-----
1.60871300.0517-----
1.73291400.0311-----
1.85711500.0366-----
1.98141600.0378-----
2.0162-0.83200.82850.82650.81210.7904
2.09941700.0456-----
2.22361800.0566-----
2.34781900.032-----
2.47202000.0524-----
2.59632100.0323-----
2.72052200.0446-----
2.84472300.0653-----
2.96892400.031-----
3.0243-0.83400.83190.82850.81670.7939
3.08702500.0307-----
3.21122600.0342-----
3.33542700.0337-----
3.45962800.0293-----
3.58392900.028-----
3.70813000.0353-----
3.83233100.031-----
3.95653200.0272-----
4.0324-0.83440.83230.82880.81640.7945
  • —The bold row denotes the saved checkpoint.

Framework Versions

  • —Python: 3.11.11
  • —Sentence Transformers: 4.1.0
  • —Transformers: 4.53.0
  • —PyTorch: 2.8.0.dev20250319+cu128
  • —Accelerate: 1.8.1
  • —Datasets: 3.6.0
  • —Tokenizers: 0.21.2

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