create readme.md

README.md

@@ -0,0 +1,43 @@
+---
+language: pt
+thumbnail: null
+tags:
+- question-answering
+- bert
+widget:
+- text: Qual é a área de Portugal?
+  context: >-
+    Portugal, oficialmente República Portuguesa,[7][h] é um país soberano[i]
+    unitário localizado no sudoeste da Europa, cujo território se situa na zona
+    ocidental da Península Ibérica e em arquipélagos no Atlântico Norte. O
+    território português tem uma área total de 92 090 km²,[8] sendo delimitado a
+    norte e leste por Espanha e a sul e oeste pelo oceano Atlântico,
+    compreendendo uma parte continental e duas regiões autónomas: os
+    arquipélagos dos Açores e da Madeira. Portugal é a nação mais a ocidente do
+    continente europeu. O nome do país provém da sua segunda maior cidade,
+    Porto, cujo nome latino-celta era Portus Cale
+---
+
+## MODEL DESCRIPTION
+
+Portugal BERT base model (cased) fine-tuned on SQuAD v1 Portugal version.
+
+## Model in action
+
+- Fast usage with pipelines:
+
+```python
+from transformers import pipeline
+qa_pipeline = pipeline(
+    "question-answering",
+    model="isel-nlp-mp05/bert-base-portuguese-cased-finetuned-squadv1-pt",
+    tokenizer="isel-nlp-mp05/bert-base-portuguese-cased-finetuned-squadv1-pt"
+)
+predictions = qa_pipeline({
+    'context': "Chamo-me Mattheo e estou a estudar em Lisboa.",
+    'question': "Onde é que o Mattheo está a estudar?"
+})
+print(predictions)
+# output:
+# {'score': 0.967152, 'start': 38, 'end': 44, 'answer': 'Lisboa'}
+```