Update README.md

README.md

@@ -18,4 +18,75 @@ datasets:
 
 <hr>
 
-# Canarim-7B-Instruct
+# Canarim-7B-Instruct
+
+Canarim-7B-Instruct é um modelo de linguagem de 7 bilhões de parâmetros inicializado a partir do modelo [Canarim-7B](https://huggingface.co/dominguesm/canarim-7b) e treinado em uma variedade de conjuntos de dados de instruções disponíveis publicamente.
+
+## Usage
+
+```python
+from transformers import AutoTokenizer, pipeline
+import torch
+
+model_id = "dominguesm/canarim-7b-vestibulaide"
+
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+pipe = pipeline(
+    "text-generation",
+    model=model_id,
+    torch_dtype=torch.float16,
+    device_map="auto",
+)
+
+
+def make_prompt(instruction, input=None):
+    if input:
+        return f"""Abaixo está uma instrução que descreve uma tarefa, emparelhada com uma entrada que fornece mais contexto. Escreva uma resposta que conclua adequadamente a solicitação.
+
+### Instruções:
+{instruction}
+
+### Entrada:
+{input}
+
+### Resposta:"""
+    else:
+        return f"""Abaixo está uma instrução que descreve uma tarefa. Escreva uma resposta que conclua adequadamente a solicitação.
+
+### Instruções:
+{instruction}
+
+### Resposta:"""
+
+instruction = "Faça um resumo conciso do seguinte texto."
+context = """
+No início da obra, o narrador Bentinho explica como escolheu o título para o seu livro. Assim, ele conta que conheceu um poeta em uma viagem de trem. O jovem recitou alguns versos, mas Bentinho, já velho, fechou os olhos algumas vezes. O poeta, então, achou que ele estava cochilando e, ofendido, lhe chamou de Dom Casmurro.
+
+Em seguida, o narrador inicia a narrativa de suas memórias, que começa quando ele tem 15 anos. Nessa época, Capitu, uma jovem de 14 anos, é sua vizinha. Os adolescentes têm uma forte amizade, o que incomoda o agregado da família, o amante de superlativos José Dias.
+
+Desconfiado da relação entre os jovens, ele sugere à D. Glória, mãe de Bentinho, que já é hora de enviar o rapaz para o seminário. Isso porque, quando o menino nasceu, sua mãe fez uma promessa de que ele seria padre. Dessa forma, se apresenta um obstáculo ao amor do jovem casal, o que, enganosamente, faz parecer que o livro é um romance romântico.
+"""
+
+prompt = make_prompt(question)
+
+sequences = pipe(
+   prompt,
+   do_sample=True,
+   num_return_sequences=1,
+   eos_token_id=tokenizer.eos_token_id,
+   max_length=2048,
+   temperature=0.9,
+   top_p=0.6,
+   repetition_penalty=1.15
+)
+```
+
+### Model Result
+
+```
+O trabalho retrata as memórias de Bentinho, um jovem de 15 anos. Ele conta 
+sobre sua infância na casa de seus pais, onde vive com sua mãe, a dona 
+Glória, e sua governanta, a governanta Josefa. No entanto, no outono de 
+1860, sua vida mudará drasticamente. Durante essa temporada, ele conhece 
+Capitu, uma moça de 14 anos, que se tornará sua companheira por muitos anos.
+```