README.md

metadata

tags:
  - sentence-transformers
  - sentence-similarity
  - feature-extraction
  - dense
  - generated_from_trainer
  - dataset_size:68
  - loss:MultipleNegativesRankingLoss
base_model: sentence-transformers/all-mpnet-base-v2
widget:
  - source_sentence: >-
      The Atlantic spotted dolphin is a dolphin found in warm temperate and
      tropical waters of the Atlantic Ocean. Older members of the species have a
      very distinctive spotted coloration all over their bodies.
    sentences:
      - baikal_seal
      - southern_right_whale
      - atlantic_spotted_dolphin
  - source_sentence: >-
      The burmeisters porpoise is a marine mammal belonging to the cetaceans
      group. It inhabits ocean and coastal habitats worldwide and plays an
      important role in marine ecosystems.
    sentences:
      - false_killer_whale
      - burmeisters_porpoise
      - south_asian_river_dolphin
  - source_sentence: >-
      Dall's porpoise is a species of porpoise endemic to the North Pacific. It
      is the largest of porpoises and the only member of the genus Phocoenoides.
      The species is named after American naturalist W. H. Dall.
    sentences:
      - dalls_porpoise
      - burrunan_dolphin
      - bolivian_river_dolphin
  - source_sentence: >-
      The hourglass dolphin is a small dolphin in the family Delphinidae that
      inhabits offshore Antarctic and sub-Antarctic waters. It is commonly seen
      from ships crossing the Drake Passage but has a circumpolar distribution.
    sentences:
      - common_dolphin
      - hourglass_dolphin
      - harbour_porpoise
  - source_sentence: >-
      The harp seal, also known as the saddleback seal or Greenland seal, is a
      species of earless seal, or true seal, native to the northernmost Atlantic
      Ocean and Arctic Ocean. Originally in the genus Phoca with a number of
      other species, it was reclassified into the monotypic genus Pagophilus in
      1844. In Greek, its scientific name translates to "Greenlandic ice-lover",
      and its taxonomic synonym, Phoca groenlandica translates to "Greenlandic
      seal". This is the only species in the genus Pagophilus.
    sentences:
      - harp_seal
      - amazon_river_dolphin
      - ringed_seal
pipeline_tag: sentence-similarity
library_name: sentence-transformers

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

This is a sentence-transformers model finetuned from sentence-transformers/all-mpnet-base-v2. 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 dimensions
• Similarity Function: Cosine Similarity

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, 'architecture': '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("sentence_transformers_model_id")
# Run inference
sentences = [
    'The harp seal, also known as the saddleback seal or Greenland seal, is a species of earless seal, or true seal, native to the northernmost Atlantic Ocean and Arctic Ocean. Originally in the genus Phoca with a number of other species, it was reclassified into the monotypic genus Pagophilus in 1844. In Greek, its scientific name translates to "Greenlandic ice-lover", and its taxonomic synonym, Phoca groenlandica translates to "Greenlandic seal". This is the only species in the genus Pagophilus.',
    'harp_seal',
    'ringed_seal',
]
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.7737, 0.2011],
#         [0.7737, 1.0000, 0.4141],
#         [0.2011, 0.4141, 1.0000]])

Training Details

Training Dataset

Unnamed Dataset

• Size: 68 training samples
• Columns: sentence_0 and sentence_1
• Approximate statistics based on the first 68 samples:

  	sentence_0	sentence_1
  type	string	string
  details	min: 11 tokens mean: 101.24 tokens max: 226 tokens	min: 4 tokens mean: 6.79 tokens max: 12 tokens

• Samples:

  sentence_0	sentence_1
  Dall's porpoise is a species of porpoise endemic to the North Pacific. It is the largest of porpoises and the only member of the genus Phocoenoides. The species is named after American naturalist W. H. Dall.	dalls_porpoise
  The Caspian seal is one of the smallest members of the earless seal family and unique in that it is found exclusively in the brackish Caspian Sea. It lives along the shorelines, but also on the many rocky islands and floating blocks of ice that dot the Caspian Sea. In winter and cooler parts of the spring and autumn season, it populates the northern Caspian coastline. As the ice melts in the summer and warmer parts of the spring and autumn season, it also occurs in the deltas of the Volga and Ural Rivers, as well as the southern latitudes of the Caspian where the water is cooler due to greater depth.	caspian_seal
  The Weddell seal is a relatively large and abundant true seal with a circumpolar distribution surrounding Antarctica. The Weddell seal was discovered and named in the 1820s during expeditions led by British sealing captain James Weddell to the area of the Southern Ocean now known as the Weddell Sea. The life history of this species is well documented since it occupies fast ice environments close to the Antarctic continent and often adjacent to Antarctic bases. It is the only species in the genus Leptonychotes.	weddell_seal

• Loss: MultipleNegativesRankingLoss with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "gather_across_devices": false
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• num_train_epochs: 5
• multi_dataset_batch_sampler: round_robin

All Hyperparameters

Click to expand

• overwrite_output_dir: False
• do_predict: False
• eval_strategy: no
• prediction_loss_only: True
• per_device_train_batch_size: 8
• 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: 5e-05
• weight_decay: 0.0
• adam_beta1: 0.9
• adam_beta2: 0.999
• adam_epsilon: 1e-08
• max_grad_norm: 1
• num_train_epochs: 5
• max_steps: -1
• lr_scheduler_type: linear
• lr_scheduler_kwargs: {}
• warmup_ratio: 0.0
• 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}
• parallelism_config: 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: None
• hub_always_push: False
• hub_revision: None
• gradient_checkpointing: False
• gradient_checkpointing_kwargs: None
• include_inputs_for_metrics: False
• include_for_metrics: []
• 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
• 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
• use_liger_kernel: False
• liger_kernel_config: None
• eval_use_gather_object: False
• average_tokens_across_devices: False
• prompts: None
• batch_sampler: batch_sampler
• multi_dataset_batch_sampler: round_robin
• router_mapping: {}
• learning_rate_mapping: {}

Framework Versions

• Python: 3.10.11
• Sentence Transformers: 5.2.3
• Transformers: 4.56.1
• PyTorch: 2.5.1+cu121
• Accelerate: 1.10.1
• Datasets: 4.0.0
• Tokenizers: 0.22.0

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

MultipleNegativesRankingLoss

@misc{henderson2017efficient,
    title={Efficient Natural Language Response Suggestion for Smart Reply},
    author={Matthew Henderson and Rami Al-Rfou and Brian Strope and Yun-hsuan Sung and Laszlo Lukacs and Ruiqi Guo and Sanjiv Kumar and Balint Miklos and Ray Kurzweil},
    year={2017},
    eprint={1705.00652},
    archivePrefix={arXiv},
    primaryClass={cs.CL}
}