fix(readme): clarify custom user prompt [no-ci] (#1124)

* fix(readme): clarify custom user prompt

* chore: update example to show use case of setting field
This commit is contained in:
NanoCode012
2024-01-16 09:47:33 +09:00
committed by GitHub
parent c1b741d9fb
commit 9cd27b2f91

View File

@@ -374,7 +374,7 @@ Have dataset(s) in one of the following format (JSONL recommended):
For a dataset that is preprocessed for instruction purposes: For a dataset that is preprocessed for instruction purposes:
```json ```json
{"instruction": "...", "output": "..."} {"input": "...", "output": "..."}
``` ```
You can use this example in your YAML config: You can use this example in your YAML config:
@@ -385,6 +385,8 @@ datasets:
type: type:
system_prompt: "" system_prompt: ""
field_system: system field_system: system
field_instruction: input
field_output: output
format: "[INST] {instruction} [/INST]" format: "[INST] {instruction} [/INST]"
no_input_format: "[INST] {instruction} [/INST]" no_input_format: "[INST] {instruction} [/INST]"
``` ```
@@ -577,10 +579,10 @@ datasets:
field_human: # Optional[str]. Human key to use for conversation. field_human: # Optional[str]. Human key to use for conversation.
field_model: # Optional[str]. Assistant key to use for conversation. field_model: # Optional[str]. Assistant key to use for conversation.
# Custom user prompt # Custom user instruction prompt
- path: repo - path: repo
type: 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_prompt: ""
system_format: "{system}" system_format: "{system}"
field_system: system field_system: system
@@ -589,6 +591,7 @@ datasets:
field_output: output field_output: output
# Customizable to be single line or multi-line # Customizable to be single line or multi-line
# Use {instruction}/{input} as key to be replaced
# 'format' can include {input} # 'format' can include {input}
format: |- format: |-
User: {instruction} {input} User: {instruction} {input}