Update README.md

README.md

@@ -11,16 +11,39 @@ metrics:
 model-index:
 - name: ner-portuguese
   results: []
-  
 widget:
-- text: "Alexandre Telles foi exonerado nesta segunda-feira, assim como o secretário nacional de Atenção Especializada à Saúde, Helvécio Magalhães. As mudanças se deram depois de muita pressão política sobre Nísia e de reportagem do Fantástico, da TV Globo, mostrar no domingo as condições precárias dos hospitais na cidade.e"
-  example_title: "Exemple 1"
-- text: "Os elementos de prova colhidos corroboram as afirmações prestadas pelo colaborador MAURO CESAR BARBOSA CID, demonstrando que, por ordem do então Presidente JAIR BOLSONARO, MAURO CESAR CID solicitou a AILTON BARROS a inserção dos dados falsos de vacinação contra a Covid-19 em benefício do ex-Presidente da República e de sua filha”, afirma a PF."
-  example_title: "Example 2"
-- text: "De acordo com a polícia, parte dos detidos foi identificado como autores de um assalto recente a uma farmácia na região do Morumbi, na zona sul da capital paulista. Todos já tinham passagens por outros crimes. O caso foi registrado na 5ª delegacia da Divisão de Investigações sobre Crimes contra o Patrimônio (DISCCPAT) como roubo e receptação, ambos qualificados, posse ilegal de arma de fogo de uso restrito, associação criminosa e adulteração de sinal veicular identificador."
-  example_title: "Example 3"
-- text: "Dois legumes são suficientes para que você sinta o sabor de ambos no prato. Um pode ser mais macio e outro mais firme, como cenoura ou abóbora. Pense em um legume que dará saciedade e outro mais refrescante"
-  example_title: "Exemple 4"
+- text: >-
+    Alexandre Telles foi exonerado nesta segunda-feira, assim como o secretário
+    nacional de Atenção Especializada à Saúde, Helvécio Magalhães. As mudanças
+    se deram depois de muita pressão política sobre Nísia e de reportagem do
+    Fantástico, da TV Globo, mostrar no domingo as condições precárias dos
+    hospitais na cidade.e
+  example_title: Exemple 1
+- text: >-
+    Os elementos de prova colhidos corroboram as afirmações prestadas pelo
+    colaborador MAURO CESAR BARBOSA CID, demonstrando que, por ordem do então
+    Presidente JAIR BOLSONARO, MAURO CESAR CID solicitou a AILTON BARROS a
+    inserção dos dados falsos de vacinação contra a Covid-19 em benefício do
+    ex-Presidente da República e de sua filha”, afirma a PF.
+  example_title: Example 2
+- text: >-
+    De acordo com a polícia, parte dos detidos foi identificado como autores de
+    um assalto recente a uma farmácia na região do Morumbi, na zona sul da
+    capital paulista. Todos já tinham passagens por outros crimes. O caso foi
+    registrado na 5ª delegacia da Divisão de Investigações sobre Crimes contra o
+    Patrimônio (DISCCPAT) como roubo e receptação, ambos qualificados, posse
+    ilegal de arma de fogo de uso restrito, associação criminosa e adulteração
+    de sinal veicular identificador.
+  example_title: Example 3
+- text: >-
+    Dois legumes são suficientes para que você sinta o sabor de ambos no prato.
+    Um pode ser mais macio e outro mais firme, como cenoura ou abóbora. Pense em
+    um legume que dará saciedade e outro mais refrescante
+  example_title: Exemple 4
+language:
+- pt
+library_name: transformers
+pipeline_tag: token-classification
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -28,8 +51,50 @@ should probably proofread and complete it, then remove this comment. -->
 
 # ner-portuguese-br-bert-cased
 
-This model aims to meet the needs of models in the Portuguese language. He has various named classes. Follow the list below:
+This model aims to meet the needs of models in the Portuguese language. 
 
+## How to use:
+
+```python
+from transformers import BertForTokenClassification, DistilBertTokenizerFast, pipeline
+
+model = BertForTokenClassification.from_pretrained('rhaymison/ner-portuguese-br-bert-cased')
+tokenizer = DistilBertTokenizerFast.from_pretrained('rhaymison/ner-portuguese-br-bert-cased'
+                                                    , model_max_length=512
+                                                    , do_lower_case=False
+                                                    )
+
+nlp = pipeline('ner', model=model, tokenizer=tokenizer, grouped_entities=True)
+
+result = nlp(f"""
+A passagem de uma frente fria pelo Rio Grande do Sul e Santa Catarina mantém o tempo instável,
+e chove a qualquer hora nos dois estados. Há risco de temporais no sul e leste gaúcho.
+No Paraná segue quente, e pancadas de chuva ocorrem a partir da tarde, também com risco de temporais.
+""")
+
+###output
+
+[{'entity_group': 'LOC',
+  'score': 0.99812114,
+  'word': 'Rio Grande do Sul',
+  'start': 36,
+  'end': 53},
+ {'entity_group': 'LOC',
+  'score': 0.99795854,
+  'word': 'Santa Catarina',
+  'start': 56,
+  'end': 70},
+ {'entity_group': 'LOC',
+  'score': 0.997009,
+  'word': 'Paraná',
+  'start': 186,
+  'end': 192}]
+
+```
+
+
+
+He has various named classes. Follow the list below:
 - `O`: 0
 - `B-ANIM`: 1
 - `B-BIO`: 2
@@ -145,4 +210,4 @@ The following hyperparameters were used during training:
 - Transformers 4.38.2
 - Pytorch 2.2.1+cu121
 - Datasets 2.18.0
-- Tokenizers 0.15.2
+- Tokenizers 0.15.2