iwillcthew/vietnamese-embedding-PROPTIT-domain-ft

SentenceTransformer based on AITeamVN/Vietnamese_Embedding_v2

This is a sentence-transformers model finetuned from AITeamVN/Vietnamese_Embedding_v2. 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_v2
• Maximum Sequence Length: 512 tokens
• Output Dimensionality: 1024 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': 512, '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:

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
sentences = [
    'Các hoạt động gây quỹ của CLB được tổ chức ra sao?',
    'TRAINING: Trong quá trình training, các bạn sẽ được đào tạo và sử dụng thành thạo về ngôn ngữ C. Ngôn ngữ C là một ngôn ngữ phổ biến, cú pháp tường minh, dễ sử dụng đối với những người bắt đầu với lập trình. Và điều đặc biệt cho các PTITER là ngôn ngữ C sẽ được học vào kỳ 2 năm nhất, cho nên bạn sẽ có lợi thế khi mà tham gia khoá training này.',
    'Nhận được quyền lợi gì khi tham gia vào CLB ? Khi bạn vào CLB bạn sẽ có những lợi thế về các môn chuyên ngành trên trường. CLB sẽ giúp các bạn định hướng phát triển các kỹ năng lập trình. Bên cạnh đó CLB còn tổ chức các hoạt động ngoại khóa để các thành viên gắn kết hơn. Ngoài ra khi tham gia vào các CLB bạn sẽ được cộng 0.1 điểm khuyến khích học bổng (Đây sẽ là 1 lợi thế rất lớn khi xét học bổng tại Học Viện vào cuối kì bạn 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]

Evaluation

Metrics

Semantic Similarity

• Dataset: validation
• Evaluated with EmbeddingSimilarityEvaluator

Metric	Value
pearson_cosine	0.7532
spearman_cosine	0.7062

Training Details

Training Dataset

Unnamed Dataset

• Size: 1,457 training samples
• Columns: sentence_0, sentence_1, and label
• Approximate statistics based on the first 1000 samples:

  	sentence_0	sentence_1	label
  type	string	string	float
  details	min: 7 tokens mean: 18.48 tokens max: 34 tokens	min: 10 tokens mean: 112.0 tokens max: 512 tokens	min: 0.0 mean: 0.65 max: 1.0

• Samples:

  sentence_0	sentence_1	label
  CLB này có thường xuyên tổ chức các buổi sinh hoạt cho thành viên không?	PHÒNG TRUYỀN THỐNG:	0.0
  Hoạt động gây quỹ của Câu lạc bộ được triển khai ra sao?	Tham gia CLB có mất phí không ạ ? Khi trở thành thành viên chính thức, CLB cũng có một khoản thu nhỏ hàng tháng gọi là quỹ để duy trì CLB nhé em.	1.0
  Để rèn luyện tay nghề lập trình, CLB có các hoạt động cụ thể gì cho hội viên?	BIG GAME S2B Là một hoạt động ngoại khóa thường niên được tổ chức nhằm mục đích gắn kết các thành viên giữa ba câu lạc bộ thuộc cộng đồng S2B là CLB Lập trình PTIT, CLB Multimedia PTIT và CLB Nhà sáng tạo game PTIT. Đây là buổi để 3 bên CLB Multimedia PTIT, CLB Nhà sáng tạo game PTIT và CLB PROPTIT gặp mặt, cùng nhau nhìn lại chặng đường đã qua và đồng thời tri ân thế hệ đi trước.	0.0

• Loss: CosineSimilarityLoss with these parameters:

  {
      "loss_fct": "torch.nn.modules.loss.MSELoss"
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy: steps
• per_device_train_batch_size: 2
• per_device_eval_batch_size: 2
• fp16: True
• multi_dataset_batch_sampler: round_robin

All Hyperparameters

Click to expand

• overwrite_output_dir: False
• do_predict: False
• eval_strategy: steps
• 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: 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
• 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: 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}
• deepspeed: None
• label_smoothing_factor: 0.0
• optim: adamw_torch
• 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
• 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: batch_sampler
• multi_dataset_batch_sampler: round_robin

Training Logs

Epoch	Step	Training Loss	validation_spearman_cosine
0.9973	364	-	0.6508
1.0	365	-	0.6474
1.3699	500	0.1352	-
1.9945	728	-	0.6794
2.0	730	-	0.6800
2.7397	1000	0.0688	-
2.9918	1092	-	0.7062

Framework Versions

• Python: 3.11.13
• Sentence Transformers: 4.1.0
• Transformers: 4.52.4
• PyTorch: 2.6.0+cu124
• Accelerate: 1.8.1
• Datasets: 3.6.0
• Tokenizers: 0.21.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",
}