readme: ---
  thumbnail: "https://i.imgur.com/tpI1iT5.jpg"
  license: apache-2.0
  language: 
  - pt
  tags:
  - generated_from_trainer
  metrics:
  - precision
  - recall
  - f1
  - accuracy
  model-index:
  - name: checkpoints
    results:
    - task:
        name: Token Classification
        type: token-classification
      metrics:
      - name: F1
        type: f1
        value: 0.9525622169191057
      - name: Precision
        type: precision
        value: 0.9438680702115613
      - name: Recall
        type: recall
        value: 0.961418019517758
      - name: Accuracy
        type: accuracy
        value: 0.9894253721279602
      - name: Loss
        type: loss
        value: 0.030161771923303604
  widget:
  - text: "Ao Instituto Médico Legal da jurisdição do acidente ou da residência cumpre fornecer, no prazo de 90 dias, laudo à vítima (art. 5, § 5, Lei n. 6.194/74  de 19 de dezembro de 1974), função técnica que pode ser suprida por prova pericial realizada por ordem do juízo da causa, ou por prova técnica realizada no âmbito administrativo que se mostre coerente com os demais elementos de prova constante dos autos."
  - text: "Acrescento que não há de se falar em violação do artigo 114, § 3º, da Constituição Federal, posto que referido dispositivo revela-se impertinente, tratando da possibilidade de ajuizamento de dissídio coletivo pelo Ministério Público do Trabalho nos casos de greve em atividade essencial."
  - text: "Dispõe sobre o estágio de estudantes; altera a redação do art. 428 da Consolidação das Leis do Trabalho – CLT, aprovada pelo Decreto-Lei no 5.452, de 1o de maio de 1943, e a Lei no 9.394, de 20 de dezembro de 1996; revoga as Leis nos 6.494, de 7 de dezembro de 1977, e 8.859, de 23 de março de 1994, o parágrafo único do art. 82 da Lei no 9.394, de 20 de dezembro de 1996, e o art. 6o da Medida Provisória  no 2.164-41, de 24 de agosto de 2001; e dá outras providências."
  ---
  
  ## (BERT base) NER model in the legal domain in Portuguese
  
  **README under construction**
  
  **ner-legal-bert-base-cased-ptbr** is a NER model (token classification) in the legal domain in Portuguese that was finetuned from the model [dominguesm/legal-bert-base-cased-ptbr](https://huggingface.co/dominguesm/legal-bert-base-cased-ptbr) by using a NER objective.
  
  The model is intended to assist NLP research in the legal field, computer law and legal technology applications. Several legal texts in Portuguese (more information below) were used with the following labels: 
  
  * `PESSOA`
  * `ORGANIZACAO`
  * `LOCAL`
  * `TEMPO`
  * `LEGISLACAO`
  * `JURISPRUDENCIA`
  
  The labels were inspired by the [LeNER_br](https://huggingface.co/datasets/lener_br) dataset.
  ## Training Dataset
  
  
  The dataset of **ner-legal-bert-base-cased-ptbr** include:
  
  * 971932 examples of miscellaneous legal documents (train split) 
  * 53996 examples of miscellaneous legal documents (valid split) 
  * 53997 examples of miscellaneous legal documents (test split) 
  
  The data used was provided by the BRAZILIAN SUPREME FEDERAL TRIBUNAL, through the terms of use: [LREC 2020](https://ailab.unb.br/victor/lrec2020). 
  
  The results of this project do not imply in any way the position of the BRAZILIAN SUPREME FEDERAL TRIBUNAL, all being the sole and exclusive responsibility of the author of the model.
  
  ## Using the model for inference in production
  
  ```python
  from transformers import AutoModelForTokenClassification, AutoTokenizer
  import torch
  
  # parameters
  model_name = "dominguesm/ner-legal-bert-base-cased-ptbr"
  model = AutoModelForTokenClassification.from_pretrained(model_name)
  tokenizer = AutoTokenizer.from_pretrained(model_name)
  
  input_text = "Acrescento que não há de se falar em violação do artigo 114, § 3º, da Constituição Federal, posto que referido dispositivo revela-se impertinente, tratando da possibilidade de ajuizamento de dissídio coletivo pelo Ministério Público do Trabalho nos casos de greve em atividade essencial."
  
  # tokenization
  inputs = tokenizer(input_text, max_length=512, truncation=True, return_tensors="pt")
  tokens = inputs.tokens()
  
  # get predictions
  outputs = model(**inputs).logits
  predictions = torch.argmax(outputs, dim=2)
  
  # print predictions
  for token, prediction in zip(tokens, predictions[0].numpy()):
      print((token, model.config.id2label[prediction]))
  ```
  
  You can use pipeline, too. However, it seems to have an issue regarding to the max_length of the input sequence.
  
  ```python
  from transformers import pipeline
  
  model_name = "dominguesm/ner-legal-bert-base-cased-ptbr"
  
  ner = pipeline(
      "ner",
      model=model_name
  ) 
  
  ner(input_text, aggregation_strategy="average")
  ```
  
  ## Training procedure
  
  ### Hyperparameters
  
  #### batch, learning rate...
  - per_device_batch_size = 64
  - gradient_accumulation_steps = 2
  - learning_rate = 2e-5 
  - num_train_epochs = 3
  - weight_decay = 0.01
  - optimizer = torch.optim.AdamW
  - epsilon = 1e-08
  - lr_scheduler_type = linear
  
  #### save model & load best model
  - save_total_limit = 3
  - logging_steps = 1000
  - eval_steps = logging_steps
  - evaluation_strategy = 'steps'
  - logging_strategy = 'steps'
  - save