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
• Maximum Sequence Length: 256 tokens
• Output Dimensionality: 768 dimensions
• Similarity Function: Cosine Similarity

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("duongluuba/AIP491_G9_Vietnam_tourism_data_bkai-foundation-fine-tuned-v1")
# Run inference
sentences = [
    'query: Cách chế biến hạt đác rim đường phèn như thế nào để giữ được độ giòn và vị ngọt thanh?',
    'passage: Các món ăn từ hạt đác dưới đây khá dễ chế biến và giải nhiệt rất tốt trong mùa hè. Hạt đác rim đường phèn Lựa hạt non và nấu đủ độ sẽ cho thành phẩm vừa dẻo, vừa giòn, quyện đường phèn nên ngọt thanh, bỏ thêm đá hoặc sữa chua vào ăn rất mát. com Cách phổ biến và đơn giản nhất để thưởng thức hạt đác là rim đường phèn. Hạt đác được rửa nhiều lần cho sạch, chần vào nước nóng già, nấu cho đến khi sôi lại khoảng năm phút thì vớt ra, xả với nước lạnh để không mất đi độ giòn. Mang phần hạt đác đã sơ chế này ngâm với đường phèn khoảng nửa tiếng cho thấm ngọt rồi rim trên chảo lớn, không cần thêm nước, đến khi đường sóng sánh, hạt đác có màu trong là hoàn thành.',
    'passage: Vườn quốc gia Ba Vì. Với diện tích gần 11.000 ha, vườn quốc gia Ba Vì được coi là "lá phổi xanh" phía Tây thủ đô Hà Nội. Tại vườn quốc gia có các địa điểm tham quan như nhà thờ cổ bỏ hoang, phủ kín rêu phong mang vẻ huyền bí, hay nhà kính xương rồng. Cũng như , hay , người Pháp xây dựng ở Ba Vì nhiều biệt thự nghỉ dưỡng ở cốt 400, 600 và 1.000. Chỉ khác là chúng đã bị tàn phá theo thăng trầm thời gian cùng thời cuộc. Bởi thế, du khách sẽ ngỡ ngàng trước những nền móng kiến trúc từ hàng trăm năm trước khi đi sâu vào trong rừng. Những khu nghỉ dưỡng, những bếp lò, những bức tường, tất cả đều được bao phủ bởi cây rừng và sương núi.',
]
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.8126, -0.0353],
#         [ 0.8126,  1.0000,  0.0099],
#         [-0.0353,  0.0099,  1.0000]])

Evaluation

Metrics

Information Retrieval

• Dataset: val
• Evaluated with main.InformationRetrievalEvaluator

Training Details

Training Dataset

Unnamed Dataset

• Size: 12,768 training samples
• Columns: sentence_0 and sentence_1
• Approximate statistics based on the first 1000 samples:

  	sentence_0	sentence_1
  type	string	string
  details	min: 15 tokensmean: 29.47 tokensmax: 51 tokens	min: 6 tokensmean: 152.52 tokensmax: 256 tokens

• Samples:

  sentence_0	sentence_1
  query: Di tích khảo cổ Văn hóa Sa Huỳnh ở Quảng Ngãi gồm những điểm di tích nào và được xếp hạng gì vào cuối năm 2022?	passage: Nhà trưng bày Văn hóa Sa Huỳnh. vn. Cuối năm 2022, Di tích khảo cổ Văn hoá Sa Huỳnh của tỉnh Quảng Ngãi được xếp hạng là Di tích quốc gia đặc biệt. Di tích khảo cổ gồm có 6 điểm di tích ở thị xã Đức Phổ gồm: di tích Long Thạnh (còn gọi là Gò Ma Vương), di tích Thạnh Đức, di tích Phú Khương, quần thể di tích Champa trong không gian Sa Huỳnh, đầm An Khê và lạch An Khê – sông Cửa Lỗ. Không gian trưng bày. Nền văn hóa Sa Huỳnh được nhà khảo cổ học người Pháp M. Vinet phát hiện năm 1909. Từ khu mộ chum Sa Huỳnh, qua các đợt khai quật, các nhà khảo cổ đã liên tục phát hiện các dấu vết của một nền văn hóa thời tiền sử.
  query: Rừng dừa Bảy Mẫu ở Hội An có đặc điểm gì thu hút du khách khi tham quan?	passage: Rừng dừa Bảy Mẫu. Địa chỉ: thôn Thanh Nhứt, Thanh Tam, Vạn Lăng, Xã Cẩm Thanh, Thành phố Hội An, Quảng Nam. Đặc điểm: Rừng dừa Bảy Mẫu Cẩm Thanh Hội An là điểm đến hấp dẫn du khách tham quan trong và ngoài nước. Sở dĩ có cái tên này vì ngày xưa, khu rừng này có khoảng 07 mẫu dừa tự do sinh sôi nảy nở. Tới nay, rừng đã phát triển lên hơn 100 ha nhưng người ta vẫn giữ cái tên rừng dừa Bảy Mẫu vì nó đã quá quen thuộc và thân thương với người dân và khách du lịch Hội An. Vì nằm ngay trong vùng nước lợ nên rất thích hợp cho dừa nước phát triển. Tới đây, du khách sẽ được thăm quan khu rừng hoàn toàn trên thuyền theo phong cách miền Tây Nam Bộ.
  query: Bánh cuốn trứng ở Lạng Sơn có điểm gì khác biệt so với bánh cuốn thường?	passage: Bánh cuốn trứng. Bánh cuốn trứng được làm từ gạo tẻ ngon xay nhuyễn với nước sao cho bột không bị khô hay loãng quá. Bánh được tráng trên nồi hấp có căng một lớp vải mỏng để bánh chín hoàn toàn bằng hơi nước nóng bốc lên. Khác với bánh cuốn thường, người Lạng Sơn dùng trứng để làm nhân bánh. Ngoài ra, bánh cuốn đúng điệu phải ăn với nước chấm pha bằng giấm làm từ một loại chuối chín cây ở Lạng Sơn, loại giấm đặc trưng chỉ xứ Lạng mới có.

• Loss: MultipleNegativesRankingLoss with these parameters:

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

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy: steps
• fp16: True
• multi_dataset_batch_sampler: round_robin

All Hyperparameters

• overwrite_output_dir: False
• do_predict: False
• eval_strategy: steps
• prediction_loss_only: True
• per_device_train_batch_size: 8
• per_device_eval_batch_size: 8
• 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: 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: 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: {}

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