Skip to content

Commit

Permalink
fix(readme): clarify custom user prompt [no-ci] (#1124)
Browse files Browse the repository at this point in the history
* fix(readme): clarify custom user prompt

* chore: update example to show use case of setting field
  • Loading branch information
NanoCode012 authored Jan 16, 2024
1 parent 0d3fb67 commit f6fea8e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ Have dataset(s) in one of the following format (JSONL recommended):
For a dataset that is preprocessed for instruction purposes:

```json
{"instruction": "...", "output": "..."}
{"input": "...", "output": "..."}
```

You can use this example in your YAML config:
Expand All @@ -385,6 +385,8 @@ datasets:
type:
system_prompt: ""
field_system: system
field_instruction: input
field_output: output
format: "[INST] {instruction} [/INST]"
no_input_format: "[INST] {instruction} [/INST]"
```
Expand Down Expand Up @@ -577,10 +579,10 @@ datasets:
field_human: # Optional[str]. Human key to use for conversation.
field_model: # Optional[str]. Assistant key to use for conversation.

# Custom user prompt
# Custom user instruction prompt
- path: repo
type:
# The below are defaults. only set what's needed.
# The below are defaults. only set what's needed if you use a different column name.
system_prompt: ""
system_format: "{system}"
field_system: system
Expand All @@ -589,6 +591,7 @@ datasets:
field_output: output

# Customizable to be single line or multi-line
# Use {instruction}/{input} as key to be replaced
# 'format' can include {input}
format: |-
User: {instruction} {input}
Expand Down

0 comments on commit f6fea8e

Please sign in to comment.