Feature Extraction
sentence-transformers
Safetensors
Portuguese
bert
sentence-similarity
portuguese
financial
cvm
bertimbau
text-embeddings-inference
Instructions to use condeg/cvm-bertimbau-sentence-transformer with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use condeg/cvm-bertimbau-sentence-transformer with sentence-transformers:
from sentence_transformers import SentenceTransformer model = SentenceTransformer("condeg/cvm-bertimbau-sentence-transformer") sentences = [ "The weather is lovely today.", "It's so sunny outside!", "He drove to the stadium." ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [3, 3] - Notebooks
- Google Colab
- Kaggle
Add new SentenceTransformer model
Browse files- 1_Pooling/config.json +5 -0
- README.md +81 -0
- config.json +35 -0
- config_sentence_transformers.json +14 -0
- model.safetensors +3 -0
- modules.json +14 -0
- sentence_bert_config.json +10 -0
- tokenizer.json +0 -0
- tokenizer_config.json +21 -0
1_Pooling/config.json
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"embedding_dimension": 768,
|
| 3 |
+
"pooling_mode": "mean",
|
| 4 |
+
"include_prompt": true
|
| 5 |
+
}
|
README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- pt
|
| 4 |
+
tags:
|
| 5 |
+
- sentence-transformers
|
| 6 |
+
- sentence-similarity
|
| 7 |
+
- feature-extraction
|
| 8 |
+
- portuguese
|
| 9 |
+
- financial
|
| 10 |
+
- cvm
|
| 11 |
+
- bertimbau
|
| 12 |
+
base_model: neuralmind/bert-base-portuguese-cased
|
| 13 |
+
license: mit
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
# cvm-bertimbau-sentence-transformer
|
| 17 |
+
|
| 18 |
+
Fine-tuned [BERTimbau](https://huggingface.co/neuralmind/bert-base-portuguese-cased)
|
| 19 |
+
sentence transformer for dense retrieval over Brazilian public company filings (CVM ITR/DFP).
|
| 20 |
+
Part of the [CVM Filing Intelligence System](https://github.com/conderafael/cvm-intelligence).
|
| 21 |
+
|
| 22 |
+
## Training
|
| 23 |
+
|
| 24 |
+
| Parameter | Value |
|
| 25 |
+
|---|---|
|
| 26 |
+
| Base model | `neuralmind/bert-base-portuguese-cased` |
|
| 27 |
+
| Loss | `MultipleNegativesRankingLoss` |
|
| 28 |
+
| Training pairs | 14,500 (adjacent same-section chunk pairs from 686 CVM filings) |
|
| 29 |
+
| Epochs | 10 |
|
| 30 |
+
| Batch size | 16 (effective 64 with gradient accumulation ×4) |
|
| 31 |
+
| Mixed precision | fp16 |
|
| 32 |
+
| Max sequence length | 256 tokens |
|
| 33 |
+
| Hardware | NVIDIA RTX A1000 (6 GB VRAM), ~2 hours |
|
| 34 |
+
| Initial loss | 2.201 (step 50) |
|
| 35 |
+
| Final loss | 0.115 (step 2,270) |
|
| 36 |
+
|
| 37 |
+
Training data: 97,138 management commentary chunks from 49 B3 large-cap companies
|
| 38 |
+
(Petrobras, Vale, Itaú, Bradesco, Ambev, etc.), 2022–2025. Pairs are adjacent
|
| 39 |
+
paragraphs within the same section of the same filing.
|
| 40 |
+
|
| 41 |
+
## Retrieval Results
|
| 42 |
+
|
| 43 |
+
Evaluated on 94 synthetic queries over the 97,138-chunk corpus
|
| 44 |
+
(dense-only configuration):
|
| 45 |
+
|
| 46 |
+
| Metric | Value |
|
| 47 |
+
|---|---|
|
| 48 |
+
| Recall@5 | 0.057 |
|
| 49 |
+
| Recall@10 | 0.071 |
|
| 50 |
+
| MRR | 0.100 |
|
| 51 |
+
| NDCG@10 | 0.063 |
|
| 52 |
+
|
| 53 |
+
**Note:** The model underperforms BM25 on query–document retrieval because it was
|
| 54 |
+
fine-tuned with doc–doc contrastive pairs. Query–doc performance improves significantly
|
| 55 |
+
with GPL (Generative Pseudo Labeling) fine-tuning using synthetic query–chunk pairs.
|
| 56 |
+
|
| 57 |
+
## Usage
|
| 58 |
+
|
| 59 |
+
```python
|
| 60 |
+
from sentence_transformers import SentenceTransformer
|
| 61 |
+
|
| 62 |
+
model = SentenceTransformer("conderafael/cvm-bertimbau-sentence-transformer")
|
| 63 |
+
|
| 64 |
+
# Encode a single passage
|
| 65 |
+
embeddings = model.encode(["Receita líquida cresceu 12% no trimestre"])
|
| 66 |
+
|
| 67 |
+
# Encode a batch
|
| 68 |
+
texts = [
|
| 69 |
+
"O EBITDA ajustado atingiu R$ 4,2 bilhões no 3T24.",
|
| 70 |
+
"A Companhia mantém posição conservadora de hedge cambial.",
|
| 71 |
+
]
|
| 72 |
+
embeddings = model.encode(texts, normalize_embeddings=True)
|
| 73 |
+
print(embeddings.shape) # (2, 768)
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
## Limitations
|
| 77 |
+
|
| 78 |
+
- Trained on Portuguese-language financial filings only; degrades on other domains.
|
| 79 |
+
- Max sequence length 256 tokens; longer passages are truncated.
|
| 80 |
+
- Query-time performance is below doc-time performance due to training objective mismatch
|
| 81 |
+
(doc–doc pairs vs. query–doc retrieval).
|
config.json
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"add_cross_attention": false,
|
| 3 |
+
"architectures": [
|
| 4 |
+
"BertModel"
|
| 5 |
+
],
|
| 6 |
+
"attention_probs_dropout_prob": 0.1,
|
| 7 |
+
"bos_token_id": null,
|
| 8 |
+
"classifier_dropout": null,
|
| 9 |
+
"directionality": "bidi",
|
| 10 |
+
"dtype": "float32",
|
| 11 |
+
"eos_token_id": null,
|
| 12 |
+
"hidden_act": "gelu",
|
| 13 |
+
"hidden_dropout_prob": 0.1,
|
| 14 |
+
"hidden_size": 768,
|
| 15 |
+
"initializer_range": 0.02,
|
| 16 |
+
"intermediate_size": 3072,
|
| 17 |
+
"is_decoder": false,
|
| 18 |
+
"layer_norm_eps": 1e-12,
|
| 19 |
+
"max_position_embeddings": 512,
|
| 20 |
+
"model_type": "bert",
|
| 21 |
+
"num_attention_heads": 12,
|
| 22 |
+
"num_hidden_layers": 12,
|
| 23 |
+
"output_past": true,
|
| 24 |
+
"pad_token_id": 0,
|
| 25 |
+
"pooler_fc_size": 768,
|
| 26 |
+
"pooler_num_attention_heads": 12,
|
| 27 |
+
"pooler_num_fc_layers": 3,
|
| 28 |
+
"pooler_size_per_head": 128,
|
| 29 |
+
"pooler_type": "first_token_transform",
|
| 30 |
+
"tie_word_embeddings": true,
|
| 31 |
+
"transformers_version": "5.5.4",
|
| 32 |
+
"type_vocab_size": 2,
|
| 33 |
+
"use_cache": true,
|
| 34 |
+
"vocab_size": 29794
|
| 35 |
+
}
|
config_sentence_transformers.json
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"__version__": {
|
| 3 |
+
"pytorch": "2.11.0+cu130",
|
| 4 |
+
"sentence_transformers": "5.4.1",
|
| 5 |
+
"transformers": "5.5.4"
|
| 6 |
+
},
|
| 7 |
+
"default_prompt_name": null,
|
| 8 |
+
"model_type": "SentenceTransformer",
|
| 9 |
+
"prompts": {
|
| 10 |
+
"document": "",
|
| 11 |
+
"query": ""
|
| 12 |
+
},
|
| 13 |
+
"similarity_fn_name": "cosine"
|
| 14 |
+
}
|
model.safetensors
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:715058b832103f95a9f0f24233329cc42eec5896cbde3ad2eae5646a2d4f8714
|
| 3 |
+
size 435714880
|
modules.json
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[
|
| 2 |
+
{
|
| 3 |
+
"idx": 0,
|
| 4 |
+
"name": "0",
|
| 5 |
+
"path": "",
|
| 6 |
+
"type": "sentence_transformers.base.modules.transformer.Transformer"
|
| 7 |
+
},
|
| 8 |
+
{
|
| 9 |
+
"idx": 1,
|
| 10 |
+
"name": "1",
|
| 11 |
+
"path": "1_Pooling",
|
| 12 |
+
"type": "sentence_transformers.sentence_transformer.modules.pooling.Pooling"
|
| 13 |
+
}
|
| 14 |
+
]
|
sentence_bert_config.json
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"transformer_task": "feature-extraction",
|
| 3 |
+
"modality_config": {
|
| 4 |
+
"text": {
|
| 5 |
+
"method": "forward",
|
| 6 |
+
"method_output_name": "last_hidden_state"
|
| 7 |
+
}
|
| 8 |
+
},
|
| 9 |
+
"module_output_name": "token_embeddings"
|
| 10 |
+
}
|
tokenizer.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
tokenizer_config.json
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"backend": "tokenizers",
|
| 3 |
+
"cls_token": "[CLS]",
|
| 4 |
+
"do_lower_case": false,
|
| 5 |
+
"is_local": true,
|
| 6 |
+
"mask_token": "[MASK]",
|
| 7 |
+
"max_length": 256,
|
| 8 |
+
"model_max_length": 256,
|
| 9 |
+
"pad_to_multiple_of": null,
|
| 10 |
+
"pad_token": "[PAD]",
|
| 11 |
+
"pad_token_type_id": 0,
|
| 12 |
+
"padding_side": "right",
|
| 13 |
+
"sep_token": "[SEP]",
|
| 14 |
+
"stride": 0,
|
| 15 |
+
"strip_accents": null,
|
| 16 |
+
"tokenize_chinese_chars": true,
|
| 17 |
+
"tokenizer_class": "BertTokenizer",
|
| 18 |
+
"truncation_side": "right",
|
| 19 |
+
"truncation_strategy": "longest_first",
|
| 20 |
+
"unk_token": "[UNK]"
|
| 21 |
+
}
|