hozifa1 commited on
Commit
ea6ef30
·
verified ·
1 Parent(s): 8f86e57

docs: publish official Faqih-R1-14B model card with research disclaimer and architecture specs

Browse files
Files changed (1) hide show
  1. README.md +101 -164
README.md CHANGED
@@ -1,199 +1,136 @@
1
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  library_name: transformers
3
- tags: []
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
 
 
 
10
 
 
11
 
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
 
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
 
145
- 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).
 
 
 
 
146
 
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
 
153
- ## Technical Specifications [optional]
154
 
155
- ### Model Architecture and Objective
156
 
157
- [More Information Needed]
 
 
 
 
 
 
 
158
 
159
- ### Compute Infrastructure
160
 
161
- [More Information Needed]
162
 
163
- #### Hardware
164
 
165
- [More Information Needed]
 
166
 
167
- #### Software
 
 
 
 
 
 
 
 
 
168
 
169
- [More Information Needed]
 
 
 
 
 
170
 
171
- ## Citation [optional]
172
 
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
 
175
- **BibTeX:**
176
 
177
- [More Information Needed]
 
 
178
 
179
- **APA:**
180
 
181
- [More Information Needed]
 
 
 
 
 
182
 
183
- ## Glossary [optional]
 
 
 
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
 
 
 
186
 
187
- [More Information Needed]
 
 
 
 
 
188
 
189
- ## More Information [optional]
 
 
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
 
196
 
197
- ## Model Card Contact
198
 
199
- [More Information Needed]
 
 
1
  ---
2
+ language:
3
+ - ar
4
+ - en
5
+ license: apache-2.0
6
+ base_model: deepseek-ai/DeepSeek-R1-Distill-Qwen-14B
7
+ tags:
8
+ - islamic
9
+ - arabic
10
+ - fiqh
11
+ - hadith
12
+ - quran
13
+ - reasoning
14
+ - deepseek-r1
15
+ - unsloth
16
+ - qwen
17
+ pipeline_tag: text-generation
18
  library_name: transformers
 
19
  ---
20
 
21
+ # 🕌 Faqih-R1-14B (فقيه): Islamic AI & Jurisprudential Reasoning Model
22
 
23
+ <div align="center">
24
 
25
+ [![Base Model](https://img.shields.io/badge/Base_Model-DeepSeek--R1--Distill--Qwen--14B-blue.svg)](https://huggingface.co/deepseek-ai/DeepSeek-R1-Distill-Qwen-14B)
26
+ [![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](LICENSE)
27
+ [![Framework](https://img.shields.io/badge/Trained_with-Unsloth-red.svg)](https://github.com/unslothai/unsloth)
28
+ [![Language](https://img.shields.io/badge/Language-Arabic_%7C_English-yellow.svg)](#)
29
 
30
+ </div>
31
 
32
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
 
34
+ ## ⚠️ تنويه شرعي وبحثي هام (Important Research & Religious Disclaimer)
35
 
36
+ > [!IMPORTANT]
37
+ > **هذا النموذج هو إصدار تجريبي وبحثي قيد التطوير والتدريب النشط (Experimental Research Preview / Under Active Training).**
38
+ >
39
+ > 1. **ليس نموذجاً معصوماً ولا مكتملاً بنسبة 100%:** لا يزال النموذج يخضع لعمليات التحسين والمواءمة ومراجعة المصادر لمنع الهلوسة وضبط الدقة الاستنباطية.
40
+ > 2. **ليس بديلاً عن العلماء ودور الإفتاء المعتمدة:** هذا النموذج هو أداة بحثية وتقنية مساعدة للباحثين وطلبة العلم، **ولا يجوز استخدامه كمفتٍ مطلق أو إصدار فتاوى قطعية ملزمة** في النوازل والقضايا الحساسة دون الرجوع للمجامع الفقهية وهيئات كبار العلماء الرسمية (مثل هيئة كبار العلماء، دار الإفتاء المصرية، مجمع الفقه الإسلامي الدولي).
41
 
42
+ ---
 
 
 
 
43
 
44
+ ## 📌 عن النموذج (Model Overview)
45
 
46
+ نموذج **Faqih-R1-14B (فقيه)** هو نموذج لغوي كبير متخصص في **الاستدلال الفقهي والعلوم الإسلامية**، مبني ومدرب عبر تقنيات التفكير العميق المنظم (Chain-of-Thought Reasoning).
47
 
48
+ * **النموذج التأسيسي (Base Model):** [`deepseek-ai/DeepSeek-R1-Distill-Qwen-14B`](https://huggingface.co/deepseek-ai/DeepSeek-R1-Distill-Qwen-14B).
49
+ * **المعمارية (Architecture):** معمارية Qwen 2.5 المقطرة من DeepSeek-R1 بحجم 14.8 مليار معلمة (14.8B Parameters).
50
+ * **تقنية التدريب (Fine-Tuning Method):** Unsloth QLoRA (4-bit quantization) مع سياق استدلال موسع.
51
+ * **البيانات التدريبية (Training Corpus):** أكثر من 60,820 مسألة فقهية واستدلالية محققة تغطي:
52
+ * الفقه المقارن على المذاهب الأربعة المعتمدة (الحنفي، المالكي، الشافعي، الحنبلي).
53
+ * تفاسير القرآن الكريم وأسباب النزول.
54
+ * تخريج الأحاديث النبوية ودرجات صحتها.
55
+ * مسائل حساب الفرائض والمواريث.
56
 
57
+ ---
58
 
59
+ ## 🧠 آلية التفكير والاستدلال (Reasoning Process)
60
 
61
+ يستخدم النموذج وسوم التفكير `<think> ... </think>` لتفكيك المسألة الشرعية قبل تقديم الحكم النهائي:
62
 
63
+ ```text
64
+ المستخدم: ما حكم الجمع بين الصلاتين للمسافر في المذهب الشافعي؟
65
 
66
+ النموذج:
67
+ <think>
68
+ 1. تحليل المسألة: مسألة الجمع بين الظهر والعصر، أو المغرب والعشاء للمسافر.
69
+ 2. المذهب المطلوب: مذهب الإمام الشافعي رحمه الله.
70
+ 3. مراجعة شروط القصر والجمع في المذهب:
71
+ - مسافة السفر: سفر طويل مباح (أربعة بُرد / حوالي 83 كم).
72
+ - أنواع الجمع: يجوز جمع تقديم أو جمع تأخير.
73
+ - الشروط: الترتيب، نية الجمع في أولى الصلاتين، والموالاة.
74
+ 4. صياغة الجواب مع الأدلة من السنة النبوية وأمهات كتب الشافعية (المجموع للنووي، منهاج الطالبين).
75
+ </think>
76
 
77
+ يجوز للمسافر سفراً طويلاً مباحاً (مسافة 83 كم فأكثر) الجمع بين الظهر والعصر، والمغرب والعشاء، جمع تقديم أو تأخير وفق معتمد المذهب الشافعي، بالشروط الآتية:
78
+ 1. الترتيب بين الصلاتين.
79
+ 2. نية الجمع في الصلاة الأولى.
80
+ 3. الموالاة بينهما.
81
+ ...
82
+ ```
83
 
84
+ ---
85
 
86
+ ## 💻 طريقة الاستخدام البرمجي (Quick Start)
87
 
88
+ ### استخدام مكتبة Transformers:
89
 
90
+ ```python
91
+ from transformers import AutoModelForCausalLM, AutoTokenizer
92
+ import torch
93
 
94
+ model_id = "hozifa1/Faqih-R1-14B-Islamic-AI"
95
 
96
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
97
+ model = AutoModelForCausalLM.from_pretrained(
98
+ model_id,
99
+ torch_dtype=torch.bfloat16,
100
+ device_map="auto"
101
+ )
102
 
103
+ prompt = "ما هي أركان الصلاة المتفق عليها بين الفقهاء؟"
104
+ messages = [
105
+ {"role": "user", "content": prompt}
106
+ ]
107
 
108
+ inputs = tokenizer.apply_chat_template(
109
+ messages,
110
+ tokenize=True,
111
+ add_generation_prompt=True,
112
+ return_tensors="pt"
113
+ ).to("cuda")
114
 
115
+ outputs = model.generate(
116
+ inputs,
117
+ max_new_tokens=1024,
118
+ temperature=0.6,
119
+ top_p=0.95
120
+ )
121
 
122
+ response = tokenizer.decode(outputs[0][inputs.shape[1]:], skip_special_tokens=True)
123
+ print(response)
124
+ ```
125
 
126
+ ---
127
 
128
+ ## 🛡️ مصفوفة القيود والحدود (Limitations & Safety)
129
 
130
+ * **الامتناع عن القطع في المختلف فيه:** تم تدريب النموذج على عرض أقوال المذاهب بأدلتها دون تعصب لمذهب واحد.
131
+ * **عدم الاجتهاد المطلق:** يقتصر النموذج على نقل وتلخيص واستنباط ما قرره علماء الأمة المحققون من أمهات المصادر، ولا يُنشئ أحكاماً مستحدثة خارج الإجماع المستقر.
132
 
133
+ ---
134
 
135
+ ## 📜 الترخيص (License)
136
+ هذا النموذج متاح تحت رخصة **Apache 2.0** للأغراض البحثية والتعليمية.