Create README.md

README.md

@@ -1,201 +1,126 @@
 ---
-library_name: transformers
-tags: []
+language: en
+license: apache-2.0
+tags:
+- text-generation-inference
+- transformers
+- ruslanmv
+- llama
+- trl
+base_model: meta-llama/Meta-Llama-3-8B
+datasets:
+- ruslanmv/ai-medical-chatbot
 ---
 
-# Model Card for Model ID
+# Medical-Llama3-8B-4bit: Fine-Tuned Llama3 for Medical Q&A
+[![](future.jpg)](https://ruslanmv.com/)
 
-<!-- Provide a quick summary of what the model is/does. -->
 
+Medical fine tuned version of LLAMA-3-8B quantized in 4 bits using common open source datasets and showing improvements over multilingual tasks. It has been used the standard bitquantized technique for post-fine-tuning quantization reducing the computational time complexity and space complexity required to run the model. The overall architecture it's all LLAMA-3 based.
 
 
-## Model Details
+This repository provides a fine-tuned version of the powerful Llama3 8B model, specifically designed to answer medical questions in an informative way. It leverages the rich knowledge contained in the AI Medical Chatbot dataset ([ruslanmv/ai-medical-chatbot](https://huggingface.co/datasets/ruslanmv/ai-medical-chatbot)).
 
-### Model Description
+**Model & Development**
 
-<!-- Provide a longer summary of what this model is. -->
+- **Developed by:** ruslanmv
+- **License:** Apache-2.0
+- **Finetuned from model:** meta-llama/Meta-Llama-3-8B
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+**Key Features**
 
-- **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]
+- **Medical Focus:** Optimized to address health-related inquiries.
+- **Knowledge Base:** Trained on a comprehensive medical chatbot dataset.
+- **Text Generation:** Generates informative and potentially helpful responses.
 
-### Model Sources [optional]
+**Installation**
 
-<!-- Provide the basic links for the model. -->
+This model is accessible through the Hugging Face Transformers library. Install it using pip:
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+```bash
+pip install transformers bitsandbytes
+```
 
-## Uses
+**Usage Example**
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+Here's a Python code snippet demonstrating how to interact with the `Medical-Llama3-8B-16bit` model and generate answers to your medical questions:
 
-### Direct Use
+```python
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
+import torch
 
-[More Information Needed]
+# Load tokenizer and model
+model_id = "ruslanmv/llama3-8B-medical"
 
-### Downstream Use [optional]
+quantization_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_compute_dtype=torch.bfloat16
+)
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+device = torch.device("cuda:0" if torch.cuda.is_available() else "cpu")
 
-[More Information Needed]
+model = AutoModelForCausalLM.from_pretrained(model_id, config=quantization_config)
 
-### Out-of-Scope Use
+def create_prompt(user_query):
+  B_INST, E_INST = "<s>[INST]", "[/INST]"
+  B_SYS, E_SYS = "<<SYS>>\n", "\n<</SYS>>\n\n"
+  DEFAULT_SYSTEM_PROMPT = """\
+  You are an AI Medical Chatbot Assistant, provide comprehensive and informative responses to your inquiries.
+  If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information."""
+  SYSTEM_PROMPT = B_SYS + DEFAULT_SYSTEM_PROMPT + E_SYS
+  instruction = f"User asks: {user_query}\n"
+  prompt = B_INST + SYSTEM_PROMPT + instruction + E_INST
+  return prompt.strip()
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+def generate_text(model, tokenizer, prompt,
+                  max_length=200,
+                  temperature=0.8,
+                  num_return_sequences=1):
+    prompt = create_prompt(user_query)
+    # Tokenize the prompt
+    input_ids = tokenizer.encode(prompt, return_tensors="pt").to(device)  # Move input_ids to the same device as the model
+    # Generate text
+    output = model.generate(
+        input_ids=input_ids,
+        max_length=max_length,
+        temperature=temperature,
+        num_return_sequences=num_return_sequences,
+        pad_token_id=tokenizer.eos_token_id,  # Set pad token to end of sequence token
+        do_sample=True
+    )    
+    # Decode the generated output
+    generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
+  
+   # Split the generated text based on the prompt and take the portion after it
+    generated_text = generated_text.split(prompt)[-1].strip()
 
-[More Information Needed]
+    return generated_text
+# Example usage
+# - Context: First describe your problem.
+# - Question: Then make the question.
+user_query = "I'm a 35-year-old male experiencing symptoms like fatigue, increased sensitivity to cold, and dry, itchy skin. Could these be indicative of hypothyroidism?"
+generated_text = generate_text(model, tokenizer, user_query)    
+print(generated_text)
+```
+the type of answer is :
+```
+Yes, it is possible. Hypothyroidism can present symptoms like increased sensitivity to cold, dry skin, and fatigue. These symptoms are characteristic of hypothyroidism. I recommend consulting with a healthcare provider. 2. Hypothyroidism can present symptoms like fever, increased sensitivity to cold, dry skin, and fatigue. These symptoms are characteristic of hypothyroidism. 
+```
+**Important Note**
 
-## Bias, Risks, and Limitations
+This model is intended for informational purposes only and should not be used as a substitute for professional medical advice. Always consult with a qualified healthcare provider for any medical concerns.
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+**License**
 
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## 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
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **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]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+This model is distributed under the Apache License 2.0 (see LICENSE file for details).
 
+**Contributing**
 
+We welcome contributions to this repository! If you have improvements or suggestions, feel free to create a pull request.
+
+**Disclaimer**
+
+While we strive to provide informative responses, the accuracy of the model's outputs cannot be guaranteed. It is crucial to consult a doctor or other healthcare professional for definitive medical advice.
+```