Update README.md

README.md

@@ -3,200 +3,118 @@ library_name: peft
 base_model: recogna-nlp/internlm-chatbode-7b
 ---
 
-# Model Card for Model ID
+# DrBode 360: Assistente Virtual Médico em Português Brasileiro
 
-<!-- Provide a quick summary of what the model is/does. -->
-
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+<p align="center">
+  <img src="https://huggingface.co/recogna-nlp/bode-7b-alpaca-pt-br-gguf/resolve/main/Logo_Bode_LLM_GGUF.jpeg" alt="Bode Logo" width="400" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+</p>
 
-### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+## Visão Geral
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+**DrBode 360k** é um modelo de linguagem de pequeno porte (SLM) ajustado para atuar como um assistente virtual médico em português brasileiro. Este modelo foi criado com o objetivo de fornecer respostas relevantes e confiáveis para perguntas relacionadas à saúde, sendo uma ferramenta útil para profissionais de saúde e pacientes. Ele foi treinado com **360 mil amostras**, combinando dados médicos e de instruções gerais, o que melhora sua capacidade de responder a perguntas tanto em contextos médicos quanto em outros cenários de uso.
 
-## How to Get Started with the Model
 
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
+<!-- Provide a quick summary of what the model is/does. -->
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
 
-### Results
+## Descrição do Modelo
 
-[More Information Needed]
+O **DrBode 360k** é uma versão aprimorada do modelo [ChatBode](https://huggingface.co/recogna-nlp/internlm-chatbode-7b), que, por sua vez, é baseado no [InternLM2](https://huggingface.co/internlm/internlm2-chat-7b). O **DrBode 360** foi ajustado utilizando uma abordagem que combina dados médicos e dados gerais de instruções, permitindo que ele tenha um bom desempenho tanto em perguntas diretamente relacionadas à medicina quanto em questões mais amplas que requerem capacidade de seguir instruções.
 
-#### Summary
+Atributos principais:
 
+- **Modelo Base:** InternLM2, ajustado para seguir instruções em português brasileiro.
+- **Ajuste Fino:** Utiliza uma combinação de dados médicos e de instruções, com 360 mil amostras no total.
+- **Domínio de Foco:** Perguntas sobre saúde, sintomas médicos e recomendações gerais.
+  
+O ajuste fino foi feito com **50% de dados médicos** e **50% de dados de instruções gerais**, permitindo que o modelo mantenha um equilíbrio entre especialização médica e versatilidade em outros domínios.
 
 
-## Model Examination [optional]
 
-<!-- Relevant interpretability work for the model goes here -->
+## Dados de Treinamento
 
-[More Information Needed]
+O **DrBode 360** foi treinado com uma combinação de dois principais conjuntos de dados traduzidos para o português:
 
-## Environmental Impact
+- **HealthCareMagic-100k-en:** Um conjunto de 100.000 amostras de interações médico-paciente, traduzidas do inglês para o português utilizando o modelo GPT-3.5.
+- **MedQuAD:** Contém aproximadamente 9.500 pares de perguntas e respostas relacionados à área médica, também traduzidos.
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+Esses conjuntos de dados fornecem uma base sólida para o modelo responder a perguntas clínicas comuns, mas ainda há a necessidade de dados nativos que abordem condições e nuances culturais específicas do Brasil, como doenças endêmicas.
 
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
+Além disso, o **DrBode 360** utilizou dados adicionais de instruções gerais para melhorar sua capacidade de seguir comandos e responder adequadamente em cenários que vão além do domínio médico.
 
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+<!-- Provide a longer summary of what this model is. -->
 
-## Technical Specifications [optional]
+## Desempenho do Modelo
 
-### Model Architecture and Objective
+O desempenho do **DrBode 360** foi avaliado com base em seis critérios principais:
 
-[More Information Needed]
+- **Precisão:** 3.6/5
+- **Completude:** 3.3/5
+- **Adequação:** 3.3/5
+- **Segurança:** 3.3/5
+- **Gramaticalidade:** 4.2/5
+- **Coerência:** 4.2/5
+- 
+O **DrBode 360** se destacou na capacidade de fornecer respostas gramaticalmente corretas e coerentes, o que é fundamental para garantir a clareza na comunicação. No entanto, a segurança das respostas médicas e a precisão ainda precisam de aprimoramentos, especialmente em contextos críticos onde recomendações médicas inadequadas podem ser feitas.
 
-### Compute Infrastructure
+## Avaliação Qualitativa
 
-[More Information Needed]
+As respostas geradas pelo **DrBode 360** foram avaliadas por profissionais médicos, que julgaram a qualidade das respostas com base nos seguintes critérios:
 
-#### Hardware
+- **Precisão e segurança** das informações fornecidas.
+- **Completude**, considerando a profundidade das respostas.
+- **Adequação** em termos de estilo e tom, apropriados para uma resposta médica.
 
-[More Information Needed]
+**ATENÇÃO** 
 
-#### Software
+Embora o **DrBode 360** tenha mostrado bom desempenho em muitos aspectos, foi identificado que o modelo pode, ocasionalmente, sugerir tratamentos que não são ideais, especialmente para condições regionais específicas, como o uso inadequado de medicamentos para sintomas de dengue. Isso demonstra a necessidade de melhorias nos dados de treinamento para lidar melhor com esses casos.
 
-[More Information Needed]
+## Riscos e Considerações
 
-## Citation [optional]
+O uso do **DrBode 360** deve ser feito com cautela, especialmente em contextos onde as respostas fornecidas podem ter implicações diretas na saúde dos usuários. Embora o modelo seja útil como assistente informativo, ele não deve substituir a consulta com profissionais de saúde qualificados.
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+Além disso, devido ao treinamento com dados traduzidos, algumas nuances regionais e culturais podem ser perdidas, o que pode levar a respostas inadequadas para condições médicas específicas do Brasil.
 
-**BibTeX:**
 
-[More Information Needed]
+## Direções futuras
 
-**APA:**
+- **Conjuntos de dados nativos:** há uma necessidade urgente de desenvolver conjuntos de dados nativos em português brasileiro para refletir melhor os desafios regionais de saúde.
+- **Ajuste fino aprimorado:** o trabalho futuro envolverá o ajuste fino diretamente no InternLM2 com conjuntos de dados otimizados para mitigar os efeitos do esquecimento catastrófico.
+- **Avaliação robusta:** estruturas de avaliação mais estruturadas e consistentes são necessárias para avaliar melhor a qualidade e a segurança das respostas do modelo em cenários do mundo real.
 
-[More Information Needed]
 
-## Glossary [optional]
+## Como Usar
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+Aqui está um exemplo de como usar o modelo **DrBode 360:**
 
-[More Information Needed]
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-## More Information [optional]
+tokenizer = AutoTokenizer.from_pretrained("drbode-360")
+model = AutoModelForCausalLM.from_pretrained("drbode-360")
 
-[More Information Needed]
+input_text = "Quais são os sintomas da dengue?"
+inputs = tokenizer(input_text, return_tensors="pt")
+outputs = model.generate(**inputs)
 
-## Model Card Authors [optional]
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
 
-[More Information Needed]
+## Referência
 
-## Model Card Contact
+Se você utilizar o **DrBode 360** em sua pesquisa ou aplicativo, por favor, cite o seguinte trabalho:
 
-[More Information Needed]
-### Framework versions
+```
+@misc{paiola2024adaptingllmsmedicaldomain,
+      title={Adapting LLMs for the Medical Domain in Portuguese: A Study on Fine-Tuning and Model Evaluation}, 
+      author={Pedro Henrique Paiola and Gabriel Lino Garcia and João Renato Ribeiro Manesco and Mateus Roder and Douglas Rodrigues and João Paulo Papa},
+      year={2024},
+      eprint={2410.00163},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2410.00163}, 
+}
+```
 
-- PEFT 0.10.0