Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 17
How to use Shaurya2020/allpanel-api-minilm with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("Shaurya2020/allpanel-api-minilm")
sentences = [
"allpanelexch9 auth 2fa 2fa",
"POST https://allpanelexch9.co/api/front/2fa (auth_2fa)",
"POST https://allpanelexch9.co/api/front/userdata (account)",
"POST https://allpanelexch9.co/api/front/authoff (auth_2fa)"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from sentence-transformers/all-MiniLM-L6-v2 on the json dataset. It maps inputs to a 384-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, classification, clustering, and more.
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': 384, 'pooling_mode': 'mean', 'include_prompt': True})
(2): Normalize({'module_input_name': 'sentence_embedding', 'module_output_name': 'sentence_embedding'})
)
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("Shaurya2020/allpanel-api-minilm")
# Run inference
queries = [
'allpanelexch9 auth 2fa authon',
]
documents = [
'POST https://allpanelexch9.co/api/front/authon (auth_2fa)',
'POST https://allpanelexch9.co/api/front/accountstatement (account)',
'POST https://allpanelexch9.co/api/front/save-subscription (account)',
]
query_embeddings = model.encode_query(queries)
document_embeddings = model.encode_document(documents)
print(query_embeddings.shape, document_embeddings.shape)
# [1, 384] [3, 384]
# Get the similarity scores for the embeddings
similarities = model.similarity(query_embeddings, document_embeddings)
print(similarities)
# tensor([[0.8341, 0.3827, 0.2623]])
allpanel-apiInformationRetrievalEvaluator| Metric | Value |
|---|---|
| cosine_accuracy@1 | 0.8571 |
| cosine_accuracy@5 | 0.8571 |
| cosine_accuracy@10 | 0.8571 |
| cosine_precision@1 | 0.8571 |
| cosine_precision@3 | 0.8571 |
| cosine_precision@5 | 0.8571 |
| cosine_precision@10 | 0.8571 |
| cosine_recall@1 | 0.0466 |
| cosine_recall@3 | 0.1398 |
| cosine_recall@5 | 0.233 |
| cosine_recall@10 | 0.4661 |
| cosine_ndcg@10 | 0.8571 |
| cosine_mrr@10 | 0.8571 |
| cosine_map@100 | 0.8471 |
anchor and positive| anchor | positive | |
|---|---|---|
| type | string | string |
| modality | text | text |
| details |
|
|
| anchor | positive |
|---|---|
allpanelexch9 account acceptrules |
POST https://allpanelexch9.co/api/front/acceptrules (account) |
allpanelexch9 account accountstatement |
POST https://allpanelexch9.co/api/front/accountstatement (account) |
allpanelexch9 account activity |
POST https://allpanelexch9.co/api/front/activity (account) |
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
}
anchor and positive| anchor | positive | |
|---|---|---|
| type | string | string |
| modality | text | text |
| details |
|
|
| anchor | positive |
|---|---|
allpanelexch9 account acceptrules |
POST https://allpanelexch9.co/api/front/acceptrules (account) |
allpanelexch9 account accountstatement |
POST https://allpanelexch9.co/api/front/accountstatement (account) |
allpanelexch9 account activity |
POST https://allpanelexch9.co/api/front/activity (account) |
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: 16learning_rate: 2e-05warmup_steps: 0.1weight_decay: 0.01per_device_eval_batch_size: 16load_best_model_at_end: Trueseed: 12batch_sampler: no_duplicatesper_device_train_batch_size: 16num_train_epochs: 3max_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: Falsebf16_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: Nonetrackio_bucket_id: Nonetrackio_static_space_id: Noneper_device_eval_batch_size: 16prediction_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: 12data_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: Nonedataloader_multiprocessing_context: Nonedataloader_in_order: Trueremove_unused_columns: Truelabel_names: Nonetrain_sampling_strategy: randomlength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falseddp_static_graph: Noneddp_backend: Noneddp_timeout: 1800fsdp: Nonefsdp_config: Nonedeepspeed: Nonedebug: []skip_memory_metrics: Truedo_predict: Falseresume_from_checkpoint: Nonelocal_rank: -1prompts: Nonebatch_sampler: no_duplicatesmulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}warmup_ratio: None| Epoch | Step | Training Loss | Validation Loss | allpanel-api_cosine_ndcg@10 |
|---|---|---|---|---|
| -1 | -1 | - | - | 0.8287 |
| 0.1111 | 1 | 0.4021 | - | - |
| 0.2222 | 2 | 0.3945 | - | - |
| 0.3333 | 3 | 0.2125 | - | - |
| 0.4444 | 4 | 0.1483 | - | - |
| 0.5556 | 5 | 0.2181 | - | - |
| 0.6667 | 6 | 0.2660 | - | - |
| 0.7778 | 7 | 0.1646 | - | - |
| 0.8889 | 8 | 0.1251 | - | - |
| 1.0 | 9 | 0.046 | 0.1124 | 0.8571 |
| 1.1111 | 10 | 0.0401 | - | - |
| 1.2222 | 11 | 0.0467 | - | - |
| 1.3333 | 12 | 0.0109 | - | - |
| 1.4444 | 13 | 0.2869 | - | - |
| 1.5556 | 14 | 0.0594 | - | - |
| 1.6667 | 15 | 0.0904 | - | - |
| 1.7778 | 16 | 0.0843 | - | - |
| 1.8889 | 17 | 0.0857 | - | - |
| 2.0 | 18 | 0.0003 | 0.0480 | 0.8571 |
| 2.1111 | 19 | 0.0337 | - | - |
| 2.2222 | 20 | 0.0281 | - | - |
| 2.3333 | 21 | 0.0118 | - | - |
| 2.4444 | 22 | 0.0060 | - | - |
| 2.5556 | 23 | 0.0058 | - | - |
| 2.6667 | 24 | 0.0051 | - | - |
| 2.7778 | 25 | 0.0183 | - | - |
| 2.8889 | 26 | 0.0460 | - | - |
| 3.0 | 27 | 0.0308 | 0.0366 | 0.8571 |
| -1 | -1 | - | - | 0.8571 |
@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
nreimers/MiniLM-L6-H384-uncased