karimouda commited on
Commit
77da07e
·
verified ·
1 Parent(s): b2cc335

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -1
README.md CHANGED
@@ -37,7 +37,7 @@ model-index:
37
  * SILMA is an open-weight model, free to use in accordance with our open license
38
  * Finally, the model comes with a context length of 12k
39
 
40
- ** Important note: ** Kashif is a specialized model which should ONLY be used in RAG setups. If you are looking for a general purpose model, please refer to [SILMA 9B Instruct v1.0](https://huggingface.co/silma-ai/SILMA-9B-Instruct-v1.0)
41
 
42
  ## Model Skill and Capabilities
43
 
@@ -142,6 +142,36 @@ print(assistant_response)
142
  "وقد وافقت كل من بي سكاي بي و فيرجين ميديا على إنهاء الدعاوى القضائية بالمحكمة العليا ضد بعضهما بشأن معاليم الحمل التي تخص قنواتهما الأساسية."
143
  ```
144
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
145
 
146
  ### GPU Requirements
147
 
 
37
  * SILMA is an open-weight model, free to use in accordance with our open license
38
  * Finally, the model comes with a context length of 12k
39
 
40
+ **Important note:** Kashif is a specialized model which should ONLY be used in RAG setups. If you are looking for a general purpose model, please refer to [SILMA 9B Instruct v1.0](https://huggingface.co/silma-ai/SILMA-9B-Instruct-v1.0)
41
 
42
  ## Model Skill and Capabilities
43
 
 
142
  "وقد وافقت كل من بي سكاي بي و فيرجين ميديا على إنهاء الدعاوى القضائية بالمحكمة العليا ضد بعضهما بشأن معاليم الحمل التي تخص قنواتهما الأساسية."
143
  ```
144
 
145
+ ### Promping Format
146
+
147
+ Here is a recommended way to prompt the model. You can modify the prompt based on your specific requirements, but if you encounter any challenges, following the format below in which we used to train the model may be helpful.
148
+
149
+
150
+ - Arabic
151
+
152
+ ```text
153
+ أجب على السؤال بناءً على السياق أدناه
154
+
155
+ السياق:
156
+ .....
157
+ .....
158
+
159
+ السؤال: ...
160
+ الإجابة: ...
161
+ ```
162
+
163
+ - English
164
+
165
+ ```text
166
+ Answer the following question using the provided context below.
167
+
168
+ Context:
169
+ .....
170
+ .....
171
+
172
+ Question: ...
173
+ Answer: ...
174
+ ```
175
 
176
  ### GPU Requirements
177