| --- |
| datasets: |
| - legal_documents |
| language: pt |
| license: apache-2.0 |
| tags: |
| - text-classification |
| - legal |
| - bert |
| - portuguese |
| - brazilian-legal-documents |
| model-index: |
| - name: testmodel |
| results: |
| - task: |
| type: text-classification |
| dataset: |
| name: Legal Documents Classification Dataset |
| type: legal_documents |
| metrics: |
| - type: accuracy |
| value: 0.9124293785310734 |
| - type: f1 |
| value: 0.9069008258581538 |
| - type: precision |
| value: 0.9052447065095824 |
| - type: recall |
| value: 0.9124293785310734 |
| - type: f1_macro |
| value: 0.6832937813302449 |
| --- |
| |
| # Model Card for Model ID |
|
|
| <!-- Provide a quick summary of what the model is/does. --> |
|
|
|
|
|
|
| ## Model Details |
|
|
| ### Model Description |
|
|
| <!-- Provide a longer summary of what this model is. --> |
|
|
|
|
| # Modelo de Classificação de Documentos Jurídicos |
|
|
| Este modelo foi treinado para classificar documentos jurídicos brasileiros usando BERT multilíngue. |
|
|
| ## Detalhes do Modelo |
|
|
| - **Base Model:** google-bert/bert-base-multilingual-cased |
| - **Tipo:** Classificação Multiclasse |
| - **Número de Classes:** 8 |
| - **Idioma:** Português (Brasil) |
| - **Domínio:** Documentos Jurídicos |
|
|
| ## Classes |
|
|
| 0. Alvará |
| 1. Sentença |
| 2. Penhora/Arresto/Sequestro |
| 3. Citação |
| 4. Art.40 |
| 5. Não |
| 6. Teste |
| 7. Teste 2 |
|
|
| ## Métricas de Avaliação |
|
|
| As métricas abaixo foram calculadas no conjunto de validação: |
|
|
| - **Accuracy:** 0.9124 |
| - **F1-Score (Weighted):** 0.9069 |
| - **Precision (Weighted):** 0.9052 |
| - **Recall (Weighted):** 0.9124 |
| - **F1-Score (Macro):** 0.6833 |
|
|
| ## Classification Report Completo |
|
|
| ``` |
| precision recall f1-score support |
| |
| 0 0.00 0.00 0.00 7 |
| 1 0.94 0.98 0.96 48 |
| 2 0.95 0.72 0.82 57 |
| 3 0.82 0.95 0.88 42 |
| 4 0.88 0.95 0.91 132 |
| 5 0.94 0.95 0.94 408 |
| 6 0.40 0.33 0.36 6 |
| 7 0.56 0.62 0.59 8 |
| |
| accuracy 0.91 708 |
| macro avg 0.69 0.69 0.68 708 |
| weighted avg 0.91 0.91 0.91 708 |
| |
| ``` |
|
|
| ## Uso |
|
|
| ```python |
| from transformers import AutoTokenizer, AutoModelForSequenceClassification |
| import torch |
| |
| # Carregar modelo e tokenizer |
| model = AutoModelForSequenceClassification.from_pretrained("rkenji/testmodel") |
| tokenizer = AutoTokenizer.from_pretrained("rkenji/testmodel") |
| |
| # Fazer predição |
| texto = "Seu texto jurídico aqui" |
| inputs = tokenizer(texto, return_tensors="pt", truncation=True, max_length=512) |
| outputs = model(**inputs) |
| prediction = torch.argmax(outputs.logits, dim=1).item() |
| |
| print(f"Classe predita: {prediction}") |
| ``` |
|
|
| ## Treinamento |
|
|
| O modelo foi treinado com early stopping e validação cruzada em um dataset de documentos jurídicos brasileiros. |
|
|
|
|
| - **Developed by:** [More Information Needed] |
| - **Funded by [optional]:** [More Information Needed] |
| - **Shared by [optional]:** [More Information Needed] |
| - **Model type:** [More Information Needed] |
| - **Language(s) (NLP):** pt |
| - **License:** apache-2.0 |
| - **Finetuned from model [optional]:** [More Information Needed] |
|
|
| ### Model Sources [optional] |
|
|
| <!-- Provide the basic links for the model. --> |
|
|
| - **Repository:** [More Information Needed] |
| - **Paper [optional]:** [More Information Needed] |
| - **Demo [optional]:** [More Information Needed] |
|
|
| ## Uses |
|
|
| <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. --> |
|
|
| ### Direct Use |
|
|
| <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. --> |
|
|
| [More Information Needed] |
|
|
| ### Downstream Use [optional] |
|
|
| <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app --> |
|
|
| [More Information Needed] |
|
|
| ### Out-of-Scope Use |
|
|
| <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. --> |
|
|
| [More Information Needed] |
|
|
| ## Bias, Risks, and Limitations |
|
|
| <!-- This section is meant to convey both technical and sociotechnical limitations. --> |
|
|
| [More Information Needed] |
|
|
| ### Recommendations |
|
|
| <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. --> |
|
|
| Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. |
|
|
| ## How to Get Started with the Model |
|
|
| Use the code below to get started with the model. |
|
|
| [More Information Needed] |
|
|
| ## Training Details |
|
|
| ### Training Data |
|
|
| <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. --> |
|
|
| [More Information Needed] |
|
|
| ### Training Procedure |
|
|
| <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. --> |
|
|
| #### Preprocessing [optional] |
|
|
| [More Information Needed] |
|
|
|
|
| #### Training Hyperparameters |
|
|
| - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> |
|
|
| #### Speeds, Sizes, Times [optional] |
|
|
| <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. --> |
|
|
| [More Information Needed] |
|
|
| ## Evaluation |
|
|
| <!-- This section describes the evaluation protocols and provides the results. --> |
|
|
| ### Testing Data, Factors & Metrics |
|
|
| #### Testing Data |
|
|
| <!-- This should link to a Dataset Card if possible. --> |
|
|
| [More Information Needed] |
|
|
| #### Factors |
|
|
| <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. --> |
|
|
| [More Information Needed] |
|
|
| #### Metrics |
|
|
| <!-- These are the evaluation metrics being used, ideally with a description of why. --> |
|
|
| [More Information Needed] |
|
|
| ### Results |
|
|
| [More Information Needed] |
|
|
| #### Summary |
|
|
|
|
|
|
| ## Model Examination [optional] |
|
|
| <!-- Relevant interpretability work for the model goes here --> |
|
|
| [More Information Needed] |
|
|
| ## Environmental Impact |
|
|
| <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly --> |
|
|
| Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700). |
|
|
| - **Hardware Type:** [More Information Needed] |
| - **Hours used:** [More Information Needed] |
| - **Cloud Provider:** [More Information Needed] |
| - **Compute Region:** [More Information Needed] |
| - **Carbon Emitted:** [More Information Needed] |
|
|
| ## Technical Specifications [optional] |
|
|
| ### Model Architecture and Objective |
|
|
| [More Information Needed] |
|
|
| ### Compute Infrastructure |
|
|
| [More Information Needed] |
|
|
| #### Hardware |
|
|
| [More Information Needed] |
|
|
| #### Software |
|
|
| [More Information Needed] |
|
|
| ## Citation [optional] |
|
|
| <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. --> |
|
|
| **BibTeX:** |
|
|
| [More Information Needed] |
|
|
| **APA:** |
|
|
| [More Information Needed] |
|
|
| ## Glossary [optional] |
|
|
| <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. --> |
|
|
| [More Information Needed] |
|
|
| ## More Information [optional] |
|
|
| [More Information Needed] |
|
|
| ## Model Card Authors [optional] |
|
|
| [More Information Needed] |
|
|
| ## Model Card Contact |
|
|
| [More Information Needed] |
