Skip to content

Commit

Permalink
Prompt format info
Browse files Browse the repository at this point in the history
  • Loading branch information
guinmoon committed May 27, 2024
1 parent b237aec commit fc56a02
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions docs/prompt_format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Prompt format
You can use `{prompt}` or `{{prompt}}` to indicate a prompt.
The system prompt can be specified at the beginning of the template in the format `[system](<your system prompt>)`.

## BOS option:
Adds the Begin Of Session token to the beginning of the prompt.

## EOS option:
Adds the End Of Session token to the end of the prompt.

## Option Special:
If enabled, the tokenizer will accept special tokens in the template, such as `<|user|>`.

## Option reverse prompts:
Allows you to specify sequences at the occurrence of which the prediction will be stopped. The sequences are specified using commas.
Example: `<|end|>,user:`.

## Option skip tokens:
Allows you to specify tokens (in string format) that will not be displayed in the prediction results. Tokens are specified using commas.
Example: `<|end|>,<|assistant|>`.

Translated with DeepL.com (free version)
2 changes: 1 addition & 1 deletion llmfarm_core.swift

0 comments on commit fc56a02

Please sign in to comment.