|
---
|
|
base_model: sentence-transformers/all-mpnet-base-v2
|
|
datasets: []
|
|
language: []
|
|
library_name: sentence-transformers
|
|
metrics:
|
|
- pearson_cosine
|
|
- spearman_cosine
|
|
- pearson_manhattan
|
|
- spearman_manhattan
|
|
- pearson_euclidean
|
|
- spearman_euclidean
|
|
- pearson_dot
|
|
- spearman_dot
|
|
- pearson_max
|
|
- spearman_max
|
|
pipeline_tag: sentence-similarity
|
|
tags:
|
|
- sentence-transformers
|
|
- sentence-similarity
|
|
- feature-extraction
|
|
- generated_from_trainer
|
|
- dataset_size:50
|
|
- loss:CosineSimilarityLoss
|
|
widget:
|
|
- source_sentence: Freepoint Commodity services venture
|
|
sentences:
|
|
- DUPLI OF 823707 BITUBULK SRL VESSEL
|
|
- Freepoint Commodities LLC
|
|
- AUGUSTA ENERGY DMCC
|
|
- source_sentence: BNG INT private ltd
|
|
sentences:
|
|
- BGN INT DMCC
|
|
- Count Energy PA
|
|
- BB Energy Group Holding Ltd
|
|
- source_sentence: Act fuel ball venture
|
|
sentences:
|
|
- ADDAX ENERGY SA
|
|
- BITUME INVEST S.A.R.L
|
|
- Altis Group International, LLC
|
|
- source_sentence: BW gas product ltd
|
|
sentences:
|
|
- Bulk Trading SA
|
|
- BINH SON REFINING AND PETRO LPIINTL
|
|
- BW LPG PRODUCT SERVICES LPIINTL
|
|
- source_sentence: Altis private limited
|
|
sentences:
|
|
- E1 Corporation
|
|
- Diersch & Schrder GmbH & Co. KG
|
|
- Altis Group International, LLC
|
|
model-index:
|
|
- name: SentenceTransformer based on sentence-transformers/all-mpnet-base-v2
|
|
results:
|
|
- task:
|
|
type: semantic-similarity
|
|
name: Semantic Similarity
|
|
dataset:
|
|
name: sts test
|
|
type: sts-test
|
|
metrics:
|
|
- type: pearson_cosine
|
|
value: 0.9446733306821109
|
|
name: Pearson Cosine
|
|
- type: spearman_cosine
|
|
value: 0.9249801057480238
|
|
name: Spearman Cosine
|
|
- type: pearson_manhattan
|
|
value: 0.9624404790642681
|
|
name: Pearson Manhattan
|
|
- type: spearman_manhattan
|
|
value: 0.9269933391918109
|
|
name: Spearman Manhattan
|
|
- type: pearson_euclidean
|
|
value: 0.9638295828361044
|
|
name: Pearson Euclidean
|
|
- type: spearman_euclidean
|
|
value: 0.9249801057480238
|
|
name: Spearman Euclidean
|
|
- type: pearson_dot
|
|
value: 0.9446733259374165
|
|
name: Pearson Dot
|
|
- type: spearman_dot
|
|
value: 0.9249801057480238
|
|
name: Spearman Dot
|
|
- type: pearson_max
|
|
value: 0.9638295828361044
|
|
name: Pearson Max
|
|
- type: spearman_max
|
|
value: 0.9269933391918109
|
|
name: Spearman Max
|
|
---
|
|
|
|
# SentenceTransformer based on sentence-transformers/all-mpnet-base-v2
|
|
|
|
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) on the train 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.
|
|
|
|
## Model Details
|
|
|
|
### Model Description
|
|
- **Model Type:** Sentence Transformer
|
|
- **Base model:** [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) <!-- at revision 84f2bcc00d77236f9e89c8a360a00fb1139bf47d -->
|
|
- **Maximum Sequence Length:** 384 tokens
|
|
- **Output Dimensionality:** 768 tokens
|
|
- **Similarity Function:** Cosine Similarity
|
|
- **Training Dataset:**
|
|
- train
|
|
<!-- - **Language:** Unknown -->
|
|
<!-- - **License:** Unknown -->
|
|
|
|
### Model Sources
|
|
|
|
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
|
|
- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
|
|
- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
|
|
|
|
### Full Model Architecture
|
|
|
|
```
|
|
SentenceTransformer(
|
|
(0): Transformer({'max_seq_length': 384, 'do_lower_case': False}) with Transformer model: MPNetModel
|
|
(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:
|
|
|
|
```bash
|
|
pip install -U sentence-transformers
|
|
```
|
|
|
|
Then you can load this model and run inference.
|
|
```python
|
|
from sentence_transformers import SentenceTransformer
|
|
|
|
# Download from the 🤗 Hub
|
|
model = SentenceTransformer("akshitguptafintek24/exxon-semantic-search")
|
|
# Run inference
|
|
sentences = [
|
|
'Altis private limited',
|
|
'Altis Group International, LLC',
|
|
'Diersch & Schrder GmbH & Co. KG',
|
|
]
|
|
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
|
|
|
|
#### Semantic Similarity
|
|
* Dataset: `sts-test`
|
|
* Evaluated with [<code>EmbeddingSimilarityEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.EmbeddingSimilarityEvaluator)
|
|
|
|
| Metric | Value |
|
|
|:--------------------|:----------|
|
|
| pearson_cosine | 0.9447 |
|
|
| **spearman_cosine** | **0.925** |
|
|
| pearson_manhattan | 0.9624 |
|
|
| spearman_manhattan | 0.927 |
|
|
| pearson_euclidean | 0.9638 |
|
|
| spearman_euclidean | 0.925 |
|
|
| pearson_dot | 0.9447 |
|
|
| spearman_dot | 0.925 |
|
|
| pearson_max | 0.9638 |
|
|
| spearman_max | 0.927 |
|
|
|
|
<!--
|
|
## 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
|
|
|
|
#### train
|
|
|
|
* Dataset: train
|
|
* Size: 50 training samples
|
|
* Columns: <code>Applicant name</code>, <code>Customer name</code>, and <code>score</code>
|
|
* Approximate statistics based on the first 1000 samples:
|
|
| | Applicant name | Customer name | score |
|
|
|:--------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------|
|
|
| type | string | string | float |
|
|
| details | <ul><li>min: 5 tokens</li><li>mean: 7.36 tokens</li><li>max: 16 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 8.32 tokens</li><li>max: 17 tokens</li></ul> | <ul><li>min: 0.54</li><li>mean: 0.86</li><li>max: 1.0</li></ul> |
|
|
* Samples:
|
|
| Applicant name | Customer name | score |
|
|
|:-----------------------------------|:--------------------------------------|:------------------|
|
|
| <code>Act Commodity GBV</code> | <code>ACT Commodities Group BV</code> | <code>1.0</code> |
|
|
| <code>Act Commodity GBV</code> | <code>ACT Fuels B.V.</code> | <code>0.76</code> |
|
|
| <code>Act fuel ball venture</code> | <code>ACT Fuels B.V.</code> | <code>1.0</code> |
|
|
* Loss: [<code>CosineSimilarityLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cosinesimilarityloss) with these parameters:
|
|
```json
|
|
{
|
|
"loss_fct": "torch.nn.modules.loss.MSELoss"
|
|
}
|
|
```
|
|
|
|
### Training Hyperparameters
|
|
#### Non-Default Hyperparameters
|
|
|
|
- `per_device_train_batch_size`: 16
|
|
- `learning_rate`: 2e-05
|
|
- `num_train_epochs`: 30
|
|
- `warmup_ratio`: 0.1
|
|
|
|
#### All Hyperparameters
|
|
<details><summary>Click to expand</summary>
|
|
|
|
- `overwrite_output_dir`: False
|
|
- `do_predict`: False
|
|
- `eval_strategy`: no
|
|
- `prediction_loss_only`: True
|
|
- `per_device_train_batch_size`: 16
|
|
- `per_device_eval_batch_size`: 8
|
|
- `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`: 30
|
|
- `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`: False
|
|
- `hub_always_push`: False
|
|
- `gradient_checkpointing`: False
|
|
- `gradient_checkpointing_kwargs`: None
|
|
- `include_inputs_for_metrics`: False
|
|
- `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
|
|
- `eval_use_gather_object`: False
|
|
- `batch_sampler`: batch_sampler
|
|
- `multi_dataset_batch_sampler`: proportional
|
|
|
|
</details>
|
|
|
|
### Training Logs
|
|
| Epoch | Step | sts-test_spearman_cosine |
|
|
|:-----:|:----:|:------------------------:|
|
|
| 30.0 | 120 | 0.9250 |
|
|
|
|
|
|
### Framework Versions
|
|
- Python: 3.11.9
|
|
- Sentence Transformers: 3.0.1
|
|
- Transformers: 4.44.2
|
|
- PyTorch: 2.4.0+cpu
|
|
- Accelerate: 0.33.0
|
|
- Datasets: 2.21.0
|
|
- Tokenizers: 0.19.1
|
|
|
|
## Citation
|
|
|
|
### BibTeX
|
|
|
|
#### Sentence Transformers
|
|
```bibtex
|
|
@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",
|
|
}
|
|
```
|
|
|
|
<!--
|
|
## 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.*
|
|
--> |
