updated readme

README.md

@@ -1,24 +1,12 @@
 ---
-language: en
-tags:
-- phi-2
-- qlora
-- fine-tuning
-- assistant
-- coding
-- writing
-license: mit
-datasets:
-- custom
-model-index:
-- name: phi2-qlora-assistant
-  results:
-  - task: text-generation
-    type: text-generation
-    metrics:
-    - name: accuracy
-      type: accuracy
-      value: N/A
+title: Phi-2 QLoRA Assistant Demo
+emoji: 🤖
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: 4.19.2
+app_file: app.py
+pinned: false
 ---
 
 # Phi-2 QLoRA Fine-tuned Assistant
@@ -32,6 +20,50 @@ This is a fine-tuned version of Microsoft's Phi-2 model using QLoRA (Quantized L
 - **Training Data**: Custom dataset focused on coding, technical explanations, and professional communication
 - **Primary Use Cases**: Code generation, technical writing, and professional communication
 
+## Usage Tips
+
+### For Code Generation (Temperature: 0.3-0.5)
+```python
+# Example prompt:
+"Write a Python function to calculate the factorial of a number and provide additional recursive function examples"
+```
+
+### For Technical Explanations (Temperature: 0.7)
+```text
+# Example prompt:
+"Explain what machine learning is in simple terms and provide some real-world applications"
+```
+
+### For Professional Writing (Temperature: 0.7-0.9)
+```text
+# Example prompt:
+"Write a professional email to schedule a team meeting for next week to discuss project progress"
+```
+
+## Parameters Guide
+
+- **Maximum Length**: 64-1024 (default: 512)
+  - Increase for longer responses
+  - Decrease for quicker, more concise responses
+
+- **Temperature**: 0.1-1.0 (default: 0.7)
+  - 0.3-0.5: Best for code generation
+  - 0.7-0.9: Best for creative writing
+  - 1.0: Maximum creativity
+
+- **Top P**: 0.1-1.0 (default: 0.9)
+  - Controls diversity of word choices
+  - Higher values = more diverse vocabulary
+
+## Model Links
+
+- **Model Card**: [pradeep6kumar2024/phi2-qlora-assistant](https://huggingface.co/pradeep6kumar2024/phi2-qlora-assistant)
+- **Base Model**: [microsoft/phi-2](https://huggingface.co/microsoft/phi-2)
+
+## License
+
+This demo is released under the MIT License.
+
 ## Example Usage
 
 ```python
@@ -67,12 +99,6 @@ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
    "Dear Team,
    I hope this email finds you well. I would like to schedule a team meeting next week to discuss our project progress..."
 
-## Parameters
-
-- **Temperature**: Controls creativity (0.3-0.5 for code, 0.7-0.9 for writing)
-- **Max Length**: Adjustable based on desired response length (64-1024)
-- **Top P**: Controls response diversity (recommended: 0.9)
-
 ## Limitations
 
 - The model works best with clear, well-structured prompts
@@ -83,10 +109,6 @@ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
 
 You can try this model directly in your browser using our Gradio Space: [Phi2-QLoRA-Assistant Demo](https://huggingface.co/spaces/pradeep6kumar2024/phi2-qlora-assistant-demo)
 
-## License
-
-This model is released under the MIT License.
-
 ## Acknowledgments
 
 - Microsoft for the Phi-2 base model