distobert-finetuned-embedding-faq1-v1-1

SentenceTransformer based on sentence-transformers/all-distilroberta-v1

This is a sentence-transformers model finetuned from sentence-transformers/all-distilroberta-v1. 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: sentence-transformers/all-distilroberta-v1 <!-- at revision 842eaed40bee4d61673a81c92d5689a8fed7a09f -->
• Maximum Sequence Length: 512 tokens
• Output Dimensionality: 768 dimensions
• Similarity Function: Cosine Similarity

<!-- - **Training Dataset:** Unknown --> <!-- - **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': 512, '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})
  (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 = [
    'The weather is lovely today.',
    "It's so sunny outside!",
    'He drove to the stadium.',
]
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

Triplet

• Datasets: ai-faq-validation and ai-job-test
• Evaluated with <code>TripletEvaluator</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

Unnamed Dataset

• Size: 19 training samples
• Columns: <code>question</code>, <code>answer</code>, and <code>answer_neg</code>
• Approximate statistics based on the first 19 samples:

  	question	answer	answer_neg
  type	string	string	string
  details	<ul><li>min: 21 tokens</li><li>mean: 59.47 tokens</li><li>max: 120 tokens</li></ul>	<ul><li>min: 2 tokens</li><li>mean: 250.11 tokens</li><li>max: 512 tokens</li></ul>	<ul><li>min: 2 tokens</li><li>mean: 262.47 tokens</li><li>max: 512 tokens</li></ul>

• Samples:

  question	answer	answer_neg
  <code>در آبان پرایم چه خدماتی دریافت میکنم؟</code>	<code>آبان پرایم یک صرافی آنلاین است به این معنی که شما تمامی خدمات صرافی را میتوانید به صورت آنلاین و غیر حضوری دریافت کنید. <br>خدمات ما شامل:<br>- امکان خرید و فروش ارزهای مختلف تومان، تتر، درهم، دلار آمریکا، دلار استرالیا، دلار کانادا، لیر ترکیه<br>- نرخ لحظه ای<br>- واریز و برداشت نقدی<br>- انجام انواع حوالجات <br>- واریز مستقیم به حساب شبا ایران با هر رقم از طریق وبسایت<br>- امکان دریافت گزارش صورت حساب ها<br>- پشتیبانی ۲۴ ساعته</code>	<code> </code>
  <code>توی امارات به کدوم بانک ها واریز انجام میدین؟</code>	<code>واریز به تمامی بانک های امارات انجام میشود.</code>	<code>شما میتوانید با شماره موبایل(با پیش شماره های ایران،امارات، ترکیه، کانادا و استرالیا) یا ایمیل به راحتی حساب کاربری بسازید<br>https://youtu.be/Sl1ehlS6TYY<br><br> برای ثبت‌نام:<br>۱) شماره موبایل یا ایمیل خودتون را وارد کنید<br>۲) در مرحله بعد کد تایید ارسال شده به موبایل یا ایمیل رو وارد کنید<br>۳) رمز عبور خودتون رو تعریف کنید و وارد حساب کاربری بشید</code>
  <code>واریز و برداشت تتر</code>	<code>واریز و برداشت تتر در آبان پرایم به صورت کاملا آنلاین انجام میشود. <br>https://youtu.be/ARzOJ6Pgp7k<br><br>واریز تتر<br>۱) در صفحه اصلی گزینه deposit تتر رو انتخاب کنید<br>۲) شبکه واریز (TRC20 یا BSC) رو انتخاب و آدرس ولت رو کپی کنید.<br>۴) تتر مورد نظرتون رو از ولت مبدا به آدرس ولت آبان پرام انتقال بدید.<br>۵) چند دقیقه بعد از انتقال تراکنش انجام میشه و اکانت آبان پرایمتون مستقیما شارژ میشه.<br><br>برداشت تتر<br>۱) در صفحه اصلی گزینه Withdraw تتر رو انتخاب کنید.<br>۳) یکی از شبکه‌های برداشت (TRC20 یا BSC) رو انتخاب کنید.<br>۴) آدرس کیف پول مقصد رو وارد کنید<br>آدرس مقصد رو دقیق و منطبق با شبکه برداشت انتخابی وارد کنید.<br>۵) مقدار تتری که می‌خواهید برداشت کنید رو وارد کنید.<br>۶) بعد از بررسی و اطمینان از صحت اطلاعات درخواست برداشت خود را ثبت کنید.</code>	<code>واریز به تمامی بانک های امارات انجام میشود.</code>

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

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

Evaluation Dataset

Unnamed Dataset

• Size: 1 evaluation samples
• Columns: <code>question</code>, <code>answer</code>, and <code>answer_neg</code>
• Approximate statistics based on the first 1 samples:

  	question	answer	answer_neg
  type	string	string	string
  details	<ul><li>min: 52 tokens</li><li>mean: 52.0 tokens</li><li>max: 52 tokens</li></ul>	<ul><li>min: 512 tokens</li><li>mean: 512.0 tokens</li><li>max: 512 tokens</li></ul>	<ul><li>min: 50 tokens</li><li>mean: 50.0 tokens</li><li>max: 50 tokens</li></ul>

• Samples:

  question	answer	answer_neg
  <code>رمز عبورم رو فراموش کردم چیکار باید بکنم؟</code>	<code>۱) انتخاب گزینه فراموشی رمز عبور( Forgot Password)<br>۲) وارد کردن شماره موبایل یا ایمیل<br>۳) وارد کردن کد امنیتی دریافتی از طریق پیامک یا ایمیل<br>۴) تعریف رمز جدید<br><br>اگر پیامک رمز یک‌بارمصرف (OTP) دریافت نمی‌کنید، این مراحل رو انجام بده: <br>- شماره موبایل رو درست وارد کن. (با پیش‌شماره صحیح) <br>- چند دقیقه صبر کن و دوباره تلاش کن. ممکنه گاهی اختلال موقتی از سمت سرویس‌دهنده پیامک باشه.<br>- اینترنت و آنتن گوشی رو بررسی کن. <br>- پوشه پیامک‌های تبلیغاتی و مسدودشده رو چک کن. <br>- دوباره درخواست کد بده و مطمئن شو که تعداد دفعات مجاز تموم نشده. <br>- اگر باز هم دریافت نکردی، با پشتیبانی تماس بگیر. <br></code>	<code>برای انجام حواله با پشتیبانی تماس بگیرید.</code>

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

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

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy: steps
• per_device_train_batch_size: 16
• per_device_eval_batch_size: 16
• learning_rate: 2e-05
• num_train_epochs: 200
• warmup_ratio: 0.1
• batch_sampler: no_duplicates

All Hyperparameters

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

• overwrite_output_dir: False
• do_predict: False
• eval_strategy: steps
• 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: 1
• 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: 200
• max_steps: -1
• lr_scheduler_type: linear
• 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: False
• 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
• 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

Framework Versions

• Python: 3.10.16
• Sentence Transformers: 3.4.1
• Transformers: 4.50.0.dev0
• PyTorch: 2.6.0+cu124
• Accelerate: 1.3.0
• Datasets: 3.3.2
• Tokenizers: 0.21.0

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

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