CoolFace
Modelpublic

ve88ifz2/privacy_embedding_rag_10k_base_checkpoint_2-klej-dyk-v0.1

sourceHugging Faceapache-2.0updated 2y agoView on Hugging Face
0likes26downloads
Model Card

privacyembeddingrag10kbasecheckpoint2-klej-dyk-v0.1

This is a sentence-transformers model finetuned from liddlefish/privacy_embedding_rag_10k_base_checkpoint_2. 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: liddlefish/privacy_embedding_rag_10k_base_checkpoint_2 <!-- at revision 2ef6f7a59388ab4473ddb885ecc27a40c09f5802 -->
  • —Maximum Sequence Length: 512 tokens
  • —Output Dimensionality: 768 tokens
  • —Similarity Function: Cosine Similarity <!-- - Training Dataset: Unknown -->
  • —Language: en
  • —License: apache-2.0

Model Sources

Full Model Architecture

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': True}) with Transformer model: BertModel 
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, '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("sentence_transformers_model_id")
# Run inference
sentences = [
    'Sen o zastrzyku Irmy',
    'gdzie Freud spotkał Irmę we śnie o zastrzyku Irmy?',
    'dlaczego Ōkunoshima została wymazana z map Japonii?',
]
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

Information Retrieval
MetricValue
cosine_accuracy@10.1875
cosine_accuracy@30.4543
cosine_accuracy@50.6226
cosine_accuracy@100.7308
cosine_precision@10.1875
cosine_precision@30.1514
cosine_precision@50.1245
cosine_precision@100.0731
cosine_recall@10.1875
cosine_recall@30.4543
cosine_recall@50.6226
cosine_recall@100.7308
cosine_ndcg@100.4453
cosine_mrr@100.355
cosine_map@1000.3624
Information Retrieval
MetricValue
cosine_accuracy@10.1827
cosine_accuracy@30.4447
cosine_accuracy@50.6034
cosine_accuracy@100.7115
cosine_precision@10.1827
cosine_precision@30.1482
cosine_precision@50.1207
cosine_precision@100.0712
cosine_recall@10.1827
cosine_recall@30.4447
cosine_recall@50.6034
cosine_recall@100.7115
cosine_ndcg@100.4349
cosine_mrr@100.3472
cosine_map@1000.3548
Information Retrieval
MetricValue
cosine_accuracy@10.1875
cosine_accuracy@30.4231
cosine_accuracy@50.5577
cosine_accuracy@100.6683
cosine_precision@10.1875
cosine_precision@30.141
cosine_precision@50.1115
cosine_precision@100.0668
cosine_recall@10.1875
cosine_recall@30.4231
cosine_recall@50.5577
cosine_recall@100.6683
cosine_ndcg@100.414
cosine_mrr@100.3337
cosine_map@1000.3427
Information Retrieval
MetricValue
cosine_accuracy@10.1707
cosine_accuracy@30.3678
cosine_accuracy@50.512
cosine_accuracy@100.601
cosine_precision@10.1707
cosine_precision@30.1226
cosine_precision@50.1024
cosine_precision@100.0601
cosine_recall@10.1707
cosine_recall@30.3678
cosine_recall@50.512
cosine_recall@100.601
cosine_ndcg@100.3712
cosine_mrr@100.2988
cosine_map@1000.3067
Information Retrieval
MetricValue
cosine_accuracy@10.1587
cosine_accuracy@30.3101
cosine_accuracy@50.387
cosine_accuracy@100.4928
cosine_precision@10.1587
cosine_precision@30.1034
cosine_precision@50.0774
cosine_precision@100.0493
cosine_recall@10.1587
cosine_recall@30.3101
cosine_recall@50.387
cosine_recall@100.4928
cosine_ndcg@100.3131
cosine_mrr@100.2569
cosine_map@1000.2651

<!--

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: 3,738 training samples
  • —Columns: <code>positive</code> and <code>anchor</code>
  • —Approximate statistics based on the first 1000 samples: | | positive | anchor | |:--------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------| | type | string | string | | details | <ul><li>min: 7 tokens</li><li>mean: 89.43 tokens</li><li>max: 507 tokens</li></ul> | <ul><li>min: 9 tokens</li><li>mean: 30.98 tokens</li><li>max: 76 tokens</li></ul> |
  • —Samples: | positive | anchor | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------| | <code>Zespół Blaua (zespół Jabsa, ang. Blau syndrome, BS) – rzadka choroba genetyczna o dziedziczeniu autosomalnym dominującym, charakteryzująca się ziarniniakowym zapaleniem stawów o wczesnym początku, zapaleniem jagodówki (uveitis) i wysypką skórną, a także kamptodaktylią.</code> | <code>jakie choroby genetyczne dziedziczą się autosomalnie dominująco?</code> | | <code>Gorgippia Gorgippia – starożytne miasto bosporańskie nad Morzem Czarnym, którego pozostałości znajdują się obecnie pod współczesną zabudową centralnej części miasta Anapa w Kraju Krasnodarskim w Rosji.</code> | <code>gdzie obecnie znajduje się starożytne miasto Gorgippia?</code> | | <code>Ulubionym dystansem Rücker było 400 metrów i to na nim notowała największe indywidualne sukcesy : srebrny medal Mistrzostw Europy juniorów w lekkoatletyce (Saloniki 1991) 6. miejsce w Pucharze Świata w Lekkoatletyce (Hawana 1992) 5. miejsce na Mistrzostwach Europy w Lekkoatletyce (Helsinki 1994) srebro podczas Mistrzostw Świata w Lekkoatletyce (Sewilla 1999) złota medalistka mistrzostw Niemiec Duże sukcesy odnosiła także w sztafecie 4 x 400 metrów : złoto Mistrzostw Europy juniorów w lekkoatletyce (Varaždin 1989) złoty medal Mistrzostw Europy juniorów w lekkoatletyce (Saloniki 1991) brąz na Mistrzostwach Europy w Lekkoatletyce (Helsinki 1994) brązowy medal podczas Igrzysk Olimpijskich (Atlanta 1996) brąz na Halowych Mistrzostwach Świata w Lekkoatletyce (Paryż 1997) złoto Mistrzostw Świata w Lekkoatletyce (Ateny 1997) brązowy medal Mistrzostw Świata w Lekkoatletyce (Sewilla 1999)</code> | <code>kto zaprojektował medale, które będą wręczane podczas tegorocznych mistrzostw Europy juniorów w lekkoatletyce?</code> |
  • —Loss: <code>MatryoshkaLoss</code> with these parameters:
json
  {
      "loss": "MultipleNegativesRankingLoss",
      "matryoshka_dims": [
          768,
          512,
          256,
          128,
          64
      ],
      "matryoshka_weights": [
          1,
          1,
          1,
          1,
          1
      ],
      "n_dims_per_step": -1
  }

Training Hyperparameters

Non-Default Hyperparameters
  • —eval_strategy: epoch
  • —per_device_train_batch_size: 16
  • —per_device_eval_batch_size: 16
  • —gradient_accumulation_steps: 16
  • —learning_rate: 2e-05
  • —num_train_epochs: 5
  • —lr_scheduler_type: cosine
  • —warmup_ratio: 0.1
  • —bf16: True
  • —tf32: True
  • —load_best_model_at_end: True
  • —optim: adamwtorchfused
  • —batch_sampler: no_duplicates
All Hyperparameters

<details><summary>Click to expand</summary>

  • —overwrite_output_dir: False
  • —do_predict: False
  • —eval_strategy: epoch
  • —prediction_loss_only: True
  • —per_device_train_batch_size: 16
  • —per_device_eval_batch_size: 16
  • —per_gpu_train_batch_size: None
  • —per_gpu_eval_batch_size: None
  • —gradient_accumulation_steps: 16
  • —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: 5
  • —max_steps: -1
  • —lr_scheduler_type: cosine
  • —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: True
  • —fp16: False
  • —fp16_opt_level: O1
  • —half_precision_backend: auto
  • —bf16_full_eval: False
  • —fp16_full_eval: False
  • —tf32: True
  • —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: True
  • —ignore_data_skip: False
  • —fsdp: []
  • —fsdp_min_num_params: 0
  • —fsdp_config: {'minnumparams': 0, 'xla': False, 'xlafsdpv2': False, 'xlafsdpgrad_ckpt': False}
  • —fsdp_transformer_layer_cls_to_wrap: None
  • —accelerator_config: {'splitbatches': False, 'dispatchbatches': None, 'evenbatches': True, 'useseedablesampler': True, 'nonblocking': False, 'gradientaccumulationkwargs': None}
  • —deepspeed: None
  • —label_smoothing_factor: 0.0
  • —optim: adamwtorchfused
  • —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
  • —batch_sampler: no_duplicates
  • —multi_dataset_batch_sampler: proportional

</details>

Training Logs

EpochStepTraining Lossdim_128_cosine_map@100dim_256_cosine_map@100dim_512_cosine_map@100dim_64_cosine_map@100dim_768_cosine_map@100
0.068419.112-----
0.136829.5133-----
0.205139.0946-----
0.273548.9744-----
0.341957.9039-----
0.410368.1973-----
0.478676.8979-----
0.547087.0324-----
0.615496.6472-----
0.6838106.3009-----
0.7521116.8778-----
0.8205125.9809-----
0.8889135.3054-----
0.9573145.7060.28680.32800.35220.24150.3477
1.0256155.0592-----
1.0940164.7655-----
1.1624174.9682-----
1.2308185.1226-----
1.2991194.8655-----
1.3675204.2008-----
1.4359215.0281-----
1.5043224.3074-----
1.5726234.3163-----
1.6410243.9344-----
1.7094254.6567-----
1.7778264.5145-----
1.8462274.1319-----
1.9145283.8768-----
1.9829293.55250.29860.33300.34830.25900.3534
2.0513303.8693-----
2.1197313.4675-----
2.1880324.0598-----
2.2564334.2429-----
2.3248343.3686-----
2.3932353.2663-----
2.4615363.8585-----
2.5299373.1157-----
2.5983383.5254-----
2.6667393.2782-----
2.7350404.3151-----
2.8034413.4567-----
2.8718423.3976-----
2.9402433.39450.30140.33430.35220.26260.3593
3.0085443.4487-----
3.0769453.0021-----
3.1453463.2332-----
3.2137473.3012-----
3.2821483.2735-----
3.3504492.5335-----
3.4188503.7025-----
3.4872512.8596-----
3.5556523.1108-----
3.6239533.2807-----
3.6923543.1604-----
3.7607553.7179-----
3.8291563.3418-----
3.8974572.9735-----
3.9658583.27550.30660.34090.35460.26530.3626
4.0342593.1444-----
4.1026603.0212-----
4.1709613.1298-----
4.2393623.3195-----
4.3077632.996-----
4.3761642.4636-----
4.4444653.2388-----
4.5128662.747-----
4.5812672.8715-----
4.6496683.1402-----
4.7179693.547-----
4.7863703.60940.30670.34270.35480.26510.3624
  • —The bold row denotes the saved checkpoint.

Framework Versions

  • —Python: 3.12.2
  • —Sentence Transformers: 3.0.0
  • —Transformers: 4.41.2
  • —PyTorch: 2.3.1
  • —Accelerate: 0.27.2
  • —Datasets: 2.19.1
  • —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",
}
MatryoshkaLoss
bibtex
@misc{kusupati2024matryoshka,
    title={Matryoshka Representation Learning}, 
    author={Aditya Kusupati and Gantavya Bhatt and Aniket Rege and Matthew Wallingford and Aditya Sinha and Vivek Ramanujan and William Howard-Snyder and Kaifeng Chen and Sham Kakade and Prateek Jain and Ali Farhadi},
    year={2024},
    eprint={2205.13147},
    archivePrefix={arXiv},
    primaryClass={cs.LG}
}
MultipleNegativesRankingLoss
bibtex
@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}
}

<!--

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. -->