Update README.md

README.md

@@ -9,8 +9,6 @@ tags: []
 
 
 
-## Model Details
-
 ### Model Description
 
 <!-- Provide a longer summary of what this model is. -->
@@ -22,12 +20,6 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 - **Model type:** Fine-tune-DeepSeek-R1-Distill-Llama-8B
 - **License:** MIT License
 
-### Model Sources [optional]
-
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
@@ -48,39 +40,53 @@ This model is designed for **customer support automation in the telecom industry
 - **Developers & data scientists** fine-tuning and deploying 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]
+## How to Get Started with the Model
 
-### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+import torch
+from unsloth import FastLanguageModel
+from transformers import AutoTokenizer
 
-[More Information Needed]
+# Load model and tokenizer
+model_path = "moo100/DeepSeek-R1-telecom-chatbot"
+model, tokenizer = FastLanguageModel.from_pretrained(model_path, max_seq_length=1024, dtype=None)
 
-## Bias, Risks, and Limitations
+# Optimize for fast inference
+model = FastLanguageModel.for_inference(model)
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+# Move model to GPU if available
+device = "cuda" if torch.cuda.is_available() else "cpu"
+model.to(device)
 
-[More Information Needed]
+# Define system instruction for guided response
+system_instruction = """You are an AI assistant. Answer user questions concisely and factually.
+Do NOT role-play as a customer service agent. Only answer the user's query."""
 
-### Recommendations
+# Define user input
+user_input = "What are the benefits of 5G?"
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+# Construct full prompt
+full_prompt = f"{system_instruction}\n\nUser: {user_input}\nAssistant:"
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+# Tokenize input
+inputs = tokenizer(full_prompt, return_tensors="pt").to(device)
 
-## How to Get Started with the Model
+# Generate response
+outputs = model.generate(
+    input_ids=inputs.input_ids,
+    attention_mask=inputs.attention_mask,
+    max_new_tokens=100,  
+    do_sample=True,  
+    temperature=0.5,  
+    top_k=50,
+    eos_token_id=tokenizer.eos_token_id,  
+)
 
-Use the code below to get started with the model.
+# Decode and print response
+response = tokenizer.decode(outputs[0][inputs.input_ids.shape[-1]:], skip_special_tokens=True)
+print(response.strip())
 
-[More Information Needed]
 
 ## Training Details
 
@@ -88,26 +94,20 @@ Use the code below to get started with the model.
 
 <!-- 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]
+- **Loss Curve:** Shows a steady decline, indicating model convergence.
+- **Learning Rate Schedule:** Linear decay applied.
+- **Gradient Norm:** Slight increase, but under control.
+- **Global Steps & Epochs:** Indicates training progress.
 
-[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]
+  Below are the training metrics recorded during fine-tuning:
+  https://drive.google.com/file/d/1-SOfG8K3Qt2WSEuyj3kFhGYOYMB5Gk2r/view?usp=sharing
+  
 
 ## Evaluation
 
@@ -141,68 +141,4 @@ Use the code below to get started with the model.
 
 
 
-## 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]