update docstring so it looks better in catalog

IBM · Jan 16, 2024 · 56c6c30 · 56c6c30
1 parent 61d82a1
commit 56c6c30
Showing 1 changed file with 28 additions and 16 deletions.
diff --git a/src/unitxt/formats.py b/src/unitxt/formats.py
@@ -35,23 +35,35 @@ class SystemFormat(Format):
 
     Example:
         when input instance:
-        {
-            "source": "1+1",
-            "target": "2",
-            "instruction": "Solve the math exercises.",
-            "demos": [{"source": "1+2", "target": "3"}, {"source": "4-2", "target": "2"}]
-        }
-        is process-ed by
-        system_format = SystemFormat(
-            demos_field="demos",
-            demo_format="Input: {source}\nOutput: {target}\n\n",
-            model_input_format="Instruction: {instruction}\n\n{demos}Input: {source}\nOutput: ",
-        )
+
+        .. code-block::
+
+            {
+                "source": "1+1",
+                "target": "2",
+                "instruction": "Solve the math exercises.",
+                "demos": [{"source": "1+2", "target": "3"}, {"source": "4-2", "target": "2"}]
+            }
+
+        is processed by
+
+        .. code-block::
+
+            system_format = SystemFormat(
+                demos_field="demos",
+                demo_format="Input: {source}\nOutput: {target}\n\n",
+                model_input_format="Instruction: {instruction}\n\n{demos}Input: {source}\nOutput: ",
+            )
+
         the resulting instance is:
-        {
-            "target": "2",
-            "source": "Instruction: Solve the math exercises.\n\nInput: 1+2\nOutput: 3\n\nInput: 4-2\nOutput: 2\n\nInput: 1+1\nOutput: ",
-        }
+
+        .. code-block::
+
+            {
+                "target": "2",
+                "source": "Instruction: Solve the math exercises.\n\nInput: 1+2\nOutput: 3\n\nInput: 4-2\nOutput: 2\n\nInput: 1+1\nOutput: ",
+            }
+
     """
 
     demos_field: str = "demos"