StackExchangedPairedTemplate

class torchtune.data.StackExchangedPairedTemplate

Prompt template for preference datasets similar to StackExchangedPaired.

Question: <YOUR QUESTION HERE>

Answer:

classmethod format(sample: Mapping[str, Any], column_map: Optional[Dict[str, str]] = None) → str

Generate prompt from instruction and input.

Parameters:

• sample (Mapping[str, Any]) – a single data sample with instruction

• column_map (Optional[Dict[str, str]]) – a mapping from the expected placeholder names in the template to the column names in the sample. If None, assume these are identical.

Examples

>>> # Simple question
>>> StackExchangedPairedTemplate.format(sample={"question": "What is the capital of France?"})
Question: What is the capital of France?\n\nAnswer:

>>> # Question with column map where the 'question' key is actually named 'prompt' in the given sample
>>> StackExchangedPairedTemplate.format(
...     sample={"prompt": "What is the capital of France?"},
...     column_map={"question": "prompt"}
... )
Question: What is the capital of France?\n\nAnswer:

Returns:

The formatted prompt