Omartificial-Intelligence-Space
/

Diraya-3B-Instruct-Ar

@@ -1,202 +1,199 @@
 ---
 base_model: unsloth/qwen2.5-3b-instruct-unsloth-bnb-4bit
 library_name: peft
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### 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
-## 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]
-### Framework versions
-- PEFT 0.14.0

 ---
 base_model: unsloth/qwen2.5-3b-instruct-unsloth-bnb-4bit
 library_name: peft
+license: apache-2.0
+language:
+- ar
+tags:
+- arabic
+- reasoning
+- llm
+- DIRA
 ---
+# Diraya-3B-Instruct-Ar
+## Model Description
+Diraya-3B-Instruct-Ar is an Arabic reasoning-specialized language model fine-tuned from Qwen2.5-3B. This model is part of the DIRA (Diraya Arabic Reasoning AI) collection, which focuses on enhancing the logical inference and mathematical reasoning capabilities of Arabic language models.
+## Key Features
+- **Arabic-first reasoning**: Optimized specifically for complex reasoning tasks in Arabic
+- **Structured reasoning format**: Trained to output reasoning in a clear XML format
+- **Mathematical reasoning**: Enhanced ability to solve multi-step math problems
+- **Instruction-tuned**: Follows instructions reliably in Arabic
+- **Lightweight**: Based on the efficient 3B parameter model architecture
+## Technical Details
+**Base Model**: [Qwen2.5-3B](https://huggingface.co/Qwen/Qwen2.5-3B) via [unsloth/Qwen2.5-3B-Instruct-unsloth-bnb-4bit](https://huggingface.co/unsloth/Qwen2.5-3B-Instruct-unsloth-bnb-4bit)
+**Model Type**: Instruction-tuned causal language model
+**Parameter Count**: 3.09B (2.77B non-embedding)
+**Architecture**:
+- 36 transformer layers
+- 16 attention heads for queries (GQA)
+- 2 attention heads for keys/values
+- Context length: 32,768 tokens
+**Training Approach**:
+- Fine-tuned using GPRO (General Policy Reinforcement Optimization)
+- Training focused on structured reasoning output format using XML tags
+- Optimized for mathematical reasoning using the Arabic GSM8K dataset
+- Multiple reward functions including correctness, format adherence, and output structure
+**LoRA Configuration**:
+```json
+{
+  "peft_type": "LORA",
+  "r": 64,
+  "lora_alpha": 64,
+  "lora_dropout": 0,
+  "target_modules": [
+    "k_proj", "gate_proj", "o_proj", "down_proj",
+    "v_proj", "up_proj", "q_proj"
+  ],
+  "bias": "none",
+  "inference_mode": true
+}
+```
+## Usage
+The model is designed to output structured reasoning in the following format:
+```
+<reasoning>
+[Step-by-step reasoning process in Arabic]
+</reasoning>
+<answer>
+[Final answer in Arabic]
+</answer>
+```
+### Example Usage
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+# Load the model and tokenizer
+model_name = "Omartificial-Intelligence-Space/Diraya-3B-Instruct-Ar"
+model = AutoModelForCausalLM.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+# System prompt to enforce XML structure
+system_prompt = """
+Respond in the following format in Arabic language only:
+<reasoning>
+...
+</reasoning>
+<answer>
+...
+</answer>
+"""
+# Prepare user question
+user_question = "كل يوم، تُطعم وندي كل دجاجة من دجاجاتها ثلاث أكواب من العلف المختلط. تقدم الدجاجات وجباتهم في ثلاث وجبات منفصلة. في الصباح، تعطي قطيعها من الدجاج 15 كوبًا من العلف. في فترة ما بعد الظهر، تعطي دجاجاتها 25 كوبًا أخرى من العلف. كم عدد أكواب العلف التي تحتاجها لتقديمها لدجاجاتها في الوجبة الأخيرة من اليوم إذا كان حجم قطيع وندي 20 دجاجة؟"
+# Prepare input for the model
+messages = [
+    {"role": "system", "content": system_prompt},
+    {"role": "user", "content": user_question}
+]
+input_text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+# Generate response
+inputs = tokenizer(input_text, return_tensors="pt").to(model.device)
+outputs = model.generate(
+    **inputs,
+    max_new_tokens=512,
+    temperature=0.7,
+    top_p=0.95
+)
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(response)
+```
+## Training Data
+This model was primarily fine-tuned on:
+- **Arabic GSM8K Dataset**: A comprehensive collection of grade school math problems translated to Arabic, requiring multi-step reasoning
+- **Format**: Training emphasized structured reasoning using XML tags to clearly separate reasoning steps from final answers
+## Training and Evaluation Results
+### Training Progress
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/628f7a71dd993507cfcbe587/21ZC26E-3Zh2Xw3a6h3WL.png)
+*Figure: Composition of Rewards over Training Steps showing the evolution of model performance across different reward functions*
+The training utilized multiple reward functions to optimize different aspects of the model's performance:
+- **Correctness Reward** (red): Measures the model's ability to generate the correct final answer
+- **Integer Reward** (blue): Ensures the model outputs valid numerical responses
+- **Format Rewards** (purple/gray): Promote proper XML structure adherence
+- **XML Count Reward** (yellow): Fine-tunes the exact XML tag placement and completeness
+As shown in the visualization, the model demonstrated consistent improvement across all reward dimensions throughout the training process. The upper values in rewards indicate higher-quality outputs that simultaneously satisfy multiple optimization criteria. This multi-objective training approach resulted in a model that not only produces correct answers but does so with clear, well-structured reasoning.
+The model demonstrates strong performance on Arabic mathematical reasoning tasks, with particular strengths in:
+- Producing well-structured reasoning steps
+- Following the required XML output format
+- Arriving at correct numerical answers for multi-step problems
+## Limitations
+- Specialized for reasoning tasks and may not perform as well on general conversational tasks
+- Performance may vary on complex mathematical problems beyond grade-school level
+- Limited to the Arabic language
+## Responsible Use
+This model is intended for educational and research purposes. While it excels at mathematical reasoning, please note:
+- It should not replace human judgment for critical decisions
+- Results should be verified when used in educational contexts
+- The model inherits limitations from its base model Qwen2.5-3B
+## Related Resources
+This model is part of the DIRA (Diraya Arabic Reasoning AI) collection:
+- [Arabic GSM8K Dataset](https://huggingface.co/datasets/Omartificial-Intelligence-Space/Arabic-gsm8k): The dataset used for training this model
+## Citation
+If you use this model in your research, please cite:
+```bibtex
+@misc{diraya3b,
+  title={Diraya-3B-Instruct-Ar: An Arabic Reasoning-Specialized Language Model},
+  author={Omartificial-Intelligence-Space},
+  year={2025},
+  howpublished={\url{https://huggingface.co/Omartificial-Intelligence-Space/Diraya-3B-Instruct-Ar}}
+}
+```
+## Acknowledgements
+This model builds upon the Qwen2.5-3B model by the Qwen Team and utilizes optimization techniques from Unsloth. We acknowledge their valuable contributions to the field of language modeling.
+```bibtex
+@misc{qwen2.5,
+    title = {Qwen2.5: A Party of Foundation Models},
+    url = {https://qwenlm.github.io/blog/qwen2.5/},
+    author = {Qwen Team},
+    month = {September},
+    year = {2024}
+}
+@article{qwen2,
+      title={Qwen2 Technical Report},
+      author={An Yang and Baosong Yang and Binyuan Hui and Bo Zheng and Bowen Yu and Chang Zhou and Chengpeng Li and Chengyuan Li and Dayiheng Liu and Fei Huang and Guanting Dong and Haoran Wei and Huan Lin and Jialong Tang and Jialin Wang and Jian Yang and Jianhong Tu and Jianwei Zhang and Jianxin Ma and Jin Xu and Jingren Zhou and Jinze Bai and Jinzheng He and Junyang Lin and Kai Dang and Keming Lu and Keqin Chen and Kexin Yang and Mei Li and Mingfeng Xue and Na Ni and Pei Zhang and Peng Wang and Ru Peng and Rui Men and Ruize Gao and Runji Lin and Shijie Wang and Shuai Bai and Sinan Tan and Tianhang Zhu and Tianhao Li and Tianyu Liu and Wenbin Ge and Xiaodong Deng and Xiaohuan Zhou and Xingzhang Ren and Xinyu Zhang and Xipin Wei and Xuancheng Ren and Yang Fan and Yang Yao and Yichang Zhang and Yu Wan and Yunfei Chu and Yuqiong Liu and Zeyu Cui and Zhenru Zhang and Zhihao Fan},
+      journal={arXiv preprint arXiv:2407.10671},
+      year={2024}
+}
+```