README.md

---
language:
- vi
license: apache-2.0
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:1391
- loss:MultipleNegativesRankingLoss
base_model: keepitreal/vietnamese-sbert
widget:
- source_sentence: Bộ Công Thương chịu trách nhiệm quản lý nhà nước đối với máy, thiết
    bị, vật tư, chất có yêu cầu nghiêm ngặt về an toàn, vệ sinh lao động có liên quan
    đến thiết bị áp lực, thiết bị nâng đặc thù chuyên ngành công nghiệp, hóa chất,
    vật liệu nổ công nghiệp, trang thiết bị khai thác mỏ, dầu khí, trừ các thiết bị,
    phương tiện thăm dò, khai thác trên biển.
  sentences:
  - Bộ Công Thương chịu trách nhiệm quản lý những gì liên quan đến an toàn, vệ sinh
    lao động?
  - Ngoài các hình thức xử phạt, cá nhân, tổ chức vi phạm hành chính còn có thể bị
    áp dụng những biện pháp khắc phục hậu quả nào?
  - Quyết định xử phạt vi phạm hành chính cần được gửi đến Bộ trưởng Bộ Lao động -
    Thương binh và Xã hội trong trường hợp nào?
- source_sentence: Ngườisửdụnglaođộngthựchiệnđầyđủcácchếđộbảohộlaođộngvàchămsócsứckhỏeđốivớingười
    laođộnglàmnghề, côngviệcnặngnhọc, độchại, nguyhiểmvànghề, côngviệcđặcbiệtnặngnhọc,
    độchại, nguyhiểmtheoquyđịnhcủaphápluật.
  sentences:
  - Trung tâm giới thiệu việc làm được thành lập trước ngày Luật này có hiệu lực thi
    hành sẽ thay đổi như thế nào?
  - Người sử dụng lao động có trách nhiệm gì đối với người lao động làm công việc
    nặng nhọc, độc hại, nguy hiểm?
  - '"Quyết định về đưa người lao động Việt Nam đi làm việc ở nước ngoài theo hợp
    đồng" được định nghĩa như thế nào?'
- source_sentence: Từ 40.000.000 đồng đến 50.000.000 đồng đối với vi phạm từ 301 người
    trở lên.
  sentences:
  - Mức phạt tiền đối với hành vi không tổ chức khám sức khỏe cho người lao động trước
    khi chuyển sang làm nghề, công việc nặng nhọc, độc hại, nguy hiểm hơn là bao nhiêu?
  - Những loại thông tin thị trường lao động nào cần được bảo mật?
  - Mức phạt cao nhất cho hành vi không tổ chức huấn luyện an toàn lao động là bao
    nhiêu?
- source_sentence: 'Phạt tiền từ 80. 000. 000 đồng đến 100. 000. 000 đồng khi có một
    trong các hành vi sau đây: c ) Không tổ chức quản lý, bảo vệ quyền và lợi ích
    hợp pháp của người lao động do doanh nghiệp đưa đi làm việc ở nước ngoài theo
    quy định của pháp luật.'
  sentences:
  - Công đoàn cơ sở có vai trò gì trong việc tập huấn, huấn luyện an toàn, vệ sinh
    lao động?
  - '"Quyết định về lao động" được định nghĩa như thế nào?'
  - Nếu doanh nghiệp không tổ chức quản lý và bảo vệ quyền lợi hợp pháp của người
    lao động ở nước ngoài, họ sẽ bị phạt bao nhiêu?
- source_sentence: Tước quyền sử dụng Giấy phép hoạt động cho thuê lại lao động có
    thời hạn từ 06 tháng đến 12 tháng đối với hành vi vi phạm quy định tại các điểm
    c khoản 6 Điều này.
  sentences:
  - Người sử dụng lao động phải tham gia bảo hiểm thất nghiệp cho người lao động trong
    thời hạn bao lâu kể từ ngày hợp đồng lao động có hiệu lực?
  - Mức phạt tiền đối với bên thuê lại lao động khi không tổ chức huấn luyện an toàn,
    vệ sinh lao động cho người lao động thuê lại theo quy định của pháp luật là bao
    nhiêu?
  - Hình thức xử phạt bổ sung cho hành vi cho thuê lại lao động quá 12 tháng là gì?
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: vietnamese-sbert-base-law
  results:
  - task:
      type: information-retrieval
      name: Information Retrieval
    dataset:
      name: dim 768
      type: dim_768
    metrics:
    - type: cosine_accuracy@1
      value: 0.3870967741935484
      name: Cosine Accuracy@1
    - type: cosine_accuracy@3
      value: 0.4838709677419355
      name: Cosine Accuracy@3
    - type: cosine_accuracy@5
      value: 0.5548387096774193
      name: Cosine Accuracy@5
    - type: cosine_accuracy@10
      value: 0.6451612903225806
      name: Cosine Accuracy@10
    - type: cosine_precision@1
      value: 0.3870967741935484
      name: Cosine Precision@1
    - type: cosine_precision@3
      value: 0.16129032258064516
      name: Cosine Precision@3
    - type: cosine_precision@5
      value: 0.11096774193548387
      name: Cosine Precision@5
    - type: cosine_precision@10
      value: 0.06451612903225806
      name: Cosine Precision@10
    - type: cosine_recall@1
      value: 0.3870967741935484
      name: Cosine Recall@1
    - type: cosine_recall@3
      value: 0.4838709677419355
      name: Cosine Recall@3
    - type: cosine_recall@5
      value: 0.5548387096774193
      name: Cosine Recall@5
    - type: cosine_recall@10
      value: 0.6451612903225806
      name: Cosine Recall@10
    - type: cosine_ndcg@10
      value: 0.49965914022530916
      name: Cosine Ndcg@10
    - type: cosine_mrr@10
      value: 0.45487199180747573
      name: Cosine Mrr@10
    - type: cosine_map@100
      value: 0.4610035889963774
      name: Cosine Map@100
---

# vietnamese-sbert-base-law

This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [keepitreal/vietnamese-sbert](https://huggingface.co/keepitreal/vietnamese-sbert) on the json dataset. 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:** [keepitreal/vietnamese-sbert](https://huggingface.co/keepitreal/vietnamese-sbert) <!-- at revision a9467ef2ef47caa6448edeabfd8e5e5ce0fa2a23 -->
- **Maximum Sequence Length:** 256 tokens
- **Output Dimensionality:** 768 dimensions
- **Similarity Function:** Cosine Similarity
- **Training Dataset:**
    - json
- **Language:** vi
- **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': 256, 'do_lower_case': False}) with Transformer model: 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:

```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("hivetechVN/vietnamese-sbert-base-law-768-v2")
# Run inference
sentences = [
    'Tước quyền sử dụng Giấy phép hoạt động cho thuê lại lao động có thời hạn từ 06 tháng đến 12 tháng đối với hành vi vi phạm quy định tại các điểm c khoản 6 Điều này.',
    'Hình thức xử phạt bổ sung cho hành vi cho thuê lại lao động quá 12 tháng là gì?',
    'Người sử dụng lao động phải tham gia bảo hiểm thất nghiệp cho người lao động trong thời hạn bao lâu kể từ ngày hợp đồng lao động có hiệu lực?',
]
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_768`
* 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.3871     |
| cosine_accuracy@3   | 0.4839     |
| cosine_accuracy@5   | 0.5548     |
| cosine_accuracy@10  | 0.6452     |
| cosine_precision@1  | 0.3871     |
| cosine_precision@3  | 0.1613     |
| cosine_precision@5  | 0.111      |
| cosine_precision@10 | 0.0645     |
| cosine_recall@1     | 0.3871     |
| cosine_recall@3     | 0.4839     |
| cosine_recall@5     | 0.5548     |
| cosine_recall@10    | 0.6452     |
| **cosine_ndcg@10**  | **0.4997** |
| cosine_mrr@10       | 0.4549     |
| cosine_map@100      | 0.461      |

<!--
## 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: 1,391 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: 5 tokens</li><li>mean: 54.23 tokens</li><li>max: 256 tokens</li></ul> | <ul><li>min: 10 tokens</li><li>mean: 27.5 tokens</li><li>max: 78 tokens</li></ul> |
* Samples:
  | positive                                                                                                                                                                                                                                                                                                                                                                                                   | anchor                                                                                                                                  |
  |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|
  | <code>Người sử dụng lao động có trách nhiệm tổ chức đào tạo, bồi dưỡng, nâng cao trình độ kỹ năng nghề và sử dụng lao động theo phương án đã được phê duyệt; sử dụng nguồn kinh phí đúng đối tượng, đúng mục đích và thực hiện báo cáo kết quả tổ chức đào tạo cho cơ quan nhà nước có thẩm quyền sau khi kết thúc khóa đào tạo, bồi dưỡng, nâng cao trình độ kỹ năng nghề.</code>                         | <code>Người sử dụng lao động có trách nhiệm gì trong việc đào tạo, bồi dưỡng, nâng cao trình độ kỹ năng nghề cho người lao động?</code> |
  | <code>Thành phố Trà Vinh thuộc tỉnh Trà Vinh.</code>                                                                                                                                                                                                                                                                                                                                                       | <code>Địa phương nào của tỉnh Trà Vinh được xếp vào Vùng II?</code>                                                                     |
  | <code>Chánh Thanh tra Sở Lao động - Thương binh và Xã hội, nơi người sử dụng lao động đặt trụ sở chính có thẩm quyền giải quyết khiếu nại lần hai đối với khiếu nại về lao động, an toàn, vệ sinh lao động khi người khiếu nại không đồng ý với quyết định giải quyết lần đầu theo quy định tại Điều 23 hoặc đã hết thời hạn quy định tại Điều 20 Nghị định này mà khiếu nại không được giải quyết.</code> | <code>Ai có thẩm quyền giải quyết khiếu nại lần hai đối với khiếu nại về lao động, an toàn, vệ sinh lao động?</code>                    |
* Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
  ```json
  {
      "scale": 20.0,
      "similarity_fct": "cos_sim"
  }
  ```

### 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`: 4
- `lr_scheduler_type`: cosine
- `warmup_ratio`: 0.1
- `bf16`: True
- `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`: 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`: True
- `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  | dim_768_cosine_ndcg@10 |
|:----------:|:-----:|:----------------------:|
| 1.0        | 3     | 0.4975                 |
| 2.0        | 6     | 0.4981                 |
| **2.7273** | **8** | **0.4997**             |

* The bold row denotes the saved checkpoint.

### Framework Versions
- Python: 3.10.12
- Sentence Transformers: 3.3.1
- Transformers: 4.47.0
- PyTorch: 2.5.1+cu121
- Accelerate: 1.2.1
- Datasets: 3.3.1
- 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",
}
```

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