| | --- |
| | tags: |
| | - sentence-transformers |
| | - sentence-similarity |
| | - feature-extraction |
| | - generated_from_trainer |
| | - dataset_size:464 |
| | - loss:MultipleNegativesRankingLoss |
| | base_model: sentence-transformers/all-MiniLM-L12-v2 |
| | widget: |
| | - source_sentence: analista financeiro pl |
| | sentences: |
| | - jovem aprendiz |
| | - júnior |
| | - pleno |
| | - source_sentence: analista de comunicacao junior |
| | sentences: |
| | - júnior |
| | - júnior |
| | - gerente |
| | - source_sentence: l3 |
| | sentences: |
| | - júnior |
| | - sênior |
| | - gerente sênior |
| | - source_sentence: especialista i |
| | sentences: |
| | - sênior |
| | - especialista |
| | - especialista ii |
| | - source_sentence: coordenador(a) sist. automação conteúdo i |
| | sentences: |
| | - júnior |
| | - assistente |
| | - coordenador |
| | pipeline_tag: sentence-similarity |
| | library_name: sentence-transformers |
| | metrics: |
| | - cosine_accuracy@1 |
| | - cosine_accuracy@3 |
| | - cosine_accuracy@5 |
| | - cosine_accuracy@10 |
| | - cosine_precision@1 |
| | - cosine_precision@3 |
| | - cosine_precision@5 |
| | - cosine_precision@10 |
| | - cosine_recall@1 |
| | - cosine_recall@3 |
| | - cosine_recall@5 |
| | - cosine_recall@10 |
| | - cosine_ndcg@10 |
| | - cosine_mrr@10 |
| | - cosine_map@100 |
| | model-index: |
| | - name: SentenceTransformer based on sentence-transformers/all-MiniLM-L12-v2 |
| | results: |
| | - task: |
| | type: information-retrieval |
| | name: Information Retrieval |
| | dataset: |
| | name: Unknown |
| | type: unknown |
| | metrics: |
| | - type: cosine_accuracy@1 |
| | value: 0.9137931034482759 |
| | name: Cosine Accuracy@1 |
| | - type: cosine_accuracy@3 |
| | value: 0.9741379310344828 |
| | name: Cosine Accuracy@3 |
| | - type: cosine_accuracy@5 |
| | value: 0.9913793103448276 |
| | name: Cosine Accuracy@5 |
| | - type: cosine_accuracy@10 |
| | value: 1.0 |
| | name: Cosine Accuracy@10 |
| | - type: cosine_precision@1 |
| | value: 0.9137931034482759 |
| | name: Cosine Precision@1 |
| | - type: cosine_precision@3 |
| | value: 0.32471264367816094 |
| | name: Cosine Precision@3 |
| | - type: cosine_precision@5 |
| | value: 0.19827586206896552 |
| | name: Cosine Precision@5 |
| | - type: cosine_precision@10 |
| | value: 0.09999999999999999 |
| | name: Cosine Precision@10 |
| | - type: cosine_recall@1 |
| | value: 0.9137931034482759 |
| | name: Cosine Recall@1 |
| | - type: cosine_recall@3 |
| | value: 0.9741379310344828 |
| | name: Cosine Recall@3 |
| | - type: cosine_recall@5 |
| | value: 0.9913793103448276 |
| | name: Cosine Recall@5 |
| | - type: cosine_recall@10 |
| | value: 1.0 |
| | name: Cosine Recall@10 |
| | - type: cosine_ndcg@10 |
| | value: 0.9608827285720798 |
| | name: Cosine Ndcg@10 |
| | - type: cosine_mrr@10 |
| | value: 0.9479166666666667 |
| | name: Cosine Mrr@10 |
| | - type: cosine_map@100 |
| | value: 0.9479166666666666 |
| | name: Cosine Map@100 |
| | --- |
| | |
| | # SentenceTransformer based on sentence-transformers/all-MiniLM-L12-v2 |
| |
|
| | This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/all-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L12-v2). It maps sentences & paragraphs to a 384-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-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L12-v2) <!-- at revision c004d8e3e901237d8fa7e9fff12774962e391ce5 --> |
| | - **Maximum Sequence Length:** 128 tokens |
| | - **Output Dimensionality:** 384 dimensions |
| | - **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': 128, 'do_lower_case': False}) with Transformer model: BertModel |
| | (1): Pooling({'word_embedding_dimension': 384, '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("sentence_transformers_model_id") |
| | # Run inference |
| | sentences = [ |
| | 'coordenador(a) sist. automação conteúdo i', |
| | 'coordenador', |
| | 'júnior', |
| | ] |
| | embeddings = model.encode(sentences) |
| | print(embeddings.shape) |
| | # [3, 384] |
| | |
| | # 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 |
| |
|
| | * Evaluated with [<code>InformationRetrievalEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.InformationRetrievalEvaluator) |
| |
|
| | | Metric | Value | |
| | |:--------------------|:-----------| |
| | | cosine_accuracy@1 | 0.9138 | |
| | | cosine_accuracy@3 | 0.9741 | |
| | | cosine_accuracy@5 | 0.9914 | |
| | | cosine_accuracy@10 | 1.0 | |
| | | cosine_precision@1 | 0.9138 | |
| | | cosine_precision@3 | 0.3247 | |
| | | cosine_precision@5 | 0.1983 | |
| | | cosine_precision@10 | 0.1 | |
| | | cosine_recall@1 | 0.9138 | |
| | | cosine_recall@3 | 0.9741 | |
| | | cosine_recall@5 | 0.9914 | |
| | | cosine_recall@10 | 1.0 | |
| | | **cosine_ndcg@10** | **0.9609** | |
| | | cosine_mrr@10 | 0.9479 | |
| | | cosine_map@100 | 0.9479 | |
| | |
| | <!-- |
| | ## 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: 464 training samples |
| | * Columns: <code>input</code> and <code>output</code> |
| | * Approximate statistics based on the first 464 samples: |
| | | | input | output | |
| | |:--------|:----------------------------------------------------------------------------------|:-------------------------------------------------------------------------------| |
| | | type | string | string | |
| | | details | <ul><li>min: 3 tokens</li><li>mean: 8.32 tokens</li><li>max: 128 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 4.3 tokens</li><li>max: 8 tokens</li></ul> | |
| | * Samples: |
| | | input | output | |
| | |:----------------------------------|:------------------------| |
| | | <code>(l2) pleno</code> | <code>pleno</code> | |
| | | <code>analista contabil sr</code> | <code>sênior</code> | |
| | | <code>estagiario</code> | <code>estagiário</code> | |
| | * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters: |
| | ```json |
| | { |
| | "scale": 20.0, |
| | "similarity_fct": "cos_sim" |
| | } |
| | ``` |
| | |
| | ### Evaluation Dataset |
| | |
| | #### Unnamed Dataset |
| | |
| | |
| | * Size: 116 evaluation samples |
| | * Columns: <code>input</code> and <code>output</code> |
| | * Approximate statistics based on the first 116 samples: |
| | | | input | output | |
| | |:--------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------------------------| |
| | | type | string | string | |
| | | details | <ul><li>min: 3 tokens</li><li>mean: 6.67 tokens</li><li>max: 52 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 4.28 tokens</li><li>max: 8 tokens</li></ul> | |
| | * Samples: |
| | | input | output | |
| | |:-----------------------------------|:------------------------| |
| | | <code>pleno 2</code> | <code>pleno</code> | |
| | | <code>analista adm senior i</code> | <code>sênior</code> | |
| | | <code>assistente i</code> | <code>assistente</code> | |
| | * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters: |
| | ```json |
| | { |
| | "scale": 20.0, |
| | "similarity_fct": "cos_sim" |
| | } |
| | ``` |
| | |
| | ### Training Hyperparameters |
| | #### Non-Default Hyperparameters |
| | |
| | - `eval_strategy`: steps |
| | - `learning_rate`: 0.0001 |
| | - `num_train_epochs`: 4 |
| | - `warmup_ratio`: 0.1 |
| | - `load_best_model_at_end`: 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`: 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`: 0.0001 |
| | - `weight_decay`: 0.0 |
| | - `adam_beta1`: 0.9 |
| | - `adam_beta2`: 0.999 |
| | - `adam_epsilon`: 1e-08 |
| | - `max_grad_norm`: 1.0 |
| | - `num_train_epochs`: 4 |
| | - `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`: True |
| | - `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`: None |
| | - `hub_always_push`: False |
| | - `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 |
| | - `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 |
| | - `use_liger_kernel`: False |
| | - `eval_use_gather_object`: False |
| | - `average_tokens_across_devices`: False |
| | - `prompts`: None |
| | - `batch_sampler`: no_duplicates |
| | - `multi_dataset_batch_sampler`: proportional |
| | |
| | </details> |
| | |
| | ### Training Logs |
| | | Epoch | Step | Validation Loss | cosine_ndcg@10 | |
| | |:----------:|:-------:|:---------------:|:--------------:| |
| | | 0 | 0 | - | 0.6834 | |
| | | **3.4483** | **200** | **0.1355** | **0.9609** | |
| | | 4.0 | 232 | - | 0.9609 | |
| | |
| | * The bold row denotes the saved checkpoint. |
| | |
| | ### Framework Versions |
| | - Python: 3.11.0 |
| | - Sentence Transformers: 3.3.1 |
| | - Transformers: 4.49.0 |
| | - PyTorch: 2.2.2 |
| | - Accelerate: 1.1.1 |
| | - Datasets: 3.1.0 |
| | - Tokenizers: 0.21.0 |
| | |
| | ## 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", |
| | } |
| | ``` |
| | |
| | #### 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.* |
| | --> |
