Update README.md

README.md

@@ -1,202 +1,127 @@
 ---
-base_model: unsloth/deepscaler-1.5b-preview-unsloth-bnb-4bit
-library_name: peft
+library_name: adapter-transformers
+license: mit
+datasets:
+- FreedomIntelligence/medical-o1-reasoning-SFT
+language:
+- en
 ---
-
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
+# Model Card: Imran1/Med-R1-v1
 
 ## Model Details
+- **Name**: Imran1/Med-R1-v1  
+- **Size**: 1B parameters  
+- **Dataset**: `FreedomIntelligence/medical-o1-reasoning-SFT`  
+- **Max Sequence Length**: 2048 tokens  
+- **Quantization**: Supports 4-bit inference  
 
-### 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]
-
-### 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
-
-
+## Description
+Imran1/Med-R1-v1 is a fine-tuned language model for medical reasoning, trained on structured medical datasets to provide contextually relevant and accurate responses for healthcare-related queries.
 
-## Model Examination [optional]
+## Intended Use
+- **Use Cases**: Medical Q&A, reasoning for diagnoses, and treatment suggestions  
+- **Users**: Healthcare professionals, researchers, and developers  
 
-<!-- Relevant interpretability work for the model goes here -->
+## Example
+```python
+from unsloth import FastLanguageModel
+from transformers import TextStreamer
 
-[More Information Needed]
+model_name = "Imran1/Med-R1-v1" 
+max_seq_length = 2048
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name=model_name,
+    max_seq_length=max_seq_length,
+    dtype=None,
+    load_in_4bit=True,
+)
 
-## Environmental Impact
+FastLanguageModel.for_inference(model)  # Enable native 2x faster inference
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+prompt = "i have pain in my kidney, what should i need to do?"
 
-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).
+messages = [
+    {"role": "system", "content": "You are AI medical assistant."},
+    {"role": "user", "content": prompt}
+]
 
-- **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]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
 
-## Technical Specifications [optional]
+inputs = tokenizer([text], return_tensors="pt").to(model.device)
 
-### Model Architecture and Objective
+text_streamer = TextStreamer(tokenizer)
 
-[More Information Needed]
+generated_ids = model.generate(
+    **inputs,
+    streamer=text_streamer,
+    max_new_tokens=2000
+)
 
-### Compute Infrastructure
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(inputs.input_ids, generated_ids)
+]
 
-[More Information Needed]
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+```
 
-#### Hardware
+## output
+```
+<｜begin▁of▁sentence｜>You are AI medical assistant.<｜User｜>i have pain in my kidney, what should i need to do?<｜Assistant｜><|thinking|> Okay, let's think about this. When we have pain in the kidney, it's definitely something to take seriously. The kidneys are the main filters for blood, so there's definitely a risk of kidney issues.
 
-[More Information Needed]
+First, I should consider what the pain might mean. Could it be a urinary tract infection? That's a big possibility, but it could also be something like a kidney stones or a urinary tract blockage. And what about the rest of the body? Could there be a urinary tract infection or some kind of renal or urinary blockage?
 
-#### Software
+Now, I should think about what to do next. If it's a urinary tract infection, I'd want to go for an emergency treatment. This could mean antibiotics or maybe even surgery if it's severe. But if it's not severe, maybe a simple follow-up with a urinalysis could help.
 
-[More Information Needed]
+If it's not a kidney blockage, but there's pain, it might mean a urinary tract issue, like a kidney stones. In this case, I'd need to go for a urinalysis to see what's going on.
 
-## Citation [optional]
+Also, I should think about other potential issues. Like, could it be something like a renal vein or glomerulonephritis? Those would have different treatment plans.
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+Hmm, let's not forget about the possibility of something like a kidney transplant. If that's the case, it's important to make sure the patient is healthy and there's no other risk to consider.
 
-**BibTeX:**
+So, in the end, the best next step is to check for what's causing the pain. If it's something like a kidney stone, a urinalysis is the way to go. But if it's a urinary tract infection, I'd need to get it treated fast.
 
-[More Information Needed]
+Alright, let's wrap it up. If it's a urinary tract infection, I need to act quickly. If it's a kidney stone, I'll need to do a urinalysis. And just in case, a kidney transplant is something to think about, but only if it seems like the best option given the situation. <|thinking_end|>  
 
-**APA:**
+ <|Final|> When you experience pain in your kidney, it's important to approach the situation with a clear mind and consider the possible causes of the pain. Here's a structured approach to what you should do next:
 
-[More Information Needed]
+1. **Assess the Pain Type**: Determine if the pain is likely due to a urinary tract infection (UTI), a kidney stone, or some other condition. This will guide the treatment approach.
 
-## Glossary [optional]
+2. **If Urethral Infection**: 
+   - If the pain is severe and worsens with exertion, it's likely a urinary tract infection. In this case, you should:
+     - **Conduct a Urinalysis**: This will help identify any stones, infections, or other kidney issues.
+     - **Immediate Treatment**: Depending on the severity, you may need antibiotics, surgery, or more invasive treatment like a kidney transplant if the infection is severe and advanced.
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+3. **If Kidney Stones**:
+   - If pain is noticeable but not severe, it might indicate a kidney stone. In this situation, a urinalysis is recommended to assess the stone's size and shape.
 
-[More Information Needed]
+4. **Other Considerations**:
+   - **Renal Vein**: If the pain is in the urinary tract and there's no clear diagnosis of a kidney stone or infection, consider a renal vein. This may involve a lumbar puncture to check for blood flow and assess the condition.
 
-## More Information [optional]
+5. **Other Potential Conditions**:
+   - **Renal Transplant**: If you suspect renal vein involvement, a renal transplant could be considered, but only if there's no other risk or evidence of another renal issue.
 
-[More Information Needed]
+By following this structured approach, you can manage the pain effectively and take appropriate steps to address the underlying cause. <|Final_end|><｜end▁of▁sentence｜>```
 
-## Model Card Authors [optional]
 
-[More Information Needed]
 
-## Model Card Contact
+## Limitations
+- **Not a substitute for medical advice**: This model provides general reasoning and suggestions but should not replace professional medical consultation.  
+- **Dataset Bias**: The model’s outputs are influenced by the `FreedomIntelligence/medical-o1-reasoning-SFT` dataset and may reflect its limitations.  
+- **Sensitive Use**: Ensure appropriate use in non-critical scenarios and always verify with certified professionals.
 
-[More Information Needed]
-### Framework versions
+## Deployment
+The model supports efficient deployment with 4-bit quantization for inference. It is optimized for use in applications requiring medical reasoning and is compatible with Hugging Face and `unsloth` frameworks.
 
-- PEFT 0.14.0
+## Citation
+If you use this model, please cite:  
+```bibtex
+@model{imran1_med_r1_v1,
+  title={Imran1/Med-R1-v1: A Medical Reasoning Language Model},
+  author={Imran1},
+  year={2025},
+  url={https://huggingface.co/Imran1/Med-R1-v1}
+}