Update README.md

---
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- finance
- legal
- portuguese
- tax-law
- nfs-e
- reforma-tributaria
pipeline_tag: sentence-similarity
library_name: sentence-transformers
language:
- pt
base_model: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
widget:
- source_sentence: "Quem é o sujeito passivo do IBS?"
sentences:
- "Consequente - Critério Pessoal (Sujeito Passivo): Contribuinte é quem realiza a operação ou a Plataforma Digital."
- "O imposto é devido no local do prestador."
- "A alíquota do ISS é de 5%."
- source_sentence: "O que significa a tag cLocalidadeIncid no XML?"
sentences:
- "Código IBGE do local onde o imposto é devido (princípio do destino)."
- "Valor total da nota fiscal."
- "Código do serviço prestado na LC 116."
---

# MiniLM_ISSIBSNFSe_V1-0: Auditor Fiscal IA (Reforma Tributária & NFS-e)

Este é um modelo de **Sentence Transformer** fine-tuned (ajustado) a partir do [paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2).

Ele foi treinado especificamente para compreender a semântica e a lógica jurídica da **Reforma Tributária Brasileira do Consumo (IBS/CBS)**, o sistema legado (**ISS/LC 116**) e o layout técnico da **NFS-e Nacional (NT 005)**.

## Descrição do Modelo

Este modelo mapeia frases e parágrafos para um espaço vetorial denso de 384 dimensões. Ele foi desenvolvido para superar a barreira entre a linguagem técnica de TI (XML, Tags) e a linguagem jurídica (Leis Complementares).

O modelo é capaz de distinguir conceitos que mudaram com a reforma, especificamente a transição do princípio da origem (ISS) para o princípio do destino (IBS).

### Usos Recomendados

* **RAG (Retrieval-Augmented Generation):** Busca semântica em bases de legislação tributária para chatbots fiscais.
* **Auditoria Fiscal Automatizada:** Validação de coerência entre a descrição do serviço na nota e as tags do XML.
* **Classificação de Regras:** Distinção automática entre regras do ISS (LC 116) e IBS (LC 214).
* **Suporte ao Desenvolvedor:** Tradução de dúvidas funcionais (ex: "onde incide o imposto?") para tags técnicas (ex: `cLocalidadeIncid`).

## Exemplo de Uso

Você pode utilizar este modelo diretamente com a biblioteca `sentence-transformers`:

```python
from sentence_transformers import SentenceTransformer
from sentence_transformers import util

# 1. Carregar o Modelo
model = SentenceTransformer("MacedoR/MiniLM_ISSIBSNFSe_V1-0")

# 2. Definir Pergunta e Base de Conhecimento
query = "Onde o imposto é devido no novo sistema?"
docs = [
"ISS (LC 116): O imposto é devido no local do estabelecimento prestador (Origem).",
"IBS (LC 214): O imposto é devido no local de entrega ou consumo (Destino).",
"A alíquota máxima é de 5%."
]

# 3. Codificar e Buscar
query_emb = model.encode(query)
doc_embs = model.encode(docs)

# 4. Calcular Similaridade
scores = util.dot_score(query_emb, doc_embs)[0].cpu().tolist()

# Combinar resultados
doc_score_pairs = list(zip(docs, scores))
doc_score_pairs = sorted(doc_score_pairs, key=lambda x: x[1], reverse=True)

for doc, score in doc_score_pairs:
print(f"{score:.4f} | {doc}")
# Resultado esperado: Alta similaridade com a regra do IBS (Destino).
Detalhes do Treinamento
O modelo passou por um treinamento supervisionado focado na RMIT (Regra-Matriz de Incidência Tributária).

Dataset
O corpus de treinamento foi construído manualmente com pares semânticos (Pergunta/Conceito) cobrindo:

Transição de Mentalidade:

De: Origem (Estabelecimento Prestador) -> Para: Destino (Local do Consumo).

De: Cálculo "por dentro" -> Para: Cálculo "por fora".

Layout Técnico (NFS-e Nacional):

Compreensão de tags XML como cLocalidadeIncid, cIndOp, vTotNF, gLocBensMoveis.

Interpretação da Nota Técnica 005 (NT 2024.001).

Lógica Jurídica:

Antecedente (Critério Material e Espacial).

Consequente (Critério Pessoal e Quantitativo).

Hiperparâmetros
Modelo Base: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2

Função de Perda: CosineSimilarityLoss

Épocas: 20

Batch Size: 4

Comprimento Máximo de Sequência: 128 tokens

Limitações
Consultoria Legal: Este modelo é uma ferramenta de busca e associação semântica. Não substitui o parecer de um advogado ou contador.

Escopo: O conhecimento está limitado às Notas Técnicas e Leis Complementares disponíveis até a data do treinamento (Dezembro/2025).

Citação
Se utilizar este modelo em sua aplicação fiscal, cite o repositório:


@misc
{MacedoR-MiniLM-Fiscal,
author = {MacedoR},
title = {MiniLM_ISSIBSNFSe_V1-0: AUD_IA},
year = {2025},
publisher = {Hugging Face},
journal = {Hugging Face Repository},
howpublished = {\url{[https://huggingface.co/MacedoR/MiniLM_ISSIBSNFSe_V1-0](https://huggingface.co/MacedoR/MiniLM_ISSIBSNFSe_V1-0)}}

README.md

@@ -3,321 +3,133 @@ tags:
 - sentence-transformers
 - sentence-similarity
 - feature-extraction
-- dense
 - generated_from_trainer
-- dataset_size:8
-- loss:CosineSimilarityLoss
+- finance
+- legal
+- portuguese
+- tax-law
+- nfs-e
+- reforma-tributaria
+pipeline_tag: sentence-similarity
+library_name: sentence-transformers
+language:
+- pt
 base_model: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
 widget:
-- source_sentence: O que é a RMIT?
+- source_sentence: "Quem é o sujeito passivo do IBS?"
   sentences:
-  - 'Antecedente - Critério Material: Operações onerosas com bens e serviços (LC 214)'
-  - 'Estrutura lógica: Se (fato gerador) Então (relação jurídica obrigacional)'
-  - 'Critério Espacial IBS: São Paulo (Destino/Consumo)'
-pipeline_tag: sentence-similarity
-library_name: sentence-transformers
+  - "Consequente - Critério Pessoal (Sujeito Passivo): Contribuinte é quem realiza a operação ou a Plataforma Digital."
+  - "O imposto é devido no local do prestador."
+  - "A alíquota do ISS é de 5%."
+- source_sentence: "O que significa a tag cLocalidadeIncid no XML?"
+  sentences:
+  - "Código IBGE do local onde o imposto é devido (princípio do destino)."
+  - "Valor total da nota fiscal."
+  - "Código do serviço prestado na LC 116."
 ---
 
-# SentenceTransformer based on sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
+# MiniLM_ISSIBSNFSe_V1-0: Auditor Fiscal IA (Reforma Tributária & NFS-e)
 
-This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-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.
+Este é um modelo de **Sentence Transformer** fine-tuned (ajustado) a partir do [paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2).
 
-## Model Details
+Ele foi treinado especificamente para compreender a semântica e a lógica jurídica da **Reforma Tributária Brasileira do Consumo (IBS/CBS)**, o sistema legado (**ISS/LC 116**) e o layout técnico da **NFS-e Nacional (NT 005)**.
 
-### Model Description
-- **Model Type:** Sentence Transformer
-- **Base model:** [sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2) <!-- at revision 86741b4e3f5cb7765a600d3a3d55a0f6a6cb443d -->
-- **Maximum Sequence Length:** 128 tokens
-- **Output Dimensionality:** 384 dimensions
-- **Similarity Function:** Cosine Similarity
-<!-- - **Training Dataset:** Unknown -->
-<!-- - **Language:** Unknown -->
-<!-- - **License:** Unknown -->
+## Uso e Aplicações
 
-### Model Sources
+Este modelo mapeia frases e parágrafos para um espaço vetorial denso de 384 dimensões. Ele é ideal para tarefas de:
 
-- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
-- **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers)
-- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
+* **RAG (Retrieval-Augmented Generation):** Busca semântica em bases de legislação tributária.
+* **Auditoria Fiscal Automatizada:** Comparação entre descrições de notas fiscais e a regra matriz de incidência.
+* **Classificação de Regime:** Distinção automática entre regras do ISS (Origem) e IBS (Destino).
+* **Assistente de Developers:** Mapeamento de linguagem natural para tags XML da NFS-e.
 
-### Full Model Architecture
+### Exemplo de Uso (Sentence-Transformers)
 
-```
-SentenceTransformer(
-  (0): Transformer({'max_seq_length': 128, 'do_lower_case': False, 'architecture': '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})
-)
-```
+```python
+from sentence_transformers import SentenceTransformer
+from sentence_transformers import util
 
-## Usage
+# 1. Carregar o Modelo
+model = SentenceTransformer("MacedoR/MiniLM_ISSIBSNFSe_V1-0")
 
-### Direct Usage (Sentence Transformers)
+# 2. Definir Pergunta e Base de Conhecimento
+query = "Onde o imposto é devido no novo sistema?"
+docs = [
+    "ISS (LC 116): O imposto é devido no local do estabelecimento prestador (Origem).",
+    "IBS (LC 214): O imposto é devido no local de entrega ou consumo (Destino).",
+    "A alíquota máxima é de 5%."
+]
 
-First install the Sentence Transformers library:
+# 3. Codificar e Buscar
+query_emb = model.encode(query)
+doc_embs = model.encode(docs)
 
-```bash
-pip install -U sentence-transformers
-```
+scores = util.dot_score(query_emb, doc_embs)[0].cpu().tolist()
 
-Then you can load this model and run inference.
-```python
-from sentence_transformers import SentenceTransformer
+# Combinar resultados
+doc_score_pairs = list(zip(docs, scores))
+doc_score_pairs = sorted(doc_score_pairs, key=lambda x: x[1], reverse=True)
 
-# Download from the 🤗 Hub
-model = SentenceTransformer("sentence_transformers_model_id")
-# Run inference
-sentences = [
-    'O que é a RMIT?',
-    'Estrutura lógica: Se (fato gerador) Então (relação jurídica obrigacional)',
-    'Critério Espacial IBS: São Paulo (Destino/Consumo)',
-]
-embeddings = model.encode(sentences)
-print(embeddings.shape)
-# [3, 384]
-
-# Get the similarity scores for the embeddings
-similarities = model.similarity(embeddings, embeddings)
-print(similarities)
-# tensor([[1.0000, 0.9486, 0.7239],
-#         [0.9486, 1.0000, 0.7396],
-#         [0.7239, 0.7396, 1.0000]])
-```
-
-<!--
-### 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: 8 training samples
-* Columns: <code>sentence_0</code>, <code>sentence_1</code>, and <code>label</code>
-* Approximate statistics based on the first 8 samples:
-  |         | sentence_0                                                                        | sentence_1                                                                         | label                                                         |
-  |:--------|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|:--------------------------------------------------------------|
-  | type    | string                                                                            | string                                                                             | float                                                         |
-  | details | <ul><li>min: 9 tokens</li><li>mean: 13.25 tokens</li><li>max: 20 tokens</li></ul> | <ul><li>min: 20 tokens</li><li>mean: 25.25 tokens</li><li>max: 30 tokens</li></ul> | <ul><li>min: 1.0</li><li>mean: 1.0</li><li>max: 1.0</li></ul> |
-* Samples:
-  | sentence_0                                                                        | sentence_1                                                                                   | label            |
-  |:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------|:-----------------|
-  | <code>Onde o imposto é devido no ISS?</code>                                      | <code>Antecedente - Critério Espacial: Estabelecimento prestador (Regra Geral LC 116)</code> | <code>1.0</code> |
-  | <code>Empresa de Sete Lagoas presta serviço para SP. Onde paga ISS?</code>        | <code>Critério Espacial ISS: Sete Lagoas (Origem), salvo se for exceção do art. 3º</code>    | <code>1.0</code> |
-  | <code>Empresa de Sete Lagoas vende serviço digital para SP. Onde paga IBS?</code> | <code>Critério Espacial IBS: São Paulo (Destino/Consumo)</code>                              | <code>1.0</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
-
-- `per_device_train_batch_size`: 4
-- `per_device_eval_batch_size`: 4
-- `num_train_epochs`: 20
-- `multi_dataset_batch_sampler`: round_robin
-
-#### 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`: 4
-- `per_device_eval_batch_size`: 4
-- `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
-- `num_train_epochs`: 20
-- `max_steps`: -1
-- `lr_scheduler_type`: linear
-- `lr_scheduler_kwargs`: {}
-- `warmup_ratio`: 0.0
-- `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
-- `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`: 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}
-- `parallelism_config`: None
-- `deepspeed`: None
-- `label_smoothing_factor`: 0.0
-- `optim`: adamw_torch_fused
-- `optim_args`: None
-- `adafactor`: False
-- `group_by_length`: False
-- `length_column_name`: length
-- `project`: huggingface
-- `trackio_space_id`: trackio
-- `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
-- `hub_revision`: None
-- `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
-- `include_tokens_per_second`: False
-- `include_num_input_tokens_seen`: no
-- `neftune_noise_alpha`: None
-- `optim_target_modules`: None
-- `batch_eval_metrics`: False
-- `eval_on_start`: False
-- `use_liger_kernel`: False
-- `liger_kernel_config`: None
-- `eval_use_gather_object`: False
-- `average_tokens_across_devices`: True
-- `prompts`: None
-- `batch_sampler`: batch_sampler
-- `multi_dataset_batch_sampler`: round_robin
-- `router_mapping`: {}
-- `learning_rate_mapping`: {}
-
-</details>
-
-### Framework Versions
-- Python: 3.12.12
-- Sentence Transformers: 5.1.2
-- Transformers: 4.57.2
-- PyTorch: 2.9.0+cu126
-- Accelerate: 1.12.0
-- Datasets: 4.0.0
-- Tokenizers: 0.22.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.*
--->
+for doc, score in doc_score_pairs:
+    print(f"{score:.4f} | {doc}")
+# Resultado esperado: Alta similaridade com a regra do IBS (Destino).
+Detalhes do Treinamento
+O modelo passou por um treinamento supervisionado focado na RMIT (Regra-Matriz de Incidência Tributária). Diferente de modelos genéricos, ele entende que "Localidade" pode significar coisas opostas dependendo da lei (LC 116 vs LC 214).
+
+Dataset de Treino
+O corpus de treinamento incluiu pares semânticos (Pergunta/Conceito) cobrindo:
+
+Transição de Mentalidade:
+
+De: Origem (Estabelecimento Prestador) -> Para: Destino (Local do Consumo).
+
+De: Cálculo por dentro -> Para: Cálculo por fora.
+
+Layout Técnico (NFS-e Nacional):
+
+Compreensão de tags XML como cLocalidadeIncid, cIndOp, vTotNF.
+
+Interpretação da Nota Técnica 005 (NT 2024.001).
+
+Lógica Jurídica:
+
+Antecedente (Critério Material e Espacial).
+
+Consequente (Critério Pessoal e Quantitativo).
+
+Hiperparâmetros
+Base Model: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
+
+Loss Function: CosineSimilarityLoss
+
+Epochs: 20 (com early stopping simulado)
+
+Batch Size: 4
+
+Max Sequence Length: 128 tokens
+
+## Performance
+Em testes de validação controlada, o modelo demonstrou alta confiança na distinção de conceitos ambíguos:
+
+Identificação de Conceitos RMIT: > 91% de similaridade.
+
+Diferenciação ISS vs IBS: > 93% de similaridade.
+
+Tradução Técnica (Sigla -> Conceito): > 95% (ex: DPS -> Declaração de Prestação de Serviço).
+
+## Limitações
+Consultoria Legal: Este modelo é uma ferramenta de busca e associação semântica. Não substitui o parecer de um advogado ou contador.
+
+Corte Temporal: O conhecimento está limitado às Notas Técnicas e Leis Complementares disponíveis até a data do treinamento (Dezembro/2025).
+
+Citação
+Se utilizar este modelo em sua aplicação fiscal, cite o repositório:
+
+@misc{MacedoR-MiniLM-Fiscal,
+  author = {MacedoR},
+  title = {MiniLM_ISSIBSNFSe_V1-0: AUD_IA},
+  year = {2025},
+  publisher = {Hugging Face},
+  journal = {Hugging Face Repository},
+  howpublished = {\url{[https://huggingface.co/MacedoR/MiniLM_ISSIBSNFSe_V1-0](https://huggingface.co/MacedoR/MiniLM_ISSIBSNFSe_V1-0)}}
+}