Nanobit commited on
Commit
20aa4b5
1 Parent(s): 11d1d60

chore(readme): Improve documentation on conversation field (#782)

Browse files

* chore(readme): Improve documentation on conversation field

* fix: clarify where the option is

Files changed (1) hide show
  1. README.md +11 -2
README.md CHANGED
@@ -356,6 +356,13 @@ See [examples](examples) for quick start. It is recommended to duplicate and mod
356
  - typescript
357
  type: ... # unimplemented custom format
358
 
 
 
 
 
 
 
 
359
  # local
360
  datasets:
361
  - path: data.jsonl # or json
@@ -394,7 +401,7 @@ See [examples](examples) for quick start. It is recommended to duplicate and mod
394
 
395
  <details>
396
 
397
- <summary>All yaml options</summary>
398
 
399
  ```yaml
400
  # This is the huggingface model that contains *.pt, *.safetensors, or *.bin files
@@ -461,7 +468,9 @@ datasets:
461
  data_files: # Optional[str] path to source data files
462
  shards: # Optional[int] number of shards to split data into
463
  name: # Optional[str] name of dataset configuration to load
464
- conversation: # Optional[str] fastchat conversation type, only used with type: sharegpt
 
 
465
 
466
  # Custom user prompt
467
  - path: repo
 
356
  - typescript
357
  type: ... # unimplemented custom format
358
 
359
+ # fastchat conversation
360
+ # See 'conversation' options: https://github.com/lm-sys/FastChat/blob/main/fastchat/conversation.py
361
+ datasets:
362
+ - path: ...
363
+ type: sharegpt
364
+ conversation: chatml
365
+
366
  # local
367
  datasets:
368
  - path: data.jsonl # or json
 
401
 
402
  <details>
403
 
404
+ <summary>All yaml options (click me)</summary>
405
 
406
  ```yaml
407
  # This is the huggingface model that contains *.pt, *.safetensors, or *.bin files
 
468
  data_files: # Optional[str] path to source data files
469
  shards: # Optional[int] number of shards to split data into
470
  name: # Optional[str] name of dataset configuration to load
471
+
472
+ # Optional[str] fastchat conversation type, only used with type: sharegpt
473
+ conversation: # Options (see Conversation 'name'): https://github.com/lm-sys/FastChat/blob/main/fastchat/conversation.py
474
 
475
  # Custom user prompt
476
  - path: repo