From b2cae6cac682a35e27a955260f8f1776e8abe48c Mon Sep 17 00:00:00 2001 From: oobabooga <112222186+oobabooga@users.noreply.github.com> Date: Tue, 12 Dec 2023 14:10:49 -0800 Subject: [PATCH] Docs: minor update --- docs/01 - Chat Tab.md | 2 +- docs/03 - Parameters Tab.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/01 - Chat Tab.md b/docs/01 - Chat Tab.md index 5a9d6381..4b177b80 100644 --- a/docs/01 - Chat Tab.md +++ b/docs/01 - Chat Tab.md @@ -97,7 +97,7 @@ The "Chat" option should typically be used only for base models or non-instruct Used for talking to an instruction-following model using the prompt format defined under "Parameters" > "Instruction template". Think of this option as an offline ChatGPT. -The prompt format is defined by the **Instruction template string** parameter in "Parameters" > "Instruction template", which represents a A Jinja2 template. +The prompt format is defined by the **Instruction template** parameter in "Parameters" > "Instruction template", which represents a Jinja2 template. Note that when you load a model in the "Model" tab, the web UI will try to automatically detect its instruction template (if any), and will update the values under "Parameters" > "Instruction template" accordingly. This is done using a set of regular expressions defined in `models/config.yaml`. This detection is not guaranteed to be accurate. You should check the model card on Hugging Face to see if you are using the correct prompt format. diff --git a/docs/03 - Parameters Tab.md b/docs/03 - Parameters Tab.md index af480998..08cedc93 100644 --- a/docs/03 - Parameters Tab.md +++ b/docs/03 - Parameters Tab.md @@ -103,10 +103,11 @@ Defines the instruction template that is used in the Chat tab when "instruct" or * **Saved instruction templates**: A dropdown menu where you can load a saved template, save a new template (💾 button), and delete the currently selected template (🗑️). * **Custom system message**: A message that defines the personality of the chatbot, replacing its default "System message" string. Example: "You are a duck." -* **Instruction template string**: A Jinja2 template that defines the prompt format for the instruction-following conversation. +* **Instruction template**: A Jinja2 template that defines the prompt format for the instruction-following conversation. * **Send to default**: Send the full instruction template in string format to the Default tab. * **Send to notebook**: Send the full instruction template in string format to the Notebook tab. * **Send to negative prompt**: Send the full instruction template in string format to the "Negative prompt" field under "Parameters" > "Generation". +* **Chat template**: A Jinja2 template that defines the prompt format for regular chat conversations with characters. * **Command for chat-instruct mode**: The command that is used in chat-instruct mode to query the model to generate a reply on behalf of the character. Can be used creatively to generate specific kinds of responses. ## Chat history