tomaarsen / all-mpnet-base-v2-sts

SentenceTransformer based on sentence-transformers/all-mpnet-base-v2

This is a sentence-transformers model finetuned from sentence-transformers/all-mpnet-base-v2 on the sentence-transformers/stsb 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
• Maximum Sequence Length: 384 tokens
• Output Dimensionality: 768 tokens
• Similarity Function: Cosine Similarity
• Training Dataset:
  • sentence-transformers/stsb
• Language: en

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': 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:

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("tomaarsen/all-mpnet-base-v2-sts")
# Run inference
sentences = [
    'The gate is yellow.',
    'The gate is blue.',
    'US spends $50m on carp invasion',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings)
print(similarities.shape)
# [3, 3]

Evaluation

Metrics

Semantic Similarity

• Dataset: sts-dev
• Evaluated with EmbeddingSimilarityEvaluator

Semantic Similarity

• Dataset: sts-test
• Evaluated with EmbeddingSimilarityEvaluator

Training Details

Training Dataset

sentence-transformers/stsb

• Dataset: sentence-transformers/stsb at ab7a5ac
• Size: 5,749 training samples
• Columns: sentence1 , sentence2 , and score
• Approximate statistics based on the first 1000 samples:

  	sentence1	sentence2	score
  type	string	string	float
  details	min: 6 tokens mean: 10.0 tokens max: 28 tokens	min: 5 tokens mean: 9.95 tokens max: 25 tokens	min: 0.0 mean: 0.54 max: 1.0

• Samples:

  sentence1	sentence2	score
  A plane is taking off.	An air plane is taking off.	1.0
  A man is playing a large flute.	A man is playing a flute.	0.76
  A man is spreading shreded cheese on a pizza.	A man is spreading shredded cheese on an uncooked pizza.	0.76

• Loss: CosineSimilarityLoss with these parameters:

  {
      "loss_fct": "torch.nn.modules.loss.MSELoss"
  }
  

Evaluation Dataset

sentence-transformers/stsb

• Dataset: sentence-transformers/stsb at ab7a5ac
• Size: 1,500 evaluation samples
• Columns: sentence1 , sentence2 , and score
• Approximate statistics based on the first 1000 samples:

  	sentence1	sentence2	score
  type	string	string	float
  details	min: 5 tokens mean: 15.1 tokens max: 45 tokens	min: 6 tokens mean: 15.11 tokens max: 53 tokens	min: 0.0 mean: 0.47 max: 1.0

• Samples:

  sentence1	sentence2	score
  A man with a hard hat is dancing.	A man wearing a hard hat is dancing.	1.0
  A young child is riding a horse.	A child is riding a horse.	0.95
  A man is feeding a mouse to a snake.	The man is feeding a mouse to the snake.	1.0

• Loss: CosineSimilarityLoss with these parameters:

  {
      "loss_fct": "torch.nn.modules.loss.MSELoss"
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy : steps
• per_device_train_batch_size : 16
• per_device_eval_batch_size : 16
• num_train_epochs : 4
• warmup_ratio : 0.1
• fp16 : True

All Hyperparameters

Training Logs

Environmental Impact

Carbon emissions were measured using CodeCarbon .

• Energy Consumed : 0.025 kWh
• Carbon Emitted : 0.010 kg of CO2
• Hours Used : 0.122 hours

Training Hardware

• On Cloud : No
• GPU Model : 1 x NVIDIA GeForce RTX 3090
• CPU Model : 13th Gen Intel(R) Core(TM) i7-13700K
• RAM Size : 31.78 GB

Framework Versions

• Python: 3.11.6
• Sentence Transformers: 3.0.0.dev0
• Transformers: 4.41.0.dev0
• PyTorch: 2.3.0+cu121
• Accelerate: 0.26.1
• Datasets: 2.18.0
• Tokenizers: 0.19.1

Citation

BibTeX

Sentence Transformers

@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",
}