Skip to content

Commit

Permalink
chore(readme): Improve documentation on conversation field (axolotl-a…
Browse files Browse the repository at this point in the history
…i-cloud#782)

* chore(readme): Improve documentation on conversation field

* fix: clarify where the option is
  • Loading branch information
NanoCode012 committed Oct 24, 2023
1 parent fb2abe6 commit d87f3be
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,13 @@ See [examples](examples) for quick start. It is recommended to duplicate and mod
- typescript
type: ... # unimplemented custom format

# fastchat conversation
# See 'conversation' options: https://github.com/lm-sys/FastChat/blob/main/fastchat/conversation.py
datasets:
- path: ...
type: sharegpt
conversation: chatml

# local
datasets:
- path: data.jsonl # or json
Expand Down Expand Up @@ -394,7 +401,7 @@ See [examples](examples) for quick start. It is recommended to duplicate and mod

<details>

<summary>All yaml options</summary>
<summary>All yaml options (click me)</summary>

```yaml
# This is the huggingface model that contains *.pt, *.safetensors, or *.bin files
Expand Down Expand Up @@ -461,7 +468,9 @@ datasets:
data_files: # Optional[str] path to source data files
shards: # Optional[int] number of shards to split data into
name: # Optional[str] name of dataset configuration to load
conversation: # Optional[str] fastchat conversation type, only used with type: sharegpt

# Optional[str] fastchat conversation type, only used with type: sharegpt
conversation: # Options (see Conversation 'name'): https://github.com/lm-sys/FastChat/blob/main/fastchat/conversation.py

# Custom user prompt
- path: repo
Expand Down

0 comments on commit d87f3be

Please sign in to comment.