Update README.md

README.md

@@ -18,6 +18,98 @@ tags:
 - peft
 - portuguese
 ---
+
+<hr>
+
+# PT - README
+
+<hr>
+
+# Boana-7B
+
+<p align="center">
+  <img width="250" alt="Boana Logo" src="https://cdn-uploads.huggingface.co/production/uploads/658c21f4c1229bf113295773/_Dc6z1IAL-zUiy0LMSSqf.png">
+</p>
+
+Boana-7B é um LLM treinado em dados da língua portuguesa. O modelo é baseado no [LLaMA2-7B](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf), uma versão de 7B de parâmetros do LLaMA-2. O projeto Boana tem como objetivo oferecer opções de LLM em língua portuguesa, ao mesmo tempo que disponibiliza um modelo menos complexo para que, dessa forma, usuários com menos poder computacional possam usufruir das LLMs.
+
+Em apoio aos países de língua portuguesa: Angola, Brasil, Cabo Verde, Guiné Bissau, Guiné Equatorial, Moçambique, Portugal, São Tomé e Príncipe e Timor-Leste. 
+
+<p align="center">
+  <img width="250" alt="Countries Logo" src="https://cdn-uploads.huggingface.co/production/uploads/658c21f4c1229bf113295773/d3twZrXng5eDjg_LbH4pF.png">
+</p>
+
+### Descrição do Modelo
+
+- **Desenvolvido por:** [Leonardo Souza](https://huggingface.co/lrds-code)
+- **Tipo do modelo:** LLaMA-Based
+- **Licença:** Academic Free License v3.0
+- **Fine-tunado do modelo:** [LLaMA2-7B](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)
+
+## Estilo do Prompt
+
+Usamos o mesmo prompt usado no fine-tune do modelo [Cabrita](https://huggingface.co/22h/cabrita-lora-v0-1). Você pode saber mais no repositório oficial no [GitHub](https://github.com/22-hours/cabrita/blob/main/notebooks/train_lora.ipynb).
+
+## Como Usar
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, GenerationConfig
+
+def GeneratePrompt(input, instruction):
+    if input!='' and instruction!=0:
+        return f'''Abaixo está uma instrução que descreve uma tarefa, juntamente com uma entrada que fornece mais contexto. Escreva uma resposta que complete adequadamente o pedido.
+                   ### Instrução:
+                   {instruction}
+                   ### Entrada:
+                   {input}'''
+    else:
+        return f'''Abaixo está uma instrução que descreve uma tarefa. Escreva uma resposta que complete adequadamente o pedido.
+                   ### Instrução:
+                   {instruction}
+                   ### '''
+
+model_config = GenerationConfig.from_model_config(model.generation_config)
+model.generation_config.temperature = 0.9 # Você pode variar esse valor entre 0 e 1.
+
+model = AutoModelForCausalLM.from_pretrained('lrds-code/boana-7b')
+tokenizer = AutoTokenizer.from_pretrained('lrds-code/boana-7b')
+
+instruction = 'Como desenvolver habilidades de programação em python?'
+text = GeneratePrompt(input='', instruction=instruction)
+inputs = tokenizer(text, return_tensors='pt')
+outputs = model.generate(input_ids=inputs['input_ids'], attention_mask=inputs['attention_mask'], generation_config=model_config, repetition_penalty=1.1)
+
+# repetition_penalty:
+# Observamos que em alguns casos de entrada o modelo repetiu excessivamente algumas palavras.
+# Esse parâmetro é usado para tentar reduzir esse comportamento.
+# Atribuir um valor muito alto para esse parâmetro pode fazer com que o modelo busque excessivamente por outras palavras e, sendo assim, talvez usar palavras da língua inglesa na saída.
+
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+
+## Abaixo está uma instrução que descreve uma tarefa. Escreva uma resposta que complete adequadamente o pedido.
+##                 ### Instrução:
+##                 Como desenvolver habilidades de programação em python?
+##                 ### Resposta:
+##                 Aqui estão algumas dicas para aprender Python:
+##                 1. Comece com os fundamentos. Aprenda as principais palavras-chave e conceitos básicos, como variáveis, tipos de dados, funções, módulos, etc.
+##                 2. Pratique com exercícios. Experimentar com diferentes tipos de problemas pode ajudá-lo a entender melhor o idioma.
+##                 3. Leia documentação. Aprenda sobre as funcionalidades específicas do Python e como elas são usadas.
+##                 4. Use recursos on-line. Há muitos recursos disponíveis online que podem ajudá-lo a aprender Python, como cursos, tutoriales, livros, etc.
+##                 5. Participe de comunidades. Encontre um grupo de pessoas que compartilham seus interesses e se conectem com eles.
+##                 6. Faça perguntas. Se você tiver alguma dúvida ou precisar de ajuda, não hesite em perguntar.
+##                 7. Aprenda com outros. Aprenda com outros programadores e compartilhe suas próprias ideias.
+##                 8. Desenvolva projetos. Crie algo que possa ser útil para você ou para outras pessoas.
+##                 9. Lembre-se de que aprender é um processo contínuo. Não se esqueça de continuar praticando e aprendendo novas coisas.
+##                 10. Certifique-se de ter paciência. Aprender um idioma é um processo lento e exigente, mas valerá a pena.
+```
+
+<hr>
+
+# EN - README
+
+<hr>
+
+
 # Boana-7B
 
 <p align="center">
@@ -67,7 +159,6 @@ def GeneratePrompt(input, instruction):
 
 model_config = GenerationConfig.from_model_config(model.generation_config)
 model.generation_config.temperature = 0.9 # You can vary this value between 0 and 1.
-                                          # We observed that, with very low values, the model tends to use English and Portuguese in the response.
 
 model = AutoModelForCausalLM.from_pretrained('lrds-code/boana-7b')
 tokenizer = AutoTokenizer.from_pretrained('lrds-code/boana-7b')