ImadSaddik commited on
Commit
fbb1ac5
·
verified ·
1 Parent(s): 59461ed

Updated README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -3
README.md CHANGED
@@ -210,8 +210,34 @@ As I mentioned, I'm manually creating this dataset to ensure high quality. If yo
210
 
211
  1. Fork the repository.
212
  2. Create a new branch.
213
- 3. Add entries to the dataset.
214
- 4. Create a pull request.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
215
 
216
  ## Wanna talk?
217
 
@@ -220,4 +246,3 @@ You can contact me through:
220
  * **Discord:** Username: imad_saddik
221
  * **LinkedIn:** [Connect with me](https://www.linkedin.com/in/imadsaddik/).
222
  * **Email:** [simad3647@gmail.com](mailto:simad3647@gmail.com).
223
-
 
210
 
211
  1. Fork the repository.
212
  2. Create a new branch.
213
+ 3. Add your new conversations to the `input_dataset.json` file. Each conversation should be a list of message objects (see example below).
214
+ 4. Run the `enrich_dataset.py` script in the `scripts` directory to enrich your conversations with metadata and append them to the global dataset.
215
+ 5. Create a pull request.
216
+
217
+ ### Example: Adding to `input_dataset.json`
218
+
219
+ The `input_dataset.json` file should contain a list of conversations. Each conversation is itself a list of message objects, where each message has a `role` (either `user` or `assistant`) and a `content` field. For example:
220
+
221
+ ```json
222
+ [
223
+ [
224
+ {"role": "user", "content": "أهلا شنو سميتك؟"},
225
+ {"role": "assistant", "content": "انا سميتي بودماغ، ساوبني عماد الصاديق باش نساعدك فاي حاجة اللي نقد نعاون فيها."}
226
+ ],
227
+ [
228
+ {"role": "user", "content": "شنو تحب تشرب؟"},
229
+ {"role": "assistant", "content": "نحب نشرب قهوة، ونتمنى انك زادة تحبها."}
230
+ ]
231
+ ]
232
+ ```
233
+
234
+ After adding your conversations, run:
235
+
236
+ ```bash
237
+ python scripts/enrich_dataset.py
238
+ ```
239
+
240
+ This will process your new conversations and add them (with metadata) to the main dataset.
241
 
242
  ## Wanna talk?
243
 
 
246
  * **Discord:** Username: imad_saddik
247
  * **LinkedIn:** [Connect with me](https://www.linkedin.com/in/imadsaddik/).
248
  * **Email:** [simad3647@gmail.com](mailto:simad3647@gmail.com).