Update README.md

README.md

@@ -27,10 +27,41 @@ from transformers import AutoTokenizer, AutoModelForCausalLM, pipeline
 checkpoint = "automaise/quokka-7b"
 
 tokenizer = AutoTokenizer.from_pretrained(checkpoint)
-model = AutoModelForCausalLM.from_pretrained(checkpoint)
+model = AutoModelForCausalLM.from_pretrained(checkpoint, device_map="auto")
 
 generator = pipeline("text-generation", model=model, tokenizer=tokenizer, device=0)
-generator("<human>Olá, consegues ajudar-me?<bot>")
+```
+
+Follows some examples of the capabilities of our model:
+
+#### Text summarization
+```python
+prompt = "Quero que ajas como um sumarizador de texto e me ajudes a criar um sumário conciso do seguinte texto apresentado, realçando apenas os pontos essenciais do texto original: Rabo de Peixe, internacionalmente conhecida como Turn of the Tide, foi criada por Augusto Fraga e Patrícia Cerqueira; e produzida para a Netflix pela Ukbar Filmes. A história é protagonizada por um grupo de amigos numa freguesia da ilha de São Miguel e foi inspirada no surgimento, em 2001, de toneladas de cocaína na costa açoriana após ter sido largada no Oceano Atlântico por traficantes. \"Quando um barco carregado de cocaína naufraga na sua ilha natal, Eduardo vê uma oportunidade arriscada, mas empolgante, de ganhar dinheiro e realizar sonhos impossíveis\", diz a sinopse apresentada pela Netflix."
+
+generator(f"<human>{prompt}<bot>")
+
+>> Turn of the Tide é uma série de televisão portuguesa criada por Augusto Fraga e Patrícia Cerqueira para a Netflix. A história é ambientada em uma freguesia da ilha de São Miguel e segue um grupo de amigos que se envolvem em um mistério envolvendo a cocaína que foi largada no Oceano Atlântico em 2001. A série é inspirada em um evento real que ocorreu na costa açoriana.
+```
+
+#### Question answering
+
+
+```python
+prompt = "Lê o seguinte texto: Rabo de Peixe, internacionalmente conhecida como Turn of the Tide, foi criada por Augusto Fraga e Patrícia Cerqueira; e produzida para a Netflix pela Ukbar Filmes. A história é protagonizada por um grupo de amigos numa freguesia da ilha de São Miguel e foi inspirada no surgimento, em 2001, de toneladas de cocaína na costa açoriana após ter sido largada no Oceano Atlântico por traficantes. \"Quando um barco carregado de cocaína naufraga na sua ilha natal, Eduardo vê uma oportunidade arriscada, mas empolgante, de ganhar dinheiro e realizar sonhos impossíveis\", diz a sinopse apresentada pela Netflix. \n\n Onde foi filmada a série Rabo de Peixe?"
+
+generator(f"<human>{prompt}<bot>")
+
+>> A série Rabo de Peixe foi filmada na ilha de São Miguel, nos Açores.
+```
+
+#### Generate synthetic data
+
+```python
+prompt = "Gera uma frase semelhante à seguinte frase: Bom dia, em que posso ser útil?"
+
+generator(f"<human>{prompt}<bot>")
+
+>> Bom dia, como posso ajudá-lo?
 ```
 
 ### Limitations and bias
@@ -42,11 +73,21 @@ and specific instructions.
 It is fundamental to be aware of these limitations and exercise caution when using the model for human-facing interactions.
 This bias will also impact all subsequent fine-tuned versions of this model. 
 
+We did notice that the model avoids answering questions of religious or political nature:
+
+````python
+prompt = "Que partido político é que apoias?"
+
+generator(f"<human>{prompt}<bot>")
+
+>> Como uma IA, não tenho preferências políticas.
+````
+
 ## Training data
 
 QUOKKA was fine-tuned on a dataset collected from different sources:
 
-* Initially, we used the **[Bactrain-X](https://huggingface.co/datasets/MBZUAI/Bactrian-X)** dataset, which involves the 
+* Initially, we used the **[Bactrian-X](https://huggingface.co/datasets/MBZUAI/Bactrian-X)** dataset, which involves the 
 translation of 67k English instructions (52k from Alpaca and 15k from Dolly v2) into 51 languages using Google Translate API. 
 For our intended purposes, we exclusively selected the Portuguese subset and focused on the samples pertaining to Dolly v2.