xlm-roberta-base-multilingual-mkqa

SentenceTransformer based on FacebookAI/xlm-roberta-base

This is a sentence-transformers model finetuned from FacebookAI/xlm-roberta-base. 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: FacebookAI/xlm-roberta-base <!-- at revision e73636d4f797dec63c3081bb6ed5c7b0bb3f2089 -->
• Maximum Sequence Length: 128 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': 128, 'do_lower_case': False}) with Transformer model: XLMRobertaModel 
  (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("luanafelbarros/xlm-roberta-base-multilingual-mkqa")
# Run inference
sentences = [
    'where does food wars anime end in the manga',
    '《食戟之靈》漫畫幾時完',
    'zh_hk',
]
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

Knowledge Distillation

• Datasets: MSE-val-en-to-ar, MSE-val-en-to-da, MSE-val-en-to-de, MSE-val-en-to-en, MSE-val-en-to-es, MSE-val-en-to-fi, MSE-val-en-to-fr, MSE-val-en-to-he, MSE-val-en-to-hu, MSE-val-en-to-it, MSE-val-en-to-ja, MSE-val-en-to-ko, MSE-val-en-to-km, MSE-val-en-to-ms, MSE-val-en-to-nl, MSE-val-en-to-no, MSE-val-en-to-pl, MSE-val-en-to-pt, MSE-val-en-to-ru, MSE-val-en-to-sv, MSE-val-en-to-th, MSE-val-en-to-tr, MSE-val-en-to-vi, MSE-val-en-to-zh_cn, MSE-val-en-to-zh_hk and MSE-val-en-to-zh_tw
• Evaluated with <code>MSEEvaluator</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: 234,000 training samples
• Columns: <code>english</code>, <code>non-english</code>, <code>target</code>, and <code>label</code>
• Approximate statistics based on the first 1000 samples:

  	english	non-english	target	label
  type	string	string	string	list
  details	<ul><li>min: 10 tokens</li><li>mean: 13.21 tokens</li><li>max: 19 tokens</li></ul>	<ul><li>min: 7 tokens</li><li>mean: 13.87 tokens</li><li>max: 31 tokens</li></ul>	<ul><li>min: 3 tokens</li><li>mean: 3.38 tokens</li><li>max: 6 tokens</li></ul>	<ul><li>size: 768 elements</li></ul>

• Samples:

  english	non-english	target	label
  <code>what are all the wizard of oz movies</code>	<code>the wizard of oz ما هي كل افلام</code>	<code>ar</code>	<code>[0.5303382277488708, -0.31762194633483887, -0.2945275902748108, -0.6602655649185181, -1.4617066383361816, ...]</code>
  <code>what are all the wizard of oz movies</code>	<code>hvad er alle troldmanden fra oz filmene</code>	<code>da</code>	<code>[0.5303382277488708, -0.31762194633483887, -0.2945275902748108, -0.6602655649185181, -1.4617066383361816, ...]</code>
  <code>what are all the wizard of oz movies</code>	<code>Wie heißen alle Der Zauberer von Oz Filme</code>	<code>de</code>	<code>[0.5303382277488708, -0.31762194633483887, -0.2945275902748108, -0.6602655649185181, -1.4617066383361816, ...]</code>

• Loss: <code>MSELoss</code>

Evaluation Dataset

Unnamed Dataset

• Size: 13,000 evaluation samples
• Columns: <code>english</code>, <code>non-english</code>, <code>target</code>, and <code>label</code>
• Approximate statistics based on the first 1000 samples:

  	english	non-english	target	label
  type	string	string	string	list
  details	<ul><li>min: 10 tokens</li><li>mean: 13.05 tokens</li><li>max: 22 tokens</li></ul>	<ul><li>min: 5 tokens</li><li>mean: 13.79 tokens</li><li>max: 34 tokens</li></ul>	<ul><li>min: 3 tokens</li><li>mean: 3.38 tokens</li><li>max: 6 tokens</li></ul>	<ul><li>size: 768 elements</li></ul>

• Samples:

  english	non-english	target	label
  <code>a change to the constitution must be approved by</code>	<code>يجب الموافقة على تغيير الدستور</code>	<code>ar</code>	<code>[1.0918692350387573, 0.8024187684059143, 0.23035858571529388, 0.16300565004348755, -0.6033854484558105, ...]</code>
  <code>a change to the constitution must be approved by</code>	<code>en ændring af forfatningen skal godkendes af</code>	<code>da</code>	<code>[1.0918692350387573, 0.8024187684059143, 0.23035858571529388, 0.16300565004348755, -0.6033854484558105, ...]</code>
  <code>a change to the constitution must be approved by</code>	<code>Eine Änderung der Verfassung muss gebilligt werden durch</code>	<code>de</code>	<code>[1.0918692350387573, 0.8024187684059143, 0.23035858571529388, 0.16300565004348755, -0.6033854484558105, ...]</code>

• Loss: <code>MSELoss</code>

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy: steps
• per_device_train_batch_size: 64
• per_device_eval_batch_size: 64
• learning_rate: 2e-05
• warmup_ratio: 0.1
• fp16: True

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: 64
• per_device_eval_batch_size: 64
• 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: 3
• 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: 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: False
• 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: batch_sampler
• 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.