Update README.md

README.md

@@ -11,25 +11,35 @@ model-index:
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
 should probably proofread and complete it, then remove this comment. -->
 
-# finetune-BERT-squad
+# bert-squad-portuguese
 
-This model is a fine-tuned version of [neuralmind/bert-base-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 1.0687
-
-## Model description
+This model aims to help reduce the need for models in Portuguese.
 
-More information needed
+## How to use:
 
-## Intended uses & limitations
+```python
+from transformers import AutoModelForQuestionAnswering, AutoTokenizer, pipeline
 
-More information needed
+model_name = "rhaymison/bert-squad-portuguese"
 
-## Training and evaluation data
+# a) Get predictions
+nlp = pipeline('question-answering', model=model_name, tokenizer=model_name)
+QA_input = {
+    'question': 'Onde Cristiano Ronaldo começou sua carreira ?',
+    'context': 'Cristiano Ronaldo é jogador de futebol considerado por muitos um dos melhores de todos os tempos. Português, começou a carreira no Sporting e já atuou por Manchester United, Real Madrid, Juventus e Al-Nassr. Foi cinco vezes campeão da Liga dos Campeões da Europa. Também foi campeão da Eurocopa com Portugal no que é considerado o maior título já conquistado pela equipe portuguesa. Disputou cinco Copas do Mundo. Atualmente, é o atleta com mais gols marcados por seleções nacionais.'
+}
+res = nlp(QA_input)
+```
 
-More information needed
+If you need load model and tokenizer
+```python
+model = AutoModelForQuestionAnswering.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+```
 
-## Training procedure
+This model is a fine-tuned version of [neuralmind/bert-base-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased) on an unknown dataset.
+It achieves the following results on the evaluation set:
+- Loss: 1.0687
 
 ### Training hyperparameters
 
@@ -42,6 +52,8 @@ The following hyperparameters were used during training:
 - lr_scheduler_type: linear
 - num_epochs: 2
 
+GPU: T4
+
 ### Training results
 
 | Training Loss | Epoch | Step  | Validation Loss |