Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use ewideplus/indoedu-e5-base with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("ewideplus/indoedu-e5-base")
sentences = [
"The weather is lovely today.",
"It's so sunny outside!",
"He drove to the stadium."
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]This is a sentence-transformers model finetuned from intfloat/multilingual-e5-base on the stsb-indo-edu 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.
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, '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})
(2): Normalize()
)
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("ewideplus/indoedu-e5-base")
# 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]
stsb-indo-edu-dev and stsb-indo-edu-testEmbeddingSimilarityEvaluator| Metric | stsb-indo-edu-dev | stsb-indo-edu-test |
|---|---|---|
| pearson_cosine | 0.193 | 0.1507 |
| spearman_cosine | 0.1765 | 0.1512 |
sentence1, sentence2, and score| sentence1 | sentence2 | score | |
|---|---|---|---|
| type | list | list | float |
| details |
|
|
|
| sentence1 | sentence2 | score |
|---|---|---|
['query: P', 'query: e', 'query: l', 'query: a', 'query: j', ...] |
['passage: T', 'passage: a', 'passage: r', 'passage: i', 'passage: a', ...] |
0.76 |
['query: S', 'query: e', 'query: b', 'query: e', 'query: l', ...] |
['passage: U', 'passage: p', 'passage: a', 'passage: y', 'passage: a', ...] |
0.85 |
['query: B', 'query: e', 'query: b', 'query: e', 'query: r', ...] |
['passage: I', 'passage: n', 'passage: i', 'passage: ', 'passage: m', ...] |
0.63 |
CoSENTLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "pairwise_cos_sim"
}
sentence1, sentence2, and score| sentence1 | sentence2 | score | |
|---|---|---|---|
| type | list | list | float |
| details |
|
|
|
| sentence1 | sentence2 | score |
|---|---|---|
['query: S', 'query: e', 'query: o', 'query: r', 'query: a', ...] |
['passage: S', 'passage: e', 'passage: o', 'passage: r', 'passage: a', ...] |
1.0 |
['query: S', 'query: e', 'query: o', 'query: r', 'query: a', ...] |
['passage: S', 'passage: e', 'passage: o', 'passage: r', 'passage: a', ...] |
0.95 |
['query: S', 'query: e', 'query: o', 'query: r', 'query: a', ...] |
['passage: P', 'passage: r', 'passage: i', 'passage: a', 'passage: ', ...] |
1.0 |
CoSENTLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "pairwise_cos_sim"
}
eval_strategy: stepsper_device_train_batch_size: 32per_device_eval_batch_size: 16learning_rate: 1e-05weight_decay: 0.01num_train_epochs: 5warmup_ratio: 0.1fp16: Trueoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 32per_device_eval_batch_size: 16per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 1e-05weight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 5max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: {}warmup_ratio: 0.1warmup_steps: 0log_level: passivelog_level_replica: warninglog_on_each_node: Truelogging_nan_inf_filter: Truesave_safetensors: Truesave_on_each_node: Falsesave_only_model: Falserestore_callback_states_from_checkpoint: Falseno_cuda: Falseuse_cpu: Falseuse_mps_device: Falseseed: 42data_seed: Nonejit_mode_eval: Falseuse_ipex: Falsebf16: Falsefp16: Truefp16_opt_level: O1half_precision_backend: autobf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: 0ddp_backend: Nonetpu_num_cores: Nonetpu_metrics_debug: Falsedebug: []dataloader_drop_last: Falsedataloader_num_workers: 0dataloader_prefetch_factor: Nonepast_index: -1disable_tqdm: Falseremove_unused_columns: Truelabel_names: Noneload_best_model_at_end: Falseignore_data_skip: Falsefsdp: []fsdp_min_num_params: 0fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}fsdp_transformer_layer_cls_to_wrap: Noneaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}deepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torchoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falsedataloader_pin_memory: Truedataloader_persistent_workers: Falseskip_memory_metrics: Trueuse_legacy_prediction_loop: Falsepush_to_hub: Falseresume_from_checkpoint: Nonehub_model_id: Nonehub_strategy: every_savehub_private_repo: Nonehub_always_push: Falsegradient_checkpointing: Falsegradient_checkpointing_kwargs: Noneinclude_inputs_for_metrics: Falseinclude_for_metrics: []eval_do_concat_batches: Truefp16_backend: autopush_to_hub_model_id: Nonepush_to_hub_organization: Nonemp_parameters: auto_find_batch_size: Falsefull_determinism: Falsetorchdynamo: Noneray_scope: lastddp_timeout: 1800torch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Nonedispatch_batches: Nonesplit_batches: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: Falseneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseeval_use_gather_object: Falseaverage_tokens_across_devices: Falseprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportional| Epoch | Step | Training Loss | Validation Loss | stsb-indo-edu-dev_spearman_cosine | stsb-indo-edu-test_spearman_cosine |
|---|---|---|---|---|---|
| -1 | -1 | - | - | 0.0995 | - |
| 0.5155 | 100 | 6.2244 | 4.7594 | 0.1027 | - |
| 1.0309 | 200 | 6.1605 | 4.7518 | 0.1502 | - |
| 1.5464 | 300 | 6.16 | 4.7553 | 0.1564 | - |
| 2.0619 | 400 | 6.1609 | 4.7527 | 0.1714 | - |
| 2.5773 | 500 | 6.1593 | 4.7698 | 0.1495 | - |
| 3.0928 | 600 | 6.1517 | 4.7516 | 0.1657 | - |
| 3.6082 | 700 | 6.1555 | 4.7463 | 0.1787 | - |
| 4.1237 | 800 | 6.1452 | 4.7548 | 0.1665 | - |
| 4.6392 | 900 | 6.1523 | 4.7494 | 0.1765 | - |
| -1 | -1 | - | - | - | 0.1512 |
@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",
}
@online{kexuefm-8847,
title={CoSENT: A more efficient sentence vector scheme than Sentence-BERT},
author={Su Jianlin},
year={2022},
month={Jan},
url={https://kexue.fm/archives/8847},
}
Base model
intfloat/multilingual-e5-base
from sentence_transformers import SentenceTransformer model = SentenceTransformer("ewideplus/indoedu-e5-base") sentences = [ "The weather is lovely today.", "It's so sunny outside!", "He drove to the stadium." ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [3, 3]