vietnamese-bi-encoder-Financial-Matryoshka-1e-200k

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

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

<!-- - **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}) 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:

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("anhtuansh/vietnamese-bi-encoder-Financial-Matryoshka-2e-200k")
# Run inference
sentences = [
    'thủ_tục cấp thẻ hướng_dẫn_viên du_lịch nội_địa có yêu_cầu_là thẻ hướng_dẫn_viên du_lịch nội_địa',
    'thủ_tục cấp thẻ hướng_dẫn_viên du_lịch nội_địa có kết_quả_thực_hiện là gì ?',
    'cấp giấy_phép hoạt_động khám , chữa bệnh_nhân_đạo đối_với bệnh_viện trên địa_bàn quản_lý của sở y_tế ( trừ các bệnh_viện thuộc thẩm_quyền của bộ y_tế và bộ quốc_phòng ) và áp_dụng đối_với trường_hợp khi thay_đổi hình_thức tổ_chức , chia tách , hợp_nhất , sáp_nhập có phí , lệ_phí là bao_nhiêu ?',
]
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

• Datasets: dim_768, dim_512, dim_256, dim_128 and dim_64
• 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

json

• Dataset: json
• Size: 181,350 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: 8 tokens</li><li>mean: 66.15 tokens</li><li>max: 256 tokens</li></ul>	<ul><li>min: 8 tokens</li><li>mean: 24.6 tokens</li><li>max: 256 tokens</li></ul>

• Samples:

  positive	anchor
  <code>tính tiền cấp quyền khai_thác tài_nguyên nước đối_với công_trình chưa vận_hành cấp tỉnh có yêu_cầu_là .</code>	<code>tính tiền cấp quyền khai_thác tài_nguyên nước đối_với công_trình chưa vận_hành cấp tỉnh có yêu_cầu gì ?</code>
  <code>xóa_đăng_ký hành_nghề và thu_hồi thẻ công_chứng_viên trường_hợp công_chứng_viên không còn hành_nghề tại tổ_chức hành_nghề công_chứng được thực_hiện mức_độ trực_tuyến toàn_trình</code>	<code>xóa_đăng_ký hành_nghề và thu_hồi thẻ công_chứng_viên trường_hợp công_chứng_viên không còn hành_nghề tại tổ_chức hành_nghề công_chứng được thực_hiện mức_độ mấy ?</code>
  <code>thủ_tục cấp giấy chứng_nhận đủ điều_kiện kinh_doanh hoạt_động thể_thao đối_với môn mô_tô nước trên biển có trình_tự thực_hiện như sau : doanh_nghiệp gửi hồ_sơ đến cơ_quan chuyên_môn về thể_dục , thể_thao thuộc ủy_ban nhân nhân cấp tỉnh nơi đăng_ký địa_điểm kinh_doanh hoạt_động thể_thao hoặc nơi doanh_nghiệp có trụ_sở chính trong trường_hợp_doanh_nghiệp có nhiều địa_điểm kinh_doanh hoạt_động thể_thao . cơ_quan chuyên_môn về thể_dục , thể_thao thuộc ủy_ban nhân_dân cấp tỉnh ( sau đây gọi là cơ_quan cấp giấy chứng_nhận đủ điều_kiện ) cấp cho doanh_nghiệp giấy tiếp_nhận hồ_sơ . trường_hợp hồ_sơ cần sửa_đổi , bổ_sung , cơ_quan cấp giấy chứng_nhận đủ điều_kiện thông_báo trực_tiếp hoặc bằng văn_bản những nội_dung cần sửa_đổi , bổ_sung đến doanh_nghiệp trong thời_hạn 03 ngày làm_việc , kể từ ngày nhận hồ_sơ .</code>	<code>thủ_tục cấp giấy chứng_nhận đủ điều_kiện kinh_doanh hoạt_động thể_thao đối_với môn mô_tô nước trên biển có trình_tự thực_hiện như thế_nào ?</code>

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

  {
      "loss": "MultipleNegativesRankingLoss",
      "matryoshka_dims": [
          768,
          512
      ],
      "matryoshka_weights": [
          1,
          1
      ],
      "n_dims_per_step": -1
  }
  

Evaluation Dataset

json

• Dataset: json
• Size: 20,150 evaluation 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: 9 tokens</li><li>mean: 62.93 tokens</li><li>max: 256 tokens</li></ul>	<ul><li>min: 9 tokens</li><li>mean: 24.51 tokens</li><li>max: 127 tokens</li></ul>

• Samples:

  positive	anchor
  <code>điều_chỉnh quyết_định thu_hồi đất , giao đất , cho thuê đất , cho phép chuyển mục_đích sử_dụng đất của thủ_tướng chính_phủ đã ban_hành trước ngày 01 tháng 7 năm 2004 có yêu_cầu hồ_sơ gồm : 1 . hồ_sơ do người sử_dụng đất nộp 01 bộ tại sở tài_nguyên và môi_trường gồm : văn_bản đề_nghị điều_chỉnh quyết_định thu_hồi đất , giao đất , cho thuê đất , cho phép chuyển mục_đích sử_dụng đất của thủ_tướng chính_phủ ban_hành trước ngày 01 tháng 7 năm 2004 theo mẫu_số 03 ban_hành kèm theo thông_tư 33 / 2017 / tt - btnmtbản sao quyết_định thu_hồi đất , giao đất , cho thuê đất , cho phép chuyển mục_đích sử_dụng đất của thủ_tướng chính_phủ đã ban_hành trước ngày 01 tháng 7 năm 2004bản sao giấy chứng_nhận quyền sử_dụng đất hoặc giấy chứng_nhận quyền sở_hữu nhà ở và quyền sử_dụng đất ở hoặc giấy chứng_nhận quyền sử_dụng đất , quyền sở_hữu nhà ở và tài_sản khác gắn liền với đất đã cấp ( nếu có ) bản_sao giấy_phép đầu_tư hoặc giấy chứng_nhận đầu_tư hoặc giấy đăng_ký kinh_doanh hoặc văn_bản chấp_thuận chủ_t...</code>	<code>điều_chỉnh quyết_định thu_hồi đất , giao đất , cho thuê đất , cho phép chuyển mục_đích sử_dụng đất của thủ_tướng chính_phủ đã ban_hành trước ngày 01 tháng 7 năm 2004 có yêu_cầu thành_phần hồ_sơ những gì ?</code>
  <code>thủ_tục thông_báo hủy kết_quả phong phẩm hoặc suy cử chức_sắc đối_với các trường_hợp quy_định tại khoản 2 điều 33 của luật tín_ngưỡng , tôn_giáo được thực_hiện mức_độ trực_tuyến toàn_trình</code>	<code>thủ_tục thông_báo hủy kết_quả phong phẩm hoặc suy cử chức_sắc đối_với các trường_hợp quy_định tại khoản 2 điều 33 của luật tín_ngưỡng , tôn_giáo được thực_hiện mức_độ mấy ?</code>
  <code>thủ_tục đính_chính giấy chứng_nhận đã cấp có phí , lệ_phí là : trực_tiếp :</code>	<code>thủ_tục đính_chính giấy chứng_nhận đã cấp có phí , lệ_phí là bao_nhiêu ?</code>

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

  {
      "loss": "MultipleNegativesRankingLoss",
      "matryoshka_dims": [
          768,
          512
      ],
      "matryoshka_weights": [
          1,
          1
      ],
      "n_dims_per_step": -1
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy: epoch
• per_device_train_batch_size: 2
• per_device_eval_batch_size: 2
• gradient_accumulation_steps: 2
• learning_rate: 2e-05
• num_train_epochs: 1
• lr_scheduler_type: cosine
• warmup_ratio: 0.1
• fp16: 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: 2
• per_device_eval_batch_size: 2
• per_gpu_train_batch_size: None
• per_gpu_eval_batch_size: None
• gradient_accumulation_steps: 2
• eval_accumulation_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: 1
• 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: 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: False
• hub_always_push: False
• gradient_checkpointing: False
• gradient_checkpointing_kwargs: None
• include_inputs_for_metrics: False
• 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
• prompts: None
• batch_sampler: no_duplicates
• multi_dataset_batch_sampler: proportional

</details>

Training Logs

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

The model card is truncated. Read the rest on Hugging Face.