Create README.md

README.md

@@ -0,0 +1,100 @@
+---
+license: afl-3.0
+datasets:
+- ju-resplande/rebel-pt
+- paulofinardi/OIG_small_chip2_portuguese_brasil
+- Guilherme34/Cabrita-lora-ptbr
+- dominguesm/Canarim-Instruct-PTBR-Dataset
+language:
+- pt
+- en
+pipeline_tag: text-generation
+library_name: transformers
+widget:
+- text: |
+    Pergunta: Quantos planetas existem no sistema solar?
+tags:
+- llama
+- peft
+- portuguese
+---
+# Boana-7B
+
+<p align="center">
+  <img width="250" alt="Boana Logo" src="https://cdn-uploads.huggingface.co/production/uploads/658c21f4c1229bf113295773/BE5877BjlswYK3Ue1FiOK.png">
+</p>
+
+Boana-7B is an LLM trained on portuguese language data. The model is based on [LLaMA2-7B](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf), a 7B parameter version of LLaMA-2. The LLM Boana project aims to provide more LLM options in portuguese, while also providing less complex models so that users with less computational power can take advantage of the LLMs.
+
+In support of portuguese-speaking countries: Angola, Brasil, Cabo Verde, Guinea-Bissau, Equatorial Guinea, Mozambique, Portugal, São Tomé e Príncipe and Timor-Leste. 
+
+<p align="center">
+  <img width="250" alt="Countries Logo" src="https://cdn-uploads.huggingface.co/production/uploads/658c21f4c1229bf113295773/d3twZrXng5eDjg_LbH4pF.png">
+</p>
+
+## Future Updates
+
+- Add more data from the portuguese language.
+
+### Model Description
+
+- **Developed by:** [Leonardo Souza](https://huggingface.co/lrds-code)
+- **Model type:** LLaMA-Based
+- **License:** Academic Free License v3.0
+- **Finetuned from model:** [LLaMA2-7B](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)
+
+## Prompt Style
+
+We used the same prompt used in the fine-tune of the [Cabrita](https://huggingface.co/22h/cabrita-lora-v0-1) model. You can find out more in the official repository on [GitHub](https://github.com/22-hours/cabrita/blob/main/notebooks/train_lora.ipynb).
+
+## How to Use
+
+```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 # 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')
+
+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:
+# We observed that in some input cases the model began to repeat words excessively in its output.
+# This parameter is used to try to reduce this behavior.
+# Setting a very high value for this parameter can cause the model to search excessively for new words and, therefore, may use English words in the output.
+
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+
+
+## Pergunta: Como desenvolver habilidades de programação em python?
+## Resposta: 1. Crie um projeto simples: Comece criando um projeto simples, como um programa que lê um arquivo .txt e exibe os dados.
+##           2. Estudar o código: Estudar o código do projeto que você criou anteriormente.
+##           3. Revisar o código: Revisar o código para verificar se ele está correto e se está funcionando corretamente.
+##           4. Testar o código: Testar o código para verificar se ele está funcionando corretamente.
+##           5. Modificar o código: Modificar o código para corrigir problemas ou adicionar novos recursos.
+##           6. Documentar o código: Documentar o código para que outros desenvolvedores possam ler e usar o código.
+##           7. Depurar o código: Depurar o código para verificar se ele está funcionando corretamente.
+##           8. Fazer testes de integração: Fazer testes de integração para verificar se o código funciona corretamente com outros programas.
+##           9. Fazer testes de desempenho: Fazer testes de desempenho para verificar se o código funciona corretamente em diferentes sistemas e configurações.
+##           10. Fazer testes de segurança: Fazer testes de segurança para verificar se o código é seguro e não pode ser usado para invasão de segurança.
+
+```