Adding Formats ✨¶

Formats are the global textual layout of the example.

It determines the positioning of the task instruction, system_prompt and demos the source query and required output form the model, the target.

Below is in example of how to define the layout of the different pats. This example is based on this blog post explainging the prompt sturctre of the llama2 model: Blog Post

So the actual template looks like this:

<s>[INST] <<SYS>>
{{ system_prompt }}
<</SYS>>

{{ user_msg_1 }} [/INST] {{ model_answer_1 }} </s><s>[INST] {{ user_msg_2 }} [/INST]

An example for data point with the llama2 format:

[INST] <<SYS>>
You are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe.  Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content. Please ensure that your responses are socially unbiased and positive in nature.

If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information.

Classify the grammatical acceptability of the following text to one of these options: unacceptable, acceptable.
<<SYS>>

text: The more we study verbs, the crazier they get. [/INST] The grammatical acceptability is acceptable </s><s>[INST] text: They drank the pub. [/INST]The grammatical acceptability is

To define this exact format you can use this code:

from unitxt.catalog import add_to_catalog
from unitxt.formats import SystemFormat

format = SystemFormat(
   demo_format="{source} [/INST] {target_prefix}{target} </s><s>[INST] ",
   model_input_format="[INST] <<SYS>>\n{system_prompt}\n\n{instruction}<<SYS>>\n\n\n{demos}{source} [/INST]{target_prefix}",
)

add_to_catalog(format, "formats.llama2", overwrite=True)