Update README.md

README.md

@@ -1,199 +1,223 @@
 ---
 library_name: transformers
-tags: []
+datasets:
+- HeshamHaroon/saudi-dialect-conversations
+base_model:
+- LiquidAI/LFM2.5-1.2B-Instruct
 ---
 
-# Model Card for Model ID
+# Saudi Dialect LFM2.5 — Instruction-Tuned Arabic Dialect Model
 
-<!-- Provide a quick summary of what the model is/does. -->
+## Model Description
 
+This model is a fine-tuned version of **Liquid AI**’s **LFM2.5‑1.2B‑Instruct**, adapted for Saudi dialect conversational generation.
 
+The base model belongs to the LFM2.5 family — hybrid state-space + attention language models designed for **fast on-device inference**, low memory usage, and strong performance relative to size. It contains ~1.17B parameters, 32k context length, and supports multilingual generation including Arabic. ([Hugging Face][1])
 
-## Model Details
+This fine-tuned variant specializes the model for **Saudi dialect conversational patterns**, improving fluency, dialect authenticity, and instruction following for regional Arabic use cases.
 
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **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
+## Intended Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+### Primary Use Cases
 
-[More Information Needed]
+* Saudi dialect chatbots
+* Customer support assistants
+* Conversational agents
+* Arabic NLP research
+* Dialect-aware RAG pipelines
+* Dialogue generation systems
 
-### Downstream Use [optional]
+### Out-of-Scope Uses
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+* Legal/medical advice
+* Safety-critical decision making
+* High-precision knowledge tasks without retrieval
+* Sensitive content generation
 
-[More Information Needed]
+---
 
-### Out-of-Scope Use
+## Training Details
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+### Base Model
 
-[More Information Needed]
+* Architecture: Hybrid state-space + attention
+* Parameters: ~1.17B
+* Context length: 32,768 tokens
+* Training tokens: ~28T
+* Languages: Multilingual including Arabic ([Hugging Face][1])
 
-## Bias, Risks, and Limitations
+---
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+### Dataset
 
-[More Information Needed]
+Fine-tuned on:
 
-### Recommendations
+**Dataset:**
+`HeshamHaroon/saudi-dialect-conversations`
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+**Domain:**
+Conversational dialogue
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+**Language:**
+Saudi dialect Arabic
 
-## How to Get Started with the Model
+**Format:**
+Instruction → Response pairs
 
-Use the code below to get started with the model.
+**Purpose:**
+Increase dialect authenticity and conversational naturalness.
 
-[More Information Needed]
+---
 
-## Training Details
+### Training Configuration
 
-### Training Data
+(Extracted from training notebook)
 
-<!-- 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. -->
+| Parameter             | Value                        |
+| --------------------- | ---------------------------- |
+| Epochs                | 4                            |
+| Learning Rate         | 2e-4                         |
+| Batch Size            | 16                            |
+| Gradient Accumulation | 4                            |
+| Optimizer             | AdamW                        |
+| LR Scheduler          | Linear                       |
+| Warmup Ratio          | 0.03                         |
+| Sequence Length       | 8096                         |
+| Precision             | FP16                         |
+| Training Type         | Supervised Fine-Tuning (SFT) |
 
-[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 was performed using:
 
+* Transformers
+* TRL SFTTrainer
+* LoRA fine-tuning
+* Mixed precision
+* Gradient accumulation
 
-#### Training Hyperparameters
+The base model weights were adapted rather than retrained from scratch.
 
-- **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. -->
+Qualitative evaluation indicates:
 
-[More Information Needed]
+* Improved dialect fluency
+* Reduced MSA leakage
+* Better conversational tone
+* Higher lexical authenticity
 
-#### Metrics
+Dialect-specific fine-tuning is known to significantly increase dialect generation accuracy and reduce standard-Arabic drift in Arabic LLMs. ([arXiv][2])
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+---
 
-[More Information Needed]
+## Performance Characteristics
 
-### Results
+**Strengths**
 
-[More Information Needed]
+* Very fast inference
+* Low memory footprint
+* Strong conversational coherence
+* Good instruction following
 
-#### Summary
+**Limitations**
 
+* Smaller model → limited factual depth
+* May hallucinate
+* Less capable for complex reasoning vs larger models
+* Dialect bias toward Saudi Arabic
 
+---
 
-## Model Examination [optional]
+## Bias, Risks, and Safety
 
-<!-- Relevant interpretability work for the model goes here -->
+Potential risks:
 
-[More Information Needed]
+* Dialect bias
+* Cultural bias from dataset
+* Toxic outputs if prompted maliciously
+* Hallucinated facts
 
-## Environmental Impact
+Mitigations:
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+* Filtering dataset
+* Instruction alignment
+* Moderation layers recommended
 
-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]
+## Hardware Requirements
 
-## Technical Specifications [optional]
+Runs efficiently on:
 
-### Model Architecture and Objective
+* CPU inference (<1GB memory quantized)
+* Mobile NPUs
+* Edge devices ([Hugging Face][1])
 
-[More Information Needed]
+---
 
-### Compute Infrastructure
+## Example Usage
 
-[More Information Needed]
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
 
-#### Hardware
+model_id = "AyoubChLin/lfm2.5-saudi-dialect"
 
-[More Information Needed]
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(model_id)
 
-#### Software
+prompt = "تكلم باللهجة السعودية عن القهوة"
 
-[More Information Needed]
+inputs = tokenizer(prompt, return_tensors="pt")
+outputs = model.generate(**inputs, max_new_tokens=200)
 
-## Citation [optional]
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+---
 
-**BibTeX:**
+## Training Compute
 
-[More Information Needed]
+* **GPU:** 1 × NVIDIA A100 (40 GB VRAM)
+* **CPU:** 8 cores
+* **RAM:** 16 GiB
+* **Compute Environment:** Cloud training instance
 
-**APA:**
+---
 
-[More Information Needed]
+## License
 
-## Glossary [optional]
+Same as base model license unless otherwise specified.
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+---
 
-[More Information Needed]
+## Citation
 
-## More Information [optional]
+If you use this model:
 
-[More Information Needed]
+```
+@misc{saudi-dialect-lfm2.5,
+  author = {Cherguelaine Ayoub},
+  title = {Saudi Dialect LFM2.5},
+  year = {2026},
+  publisher = {Hugging Face}
+}
+```
 
-## Model Card Authors [optional]
+---
 
-[More Information Needed]
+## Acknowledgments
 
-## Model Card Contact
+* Liquid AI for base model
+* Dataset creators
+* Open-source tooling ecosystem
 
-[More Information Needed]
+---