preparing for new sampling: adding a repair field to Instruction that can only be set by .copy_and_repair(...). The templates are updated to accommodate the new field.

Author: HendrikStrobelt

mellea/stdlib/instruction.py

@@ -1,5 +1,7 @@
 """Instructions."""
 
+from __future__ import annotations
+
 from copy import deepcopy
 
 import jinja2
@@ -106,6 +108,7 @@ def __init__(
         self._output_prefix = (
             blockify(output_prefix) if output_prefix is not None else None
         )
+        self._repair_string: str | None = None
 
     def parts(self):
         """Returns all of the constituent parts of an Instruction."""
@@ -132,6 +135,7 @@ def format_for_llm(self) -> TemplateRepresentation:
                 "output_prefix": (
                     self._output_prefix if self._output_prefix is not None else None
                 ),
+                "repair": self._repair_string,
             },
             tools=None,
             template_order=["*", "Instruction"],
@@ -147,3 +151,9 @@ def apply_user_dict_from_jinja(user_dict: dict[str, str], s: str) -> str:
     def requirements(self) -> list[Requirement]:
         """Returns a list of Requirement instances."""
         return self._requirements
+
+    def copy_and_repair(self, repair_string: str) -> Instruction:
+        """Creates a copy of the instruction and adds/overwrites the repair string."""
+        res = deepcopy(self)
+        res._repair_string = repair_string
+        return res

mellea/templates/prompts/default/Instruction.jinja2

@@ -37,8 +37,14 @@ Here is some grounding context:
 {%- endif -%}
 {% endblock grounding_context %}
 
+{%- block repair_block -%}
+{% if repair %}
+{{ repair -}}
+{%- endif -%}
+{% endblock repair_block %}
+
 {%- block output_prefix -%}
 {% if output_prefix %}
 {{ output_prefix -}}
 {%- endif -%}
-{% endblock output_prefix %}
+{% endblock output_prefix %}

mellea/templates/prompts/granite/Instruction.jinja2

@@ -37,8 +37,14 @@ Here are some examples of what the response might look like:
 {%- endif -%}
 {% endblock icl_examples %}
 
+{%- block repair_block -%}
+{% if repair %}
+{{ repair -}}
+{%- endif -%}
+{% endblock repair_block %}
+
 {%- block output_prefix -%}
 {% if output_prefix %}
 {{ output_prefix -}}
 {%- endif -%}
-{% endblock output_prefix %}
+{% endblock output_prefix %}