| | --- |
| | base_model: sentence-transformers/all-mpnet-base-v2 |
| | datasets: [] |
| | language: [] |
| | library_name: sentence-transformers |
| | pipeline_tag: sentence-similarity |
| | tags: |
| | - sentence-transformers |
| | - sentence-similarity |
| | - feature-extraction |
| | - generated_from_trainer |
| | - dataset_size:100000 |
| | - loss:CosineSimilarityLoss |
| | widget: |
| | - source_sentence: Believe that unfortunate events occur because of bad luck. |
| | sentences: |
| | - Had someone over for dinner. |
| | - Avoid difficult reading material. |
| | - Bought or picked flowers. |
| | - source_sentence: Enjoy thinking about things. |
| | sentences: |
| | - Had the experience of being in a familiar place but finding it strange and unfamiliar. |
| | - Express childlike joy. |
| | - Do just enough work to get by. |
| | - source_sentence: Sympathize with the homeless. |
| | sentences: |
| | - Want to be told I am right. |
| | - Act without thinking. |
| | - Had a poor appetite. |
| | - source_sentence: Avoid philosophical discussions. |
| | sentences: |
| | - Start conversations. |
| | - Radiate joy. |
| | - Am on good terms with nearly everyone. |
| | - source_sentence: Let others make the decisions. |
| | sentences: |
| | - Begin to panic when there is danger. |
| | - Believe there are many sides to most issues. |
| | - Must try to maintain harmony within my group. |
| | --- |
| | |
| | # 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). 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:** Unknown --> |
| | <!-- - **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("milnico/Personality_Cross_Encoder") |
| | # Run inference |
| | sentences = [ |
| | 'Let others make the decisions.', |
| | 'Begin to panic when there is danger.', |
| | 'Must try to maintain harmony within my group.', |
| | ] |
| | 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.* |
| | --> |
| |
|
| | <!-- |
| | ## 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 |
| |
|
| | #### Unnamed Dataset |
| |
|
| |
|
| | * Size: 100,000 training samples |
| | * Columns: <code>sentence1</code>, <code>sentence2</code>, and <code>score</code> |
| | * Approximate statistics based on the first 1000 samples: |
| | | | sentence1 | sentence2 | score | |
| | |:--------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------| |
| | | type | string | string | float | |
| | | details | <ul><li>min: 5 tokens</li><li>mean: 8.39 tokens</li><li>max: 25 tokens</li></ul> | <ul><li>min: 4 tokens</li><li>mean: 8.77 tokens</li><li>max: 30 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.11</li><li>max: 1.0</li></ul> | |
| | * Samples: |
| | | sentence1 | sentence2 | score | |
| | |:------------------------------------------------------------------|:-------------------------------------------------|:--------------------------| |
| | | <code>Don't worry about things that have already happened.</code> | <code>Dislike being complimented.</code> | <code>0.0046042455</code> | |
| | | <code>Follow directions.</code> | <code>Need things explained only once.</code> | <code>0.1702887</code> | |
| | | <code>Watched a television reality show.</code> | <code>Do more than what's expected of me.</code> | <code>0.12572353</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" |
| | } |
| | ``` |
| |
|
| | ### Evaluation Dataset |
| |
|
| | #### Unnamed Dataset |
| |
|
| |
|
| | * Size: 10,000 evaluation samples |
| | * Columns: <code>sentence1</code>, <code>sentence2</code>, and <code>score</code> |
| | * Approximate statistics based on the first 1000 samples: |
| | | | sentence1 | sentence2 | score | |
| | |:--------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------| |
| | | type | string | string | float | |
| | | details | <ul><li>min: 4 tokens</li><li>mean: 8.43 tokens</li><li>max: 31 tokens</li></ul> | <ul><li>min: 4 tokens</li><li>mean: 8.72 tokens</li><li>max: 31 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.11</li><li>max: 1.0</li></ul> | |
| | * Samples: |
| | | sentence1 | sentence2 | score | |
| | |:-----------------------------------------|:-------------------------------------------------|:------------------------| |
| | | <code>Feel short-changed in life.</code> | <code>Never spend more than I can afford.</code> | <code>0.13934776</code> | |
| | | <code>Enjoy the beauty of nature.</code> | <code>Do things that others find strange.</code> | <code>0.065138</code> | |
| | | <code>Seldom get mad.</code> | <code>Make a decision and move on.</code> | <code>0.08558667</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 |
| |
|
| | - `eval_strategy`: steps |
| | - `per_device_train_batch_size`: 64 |
| | - `per_device_eval_batch_size`: 64 |
| | - `learning_rate`: 2e-05 |
| | - `num_train_epochs`: 10 |
| | - `warmup_ratio`: 0.1 |
| | - `fp16`: True |
| | - `batch_sampler`: no_duplicates |
| | |
| | #### All Hyperparameters |
| | <details><summary>Click to expand</summary> |
| | |
| | - `overwrite_output_dir`: False |
| | - `do_predict`: False |
| | - `eval_strategy`: steps |
| | - `prediction_loss_only`: True |
| | - `per_device_train_batch_size`: 64 |
| | - `per_device_eval_batch_size`: 64 |
| | - `per_gpu_train_batch_size`: None |
| | - `per_gpu_eval_batch_size`: None |
| | - `gradient_accumulation_steps`: 1 |
| | - `eval_accumulation_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`: 10 |
| | - `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`: True |
| | - `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 |
| | - `batch_sampler`: no_duplicates |
| | - `multi_dataset_batch_sampler`: proportional |
| |
|
| | </details> |
| |
|
| | ### Training Logs |
| | | Epoch | Step | Training Loss | loss | |
| | |:------:|:-----:|:-------------:|:------:| |
| | | 0.6398 | 1000 | 0.0074 | 0.0050 | |
| | | 1.2783 | 2000 | 0.0046 | 0.0042 | |
| | | 1.9181 | 3000 | 0.0036 | 0.0038 | |
| | | 2.5566 | 4000 | 0.0031 | 0.0036 | |
| | | 3.1951 | 5000 | 0.0026 | 0.0035 | |
| | | 3.8349 | 6000 | 0.0022 | 0.0035 | |
| | | 4.4734 | 7000 | 0.0022 | 0.0034 | |
| | | 5.1120 | 8000 | 0.0019 | 0.0034 | |
| | | 5.7518 | 9000 | 0.0017 | 0.0033 | |
| | | 6.3903 | 10000 | 0.0016 | 0.0033 | |
| | | 7.0288 | 11000 | 0.0015 | 0.0033 | |
| | | 7.6686 | 12000 | 0.0014 | 0.0032 | |
| | | 8.3071 | 13000 | 0.0013 | 0.0032 | |
| | | 8.9469 | 14000 | 0.0012 | 0.0031 | |
| | | 9.5854 | 15000 | 0.0012 | 0.0031 | |
| |
|
| |
|
| | ### Framework Versions |
| | - Python: 3.9.19 |
| | - Sentence Transformers: 3.0.1 |
| | - Transformers: 4.42.4 |
| | - PyTorch: 2.3.0+cu121 |
| | - Accelerate: 0.32.1 |
| | - Datasets: 2.20.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.* |
| | --> |