sentence-transformers safetensors bert sentence-similarity feature-extraction generated_from_trainer dataset_size:200 loss:MultipleNegativesRankingLoss dataset:matunderstars/ufes-qa-data arxiv:1908.10084 arxiv:1705.00652 base_model:sentence-transformers/all-MiniLM-L12-v2 base_model:finetune:sentence-transformers/all-MiniLM-L12-v2 autotrain_compatible text-embeddings-inference endpoints_compatible region:us
---
base_model: sentence-transformers/all-MiniLM-L12-v2
datasets:
- matunderstars/ufes-qa-data
library_name: sentence-transformers
pipeline_tag: sentence-similarity
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:200
- loss:MultipleNegativesRankingLoss
widget:
- source_sentence: Como solicitar materiais registrados nas atas de registro de preços
    vigentes?
  sentences:
  - Siga os procedimentos em https://portaladministrativo.ufes.br/utilizacao-de-registro-de-precos-existente.
  - Para solicitar uma compra, é necessário preencher o formulário de solicitação
    e enviá-lo ao setor de compras.
  - Siga as instruções em https://senha.ufes.br/site/alteraSenha.
- source_sentence: Como registrar atestado de saúde?
  sentences:
  - 'Acesse nosso chat para falar com um atendente humano: https://chat.google.com/room/AAAAHqHLj6c?cls=7'
  - Computadores lentos podem necessitar de manutenção ou atualização de hardware.
    Abra um chamado em https://atendimento.ufes.br.
  - Realize o registro pelo aplicativo SouGov (Menu > Atestado de Saúde > Incluir
    > Selecionar arquivo no dispositivo) ou pelo Portal Sigepe em Gestão de Pessoas
    > Minha Saúde > Atestado Médico.
- source_sentence: Como obter suporte para equipamentos de informática pessoal?
  sentences:
  - Consulte tutoriais em https://dtin.saomateus.ufes.br ou entre em contato via suporte.saomateus@ufes.br.
  - Envie um e-mail para dasas.ceunes@ufes.br para agendar atendimento social na DASAS.
  - Para manutenção dos conectores de rede, encaminhe a solicitação ao setor de TI
    da UFES em https://atendimento.ufes.br, especificando o laboratório e os problemas
    encontrados.
- source_sentence: Como solicitar o tombamento de um bem extraorçamentário?
  sentences:
  - Envie a documentação via https://protocolo.ufes.br. Manual em https://drm.saomateus.ufes.br/manuais-0.
  - Envie um e-mail para pagamento.dae.proaeci@ufes.br solicitando a alteração dos
    dados bancários.
  - Envie um e-mail com detalhes e fotos relevantes.
- source_sentence: Como realizar o cadastro no Proaes?
  sentences:
  - 'Informações sobre pagamento de notas fiscais a fornecedor entrar em contato com
    a DCFN (Divisão de Contabilidade e Finanças)


    E-mail institucional do setor: dcfn.ceunes@ufes.br


    Telefones: 3312-1517 e 3312-1518


    Demais informações acesse o site: https://www.gestaoadministrativa.saomateus.ufes.br/apresentacao'
  - Acesse o site da Proaeci em https://proaeci.ufes.br/editais para verificar se
    há algum edital vigente para o semestre.
  - Envie um ofício via documento avulso para a DRMN, conforme manual disponível em
    https://drm.saomateus.ufes.br/manuais-0.
---

# 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) on the [train](https://huggingface.co/datasets/matunderstars/ufes-qa-data) and [test](https://huggingface.co/datasets/matunderstars/ufes-qa-data) datasets. 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 364dd28d28dcd3359b537f3cf1f5348ba679da62 -->
- **Maximum Sequence Length:** 128 tokens
- **Output Dimensionality:** 384 dimensions
- **Similarity Function:** Cosine Similarity
- **Training Datasets:**
    - [train](https://huggingface.co/datasets/matunderstars/ufes-qa-data)
    - [test](https://huggingface.co/datasets/matunderstars/ufes-qa-data)
<!-- - **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("matunderstars/ufes-qa-embedding-finetuned-v2")
# Run inference
sentences = [
    'Como realizar o cadastro no Proaes?',
    'Acesse o site da Proaeci em https://proaeci.ufes.br/editais para verificar se há algum edital vigente para o semestre.',
    'Envie um ofício via documento avulso para a DRMN, conforme manual disponível em https://drm.saomateus.ufes.br/manuais-0.',
]
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.*
-->

<!--
## 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 Datasets

#### train

* Dataset: [train](https://huggingface.co/datasets/matunderstars/ufes-qa-data) at [02bfedf](https://huggingface.co/datasets/matunderstars/ufes-qa-data/tree/02bfedf96441339120864b5df6b748c47d391b2d)
* Size: 100 training samples
* Columns: <code>question</code> and <code>answer</code>
* Approximate statistics based on the first 100 samples:
  |         | question                                                                          | answer                                                                              |
  |:--------|:----------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|
  | type    | string                                                                            | string                                                                              |
  | details | <ul><li>min: 7 tokens</li><li>mean: 18.35 tokens</li><li>max: 45 tokens</li></ul> | <ul><li>min: 14 tokens</li><li>mean: 47.62 tokens</li><li>max: 128 tokens</li></ul> |
* Samples:
  | question                                                              | answer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
  |:----------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  | <code>Formatação de computador</code>                                 | <code>A formatação de computadores deve ser solicitada diretamente ao suporte de TI, que avaliará a necessidade de backup e reinstalação dos sistemas operacionais.</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | <code>Como solicitar o recolhimento de um bem patrimonial?</code>     | <code>Envie um ofício via documento avulso para a DRMN, conforme manual disponível em https://drm.saomateus.ufes.br/manuais-0.</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | <code>Como solicitar pagamento de ajuda de custos à estudante?</code> | <code>Cabe à Secretaria Única de Graduação – SUGRAD/CEUNES instruir devidamente o processo digital, encaminhar para análise e aprovação da Direção do Ceunes, que se estiver de acordo, remeterá o mesmo à DCFN (Divisão de Contabilidade e Finanças) para efetivação do pagamento.<br>Informações sobre pagamento de ajuda de custos à estudantes entrar em contato com a DCFN (Divisão de Contabilidade e Finanças).<br><br>E-mail institucional: dcfn.ceunes@ufes.br.<br><br>Telefones: 3312-1517 e 3312-1518.<br><br>Demais informações acesse o site: https://www.gestaoadministrativa.saomateus.ufes.br/apresentacao</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"
  }
  ```

#### test

* Dataset: [test](https://huggingface.co/datasets/matunderstars/ufes-qa-data) at [02bfedf](https://huggingface.co/datasets/matunderstars/ufes-qa-data/tree/02bfedf96441339120864b5df6b748c47d391b2d)
* Size: 100 training samples
* Columns: <code>question</code> and <code>answer</code>
* Approximate statistics based on the first 100 samples:
  |         | question                                                                          | answer                                                                             |
  |:--------|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|
  | type    | string                                                                            | string                                                                             |
  | details | <ul><li>min: 8 tokens</li><li>mean: 16.95 tokens</li><li>max: 33 tokens</li></ul> | <ul><li>min: 19 tokens</li><li>mean: 58.8 tokens</li><li>max: 128 tokens</li></ul> |
* Samples:
  | question                                                       | answer                                                                                                                                                                                                                                                                |
  |:---------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  | <code>O que fazer em casos de urgência e emergência?</code>    | <code>Siga as orientações disponíveis em : https://www.canva.com/design/DAGSiS46fII/0lsNqyuJYj4EYXkYnQNLyQ/edit?utm_content=DAGSiS46fII&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton</code>                                                       |
  | <code>Como receber os resultados dos exames periódicos?</code> | <code>Aguarde o e-mail de convocação para o recebimento dos resultados. Em caso de dúvidas, favor entrar em contato com o Setor de Enfermagem da DASAS pelo email enfermagem.dasas@ufes.br ou compareça presencialmente no Setor para maiores esclarecimentos.</code> |
  | <code>Como realizar o cadastro no Proaes?</code>               | <code>Acesse o site da Proaeci em https://proaeci.ufes.br/editais para verificar se há algum edital vigente para o semestre.</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

- `per_device_train_batch_size`: 16
- `per_device_eval_batch_size`: 16
- `num_train_epochs`: 300
- `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`: no
- `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`: 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.0
- `num_train_epochs`: 300
- `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
- `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 | Training Loss |
|:--------:|:----:|:-------------:|
| 71.4286  | 500  | 0.1318        |
| 142.8571 | 1000 | 0.0001        |
| 214.2857 | 1500 | 0.0           |
| 285.7143 | 2000 | 0.0           |


### Framework Versions
- Python: 3.10.12
- Sentence Transformers: 3.3.1
- Transformers: 4.46.3
- PyTorch: 2.5.1+cu121
- Accelerate: 1.1.1
- Datasets: 3.2.0
- Tokenizers: 0.20.3

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