Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Oct 24, 2023
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f02dc75
chore(readme): Improve documentation on conversation field
NanoCode012 Oct 24, 2023
b4a003d
fix: clarify where the option is
NanoCode012 Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
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