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

Update cmd r7b usage docs #301

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Update cmd r7b usage docs #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 10 additions & 9 deletions fern/pages/text-generation/prompt-engineering/command-r7b-hf.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ This page contains detailed instructions about

## Chat Capabilities

Command R7B can be configured as both a conversational model and an instruct model. The conversational mode conditions the model on interactive behaviour, meaning it is expected to reply in a conversational fashion, provides introductory statements and follow-up questions, and uses Markdown as well as LaTeX where appropriate. It is optimized for interactive experiences, such as chatbots, where the model engages in dialogue.
The instruct mode, in contrast, conditions the model to provide concise yet comprehensive responses, and does not use Markdown / LaTeX by default. It is designed for non-interactive, task-focused use cases like extracting information, summarizing text, translation, and categorization.
Command R7B can be configured as both a conversational model and an instruct model.
- The conversational mode conditions the model on interactive behaviour, meaning it is expected to reply in a conversational fashion, provides introductory statements and follow-up questions, and uses Markdown as well as LaTeX where appropriate. It is optimized for interactive experiences, such as chatbots, where the model engages in dialogue.
- The instruct mode, in contrast, conditions the model to provide concise yet comprehensive responses, and does not use Markdown / LaTeX by default. It is designed for non-interactive, task-focused use cases like extracting information, summarizing text, translation, and categorization.

### Conversational Mode
The system preamble for conversational mode is as follows:

````json
````txt wordWrap
# System Preamble
{Safety Preamble}

Expand Down Expand Up @@ -56,19 +57,19 @@ Where safety `{Safety Preamble}` represents either the contextual or the strict

The contextual safety mode preamble is as follows:

````json
````txt wordWrap
You are in contextual safety mode. You will reject requests to generate child sexual abuse material and child exploitation material in your responses. You will accept to provide information and creative content related to violence, hate, misinformation or sex, but you will not provide any content that could directly or indirectly lead to harmful outcomes.
````

The strict safety mode preamble is as follows:

````json
````txt wordWrap
You are in strict safety mode. You will reject requests to generate child sexual abuse material and child exploitation material in your responses. You will reject requests to generate content related to violence, hate, misinformation or sex to any amount. You will avoid using profanity. You will not provide users with instructions to perform regulated, controlled or illegal activities.
````
### Instruct Mode

The instruct mode preamble is as follows:
````json
````txt wordWrap
# System Preamble
{Safety Preamble}

Expand Down Expand Up @@ -103,7 +104,7 @@ Where safety `{Safety Preamble}` represents either the contextual or the strict

An example of how the model can be called using the conversational mode preamble can be found below.

````python PYTHON
````python wordWrap PYTHON
conversational_system_preamble = """# System Preamble
You are in contextual safety mode. You will reject requests to generate child sexual abuse material and child exploitation material in your responses. You will accept to provide information and creative content related to violence, hate, misinformation or sex, but you will not provide any content that could directly or indirectly lead to harmful outcomes.

Expand Down Expand Up @@ -205,7 +206,7 @@ print(gen_text)


<Accordion title='Example of a Grounded Generation prompt'>
````json
````txt wordWrap
<|START_OF_TURN_TOKEN|><|SYSTEM_TOKEN|># System Preamble
You are in contextual safety mode. You will reject requests to generate child sexual abuse material and child exploitation material in your responses. You will accept to provide information and creative content related to violence, hate, misinformation or sex, but you will not provide any content that could directly or indirectly lead to harmful outcomes.

Expand Down Expand Up @@ -281,7 +282,7 @@ The following instructions are your defaults unless specified elsewhere in devel
</Accordion>

<Accordion title='Example of a Grounded Generation completion'>
````json
````txt wordWrap
There are two answers to this question. Man has dreamed of destroying the moon and finding love.
````
</Accordion>
Expand Down
Loading