Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 19
How to use Folma/IndoBERT-Retail-Search-Model with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("Folma/IndoBERT-Retail-Search-Model")
sentences = [
"PILIHAN PEWARNA MAKANAN DARI KUPU KUPU",
"YURI HS PREMIUM ROSE POUCH 375 ML",
"NUTRIJELL RASA CHO 30 GR",
"KUPU KUPU SEP.CAIR HJU TUA 30 ML"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from indobenchmark/indobert-base-p2. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for retrieval.
SentenceTransformer(
(0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'BertModel'})
(1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', 'include_prompt': True})
)
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("Folma/IndoBERT-Retail-Search-Model")
# Run inference
sentences = [
'KATALOG PRODUK ASEPSO SABUN BADAN BATANG',
'ASEPSO BAR SOAP FRESH 80 GR',
'JOHNSONS BABY OIL 125 ML',
]
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.8572, -0.1430],
# [ 0.8572, 1.0000, -0.1383],
# [-0.1430, -0.1383, 1.0000]])
retail-production-evalInformationRetrievalEvaluator| Metric | Value |
|---|---|
| cosine_accuracy@1 | 0.3367 |
| cosine_accuracy@3 | 0.5963 |
| cosine_accuracy@5 | 0.7027 |
| cosine_accuracy@10 | 0.8207 |
| cosine_precision@1 | 0.3367 |
| cosine_precision@3 | 0.1988 |
| cosine_precision@5 | 0.1405 |
| cosine_precision@10 | 0.0821 |
| cosine_recall@1 | 0.3367 |
| cosine_recall@3 | 0.5963 |
| cosine_recall@5 | 0.7027 |
| cosine_recall@10 | 0.8207 |
| cosine_ndcg@10 | 0.5704 |
| cosine_mrr@10 | 0.4912 |
| cosine_map@100 | 0.4988 |
anchor, positive, and negative| anchor | positive | negative | |
|---|---|---|---|
| type | string | string | string |
| details |
|
|
|
| anchor | positive | negative |
|---|---|---|
IKAN LAUT MERK SEAFOOD |
IKAN FRESH KEMBUNG COMO KG |
MABELL SOSIS KEJU 60GR |
KATALOG PRODUK BU SANDRA SAUS SAMBAL |
BU SANDRA SAMBAL UDANG 150g |
CADBURY LICKABLE DAIRY MILK 20GR |
PILIHAN BUMBU KOREA DARI O FOOD |
O'FOOD KIMCHI JJIGAE SAUCE 120g |
MAMASUKA RUMPUT LAUT RENDANG 4.5X2 |
MultipleNegativesRankingLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false,
"directions": [
"query_to_doc"
],
"partition_mode": "joint",
"hardness_mode": null,
"hardness_strength": 0.0
}
per_device_train_batch_size: 64num_train_epochs: 50learning_rate: 2e-05warmup_steps: 0.1weight_decay: 0.01fp16: Trueeval_strategy: stepsload_best_model_at_end: Trueper_device_train_batch_size: 64num_train_epochs: 50max_steps: -1learning_rate: 2e-05lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_steps: 0.1optim: adamw_torch_fusedoptim_args: Noneweight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08optim_target_modules: Nonegradient_accumulation_steps: 1average_tokens_across_devices: Truemax_grad_norm: 1.0label_smoothing_factor: 0.0bf16: Falsefp16: Truebf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Nonetorch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneuse_liger_kernel: Falseliger_kernel_config: Noneuse_cache: Falseneftune_noise_alpha: Nonetorch_empty_cache_steps: Noneauto_find_batch_size: Falselog_on_each_node: Truelogging_nan_inf_filter: Trueinclude_num_input_tokens_seen: nolog_level: passivelog_level_replica: warningdisable_tqdm: Falseproject: huggingfacetrackio_space_id: trackioeval_strategy: stepsper_device_eval_batch_size: 8prediction_loss_only: Trueeval_on_start: Falseeval_do_concat_batches: Trueeval_use_gather_object: Falseeval_accumulation_steps: Noneinclude_for_metrics: []batch_eval_metrics: Falsesave_only_model: Falsesave_on_each_node: Falseenable_jit_checkpoint: Falsepush_to_hub: Falsehub_private_repo: Nonehub_model_id: Nonehub_strategy: every_savehub_always_push: Falsehub_revision: Noneload_best_model_at_end: Trueignore_data_skip: Falserestore_callback_states_from_checkpoint: Falsefull_determinism: Falseseed: 42data_seed: Noneuse_cpu: Falseaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedataloader_drop_last: Falsedataloader_num_workers: 0dataloader_pin_memory: Truedataloader_persistent_workers: Falsedataloader_prefetch_factor: Noneremove_unused_columns: Truelabel_names: Nonetrain_sampling_strategy: randomlength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falseddp_backend: Noneddp_timeout: 1800fsdp: []fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}deepspeed: Nonedebug: []skip_memory_metrics: Truedo_predict: Falseresume_from_checkpoint: Nonewarmup_ratio: Nonelocal_rank: -1prompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | retail-production-eval_cosine_ndcg@10 |
|---|---|---|---|
| 0.5862 | 500 | 1.6535 | 0.4757 |
| 1.1723 | 1000 | 0.8146 | 0.5074 |
| 1.7585 | 1500 | 0.5929 | 0.5271 |
| 2.3447 | 2000 | 0.4561 | 0.5407 |
| 2.9308 | 2500 | 0.4064 | 0.5501 |
| 3.5170 | 3000 | 0.3404 | 0.5539 |
| 4.1032 | 3500 | 0.3302 | 0.5593 |
| 4.6893 | 4000 | 0.2986 | 0.5644 |
| 5.2755 | 4500 | 0.2868 | 0.5641 |
| 5.8617 | 5000 | 0.2767 | 0.5644 |
| 6.4478 | 5500 | 0.2532 | 0.571 |
| 7.0340 | 6000 | 0.2495 | 0.5684 |
| 7.6202 | 6500 | 0.2346 | 0.5676 |
| 8.2063 | 7000 | 0.2286 | 0.5704 |
@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",
}
@misc{oord2019representationlearningcontrastivepredictive,
title={Representation Learning with Contrastive Predictive Coding},
author={Aaron van den Oord and Yazhe Li and Oriol Vinyals},
year={2019},
eprint={1807.03748},
archivePrefix={arXiv},
primaryClass={cs.LG},
url={https://arxiv.org/abs/1807.03748},
}
Base model
indobenchmark/indobert-base-p2