langfun 0.0.2.dev20240609__py3-none-any.whl → 0.0.2.dev20240611__py3-none-any.whl

langfun/core/structured/completion.py

@@ -30,7 +30,7 @@ class CompleteStructure(mapping.Mapping):
 
   mapping_template = lf.Template("""
       {{ input_title }}:
-      {{ example.input_repr() | indent(2, True) }}
+      {{ example.input_repr(use_modality_ref=True) | indent(2, True) }}
 
       {%- if missing_type_dependencies(example.input) %}
 
@@ -45,13 +45,16 @@ class CompleteStructure(mapping.Mapping):
 
       {{ output_title }}:
       {%- if example.has_output %}
-      {{ example.output_repr() | indent(2, True) }}
+      {{ example.output_repr(use_modality_ref=True) | indent(2, True) }}
       {% endif -%}
       """)
 
   input_title = 'INPUT_OBJECT'
   output_title = 'OUTPUT_OBJECT'
   schema_title = 'CLASS_DEFINITIONS'
+  modality_refs_title: Annotated[
+      str, 'The section title for modality refs.'
+  ] = 'MODALITY_REFERENCES'
 
   preamble = lf.LangFunc(
       """
@@ -148,6 +151,28 @@ class CompleteStructure(mapping.Mapping):
     pg.traverse(self.input, _visit)
     return context
 
+  #
+  # Helper methods for handling modalities.
+  #
+
+  def has_modality_refs(self, value: Any) -> bool:
+    """Returns true if the value has modalities."""
+    return not isinstance(value, lf.Modality) and pg.contains(
+        value, type=lf.Modality
+    )
+
+  def modalities(self, value: Any) -> dict[str, lf.Modality]:
+    return lf.Modality.from_value(value)
+
+  def modality_refs_repr(self, value: Any) -> str:
+    with lf.modality.format_modality_as_ref(True):
+      return pg.format(
+          self.modalities(value),
+          compact=False,
+          verbose=False,
+          python_format=True,
+      )
+
 
 def complete(
     input_value: pg.Symbolic,

langfun/core/structured/mapping.py

@@ -107,7 +107,11 @@ class MappingExample(lf.NaturalLanguageFormattable, lf.Component):
 
   @classmethod
   def value_repr(
-      cls, value: Any, protocol: schema_lib.SchemaProtocol = 'python', **kwargs
+      cls,
+      value: Any,
+      protocol: schema_lib.SchemaProtocol = 'python',
+      use_modality_ref: bool = False,
+      **kwargs
   ) -> str:
     if isinstance(value, str):
       return value
@@ -116,7 +120,7 @@ class MappingExample(lf.NaturalLanguageFormattable, lf.Component):
         return str(value)
 
     # Placehold modalities if they are present.
-    if pg.contains(value, type=lf.Modality):
+    if use_modality_ref and pg.contains(value, type=lf.Modality):
       value = lf.ModalityRef.placehold(value)
     return schema_lib.value_repr(protocol).repr(value, **kwargs)
 
@@ -243,13 +247,7 @@ class Mapping(lf.LangFunc):
       {{ input_title }}:
       {{ example.input_repr(protocol, compact=False) | indent(2, True) }}
 
-      {% if has_modality_refs(example.input) -%}
-      {{ modality_refs_title }}:
-      {{ modality_refs_repr(example.input) | indent(2, True) }}
-
-      {% endif -%}
-
-      {%- if example.schema -%}
+      {% if example.schema -%}
       {{ schema_title }}:
       {{ example.schema_repr(protocol) | indent(2, True) }}
 
@@ -270,10 +268,6 @@ class Mapping(lf.LangFunc):
 
   schema_title: Annotated[str, 'The section title for schema.'] = 'SCHEMA'
 
-  modality_refs_title: Annotated[
-      str, 'The section title for modality refs.'
-  ] = 'MODALITY_REFERENCES'
-
   protocol: Annotated[
       schema_lib.SchemaProtocol,
       'The protocol for representing the schema and value.',
@@ -378,24 +372,3 @@ class Mapping(lf.LangFunc):
     """Gets additional symbol definitions besides schema as globals."""
     return {'ModalityRef': lf.modality.ModalityRef}
 
-  #
-  # Helper methods for handling modalities.
-  #
-
-  def has_modality_refs(self, value: Any) -> bool:
-    """Returns true if the value has modalities."""
-    return not isinstance(value, lf.Modality) and pg.contains(
-        value, type=lf.Modality
-    )
-
-  def modalities(self, value: Any) -> dict[str, lf.Modality]:
-    return lf.Modality.from_value(value)
-
-  def modality_refs_repr(self, value: Any) -> str:
-    with lf.modality.format_modality_as_ref(True):
-      return pg.format(
-          self.modalities(value),
-          compact=False,
-          verbose=False,
-          python_format=True,
-      )

langfun/core/structured/prompting_test.py

@@ -41,13 +41,17 @@ class QueryTest(unittest.TestCase):
       self,
       prompt,
       schema,
+      examples: list[mapping.MappingExample] | None = None,
       *,
       expected_snippet: str,
       exact_match: bool = False,
       expected_modalities: int = 0,
       **kwargs,
   ):
-    m = prompting.query(prompt, schema=schema, **kwargs, returns_message=True)
+    m = prompting.query(
+        prompt, schema=schema, examples=examples,
+        **kwargs, returns_message=True
+    )
     self.assertIsNotNone(m.lm_input)
     if exact_match:
       self.assertEqual(expected_snippet, m.lm_input.text)
@@ -265,24 +269,60 @@ class QueryTest(unittest.TestCase):
             INPUT_OBJECT:
               ```python
               [
-                ModalityRef(
-                  name='input[0]'
-                ),
-                ModalityRef(
-                  name='input[1]'
-                )
+                <<[[input[0]]]>>,
+                <<[[input[1]]]>>
               ]
               ```
-
-            MODALITY_REFERENCES:
-              {
-                'input[0]': <<[[input[0]]]>>,
-                'input[1]': <<[[input[1]]]>>
-              }
             """),
         expected_modalities=2,
     )
 
+  def test_structure_with_modality_and_examples_to_structure_render(self):
+    lm = fake.StaticResponse('["cat", "mouse"]')
+    self.assert_render(
+        [
+            modalities.Image.from_bytes(b'cat_image'),
+            modalities.Image.from_bytes(b'mouse_image'),
+        ],
+        list[str],
+        examples=[
+            mapping.MappingExample(
+                input=[modalities.Image.from_bytes(b'dog_image')],
+                schema=list[str],
+                output=['dog'],
+            ),
+        ],
+        lm=lm,
+        expected_snippet=inspect.cleandoc("""
+            INPUT_OBJECT:
+              ```python
+              [
+                <<[[examples[0].input[0]]]>>
+              ]
+              ```
+
+            OUTPUT_TYPE:
+              list[str]
+
+            OUTPUT_OBJECT:
+              ```python
+              [
+                'dog'
+              ]
+              ```
+
+
+            INPUT_OBJECT:
+              ```python
+              [
+                <<[[input[0]]]>>,
+                <<[[input[1]]]>>
+              ]
+              ```
+            """),
+        expected_modalities=3,
+    )
+
   def test_bad_protocol(self):
     with self.assertRaisesRegex(ValueError, 'Unknown protocol'):
       prompting.query('what is 1 + 1', int, protocol='text')

langfun/core/structured/schema.py

@@ -656,6 +656,8 @@ class ValuePythonRepr(ValueRepr):
         return object_code
       else:
         object_code = SchemaPythonRepr().result_definition(cls_schema)
+    elif isinstance(value, lf.Template):
+      return str(value)
     else:
       object_code = pg.format(
           value, compact=compact, verbose=verbose, python_format=True

langfun/core/structured/schema_test.py

@@ -18,6 +18,7 @@ import inspect
 import typing
 import unittest
 
+import langfun.core as lf
 from langfun.core.llms import fake
 from langfun.core.structured import schema as schema_lib
 import pyglove as pg
@@ -694,6 +695,10 @@ class ValuePythonReprTest(unittest.TestCase):
         schema_lib.ValuePythonRepr().repr(1, schema_lib.Schema(int)),
         '```python\n1\n```'
     )
+    self.assertEqual(
+        schema_lib.ValuePythonRepr().repr(lf.Template('hi, {{a}}', a='foo')),
+        'hi, foo'
+    )
     self.assertEqual(
         schema_lib.ValuePythonRepr().repr(
             A([Foo(1), Foo(2)], 'bar'), schema_lib.Schema(A), markdown=False,

{langfun-0.0.2.dev20240609.dist-info → langfun-0.0.2.dev20240611.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: langfun
-Version: 0.0.2.dev20240609
+Version: 0.0.2.dev20240611
 Summary: Langfun: Language as Functions.
 Home-page: https://github.com/google/langfun
 Author: Langfun Authors

{langfun-0.0.2.dev20240609.dist-info → langfun-0.0.2.dev20240611.dist-info}/RECORD

@@ -90,22 +90,22 @@ langfun/core/modalities/pdf_test.py,sha256=KE40zJD3Whe6ty2OULkp1J8jwLmB4ZjGXlGek
 langfun/core/modalities/video.py,sha256=sKcXxbx9S1ERjH8yEzkbtySpcRJD40QiPIQiIBy-U5I,955
 langfun/core/modalities/video_test.py,sha256=GbsoefSeO7y8kCYhTtp4s9E3ah_eYrb6Z-MXpS01RFc,2046
 langfun/core/structured/__init__.py,sha256=yp60yeDSVlyT0ElmLwbpBHnQtk_JX5udnjG1UGcsXKA,3776
-langfun/core/structured/completion.py,sha256=RzWdHyaqKj-tj6mGwpHXk0s8YbM0UEHSpyT2axmj-o8,7343
+langfun/core/structured/completion.py,sha256=cS2PjG7sqzDu5x0xoTk8RmNcoeX55iVwH38NTefkMHg,8108
 langfun/core/structured/completion_test.py,sha256=2mUzDMKGF_WGfTtsnfmfMDx97dkJ-98y8leen__qWLA,19281
 langfun/core/structured/description.py,sha256=SXW4MJvshFjbR-0gw6rE21o6WXq12UlRXawvDBXMZFA,5211
 langfun/core/structured/description_test.py,sha256=UtZGjSFUaQ6130t1E5tcL7ODu0xIefkapb53TbnqsK8,7362
 langfun/core/structured/function_generation.py,sha256=pFgS3vcRAWiuFBol2x5Eeip3XqoudONsOpeJpWyjT3s,7479
 langfun/core/structured/function_generation_test.py,sha256=ZJI-aaGgWWszn92u7h5IZ9Pl70N2DgAGGJrIxPzsvwg,10065
-langfun/core/structured/mapping.py,sha256=Vq3bQZWi4iYjcVn8D2kvPXTAm9jrQ-_1ueHLbXtGRNQ,12112
+langfun/core/structured/mapping.py,sha256=QKbSnvOgut-sx2mZPjHJcdlDLxR8b3ZC16ZLWociwog,11298
 langfun/core/structured/mapping_test.py,sha256=PiXklMeIa8L6KtMi3ju7J9Y39gZy0hIGz-Oeq4A_7XE,3835
 langfun/core/structured/parsing.py,sha256=keoVqEfzAbdULh6GawWFsTQzU91MzJXYFZjXGXLaD8g,11492
 langfun/core/structured/parsing_test.py,sha256=34wDrXaQ-EYhJLfDL8mX9K53oQMSzh5pVYdKjnESmK8,20895
 langfun/core/structured/prompting.py,sha256=vjmJn7GMFkqkrEB6qRrYvjB78WVx_OhsIyMN8PTb-7o,8641
-langfun/core/structured/prompting_test.py,sha256=8orqsTVDpDb_7oFZtGHtV_zRU_j_9RaOGH1QR8IurIU,21756
-langfun/core/structured/schema.py,sha256=7s6g9HSGogdWXnsX3_Pd8w8Cf1tKeFGtbNwxIG6l7lA,27664
+langfun/core/structured/prompting_test.py,sha256=W1FmbOfMXhBV8uZ3WN1fBxKLtdYngvR9l1JYo46HqJQ,22723
+langfun/core/structured/schema.py,sha256=oiT4P4Q9pG-QOnFzxETN2EQZqNln8nG4zAJHxcmeX9U,27729
 langfun/core/structured/schema_generation.py,sha256=U3nRQsqmMZg_qIVDh2fiY3K4JLfsAL1LcKzIFP1iXFg,5316
 langfun/core/structured/schema_generation_test.py,sha256=RM9s71kMNg2jTePwInkiW9fK1ACN37eyPeF8OII-0zw,2950
-langfun/core/structured/schema_test.py,sha256=P1Bm-khjbAebW6IDjop5dv1ddRD4pqL83FdK1VmfZPw,25108
+langfun/core/structured/schema_test.py,sha256=RjYhwTgktQgyqAjzLvo967nTiIK9KWgP-aNGg4e7ihE,25258
 langfun/core/structured/scoring.py,sha256=QyT1S8FkLtKICfUbh4AXoKK3YJ_rgejyk6TI2OtOa68,2751
 langfun/core/structured/scoring_test.py,sha256=39_dw6p_FkoqeUccO67yIqos-MccAWezoozS21i8mi0,1732
 langfun/core/templates/__init__.py,sha256=bO0eMsVJbi7sxEB2YlInKRQ2EVP-RyyKUwcD-8msuN4,927
@@ -117,8 +117,8 @@ langfun/core/templates/demonstration.py,sha256=vCrgYubdZM5Umqcgp8NUVGXgr4P_c-fik
 langfun/core/templates/demonstration_test.py,sha256=SafcDQ0WgI7pw05EmPI2S4v1t3ABKzup8jReCljHeK4,2162
 langfun/core/templates/selfplay.py,sha256=yhgrJbiYwq47TgzThmHrDQTF4nDrTI09CWGhuQPNv-s,2273
 langfun/core/templates/selfplay_test.py,sha256=rBW2Qr8yi-aWYwoTwRR-n1peKyMX9QXPZXURjLgoiRs,2264
-langfun-0.0.2.dev20240609.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-langfun-0.0.2.dev20240609.dist-info/METADATA,sha256=uyk0OoHbseBguRcn-EDVaDAun1goszVD5Dt1WO1BbZc,3550
-langfun-0.0.2.dev20240609.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-langfun-0.0.2.dev20240609.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
-langfun-0.0.2.dev20240609.dist-info/RECORD,,
+langfun-0.0.2.dev20240611.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+langfun-0.0.2.dev20240611.dist-info/METADATA,sha256=0L_yeRtnKYAVFwCrUnRakg8nE0W8iQsYlsOf0VKbg8Q,3550
+langfun-0.0.2.dev20240611.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+langfun-0.0.2.dev20240611.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
+langfun-0.0.2.dev20240611.dist-info/RECORD,,