langfun 0.0.2.dev20240717__py3-none-any.whl → 0.1.0__py3-none-any.whl

langfun/__init__.py

@@ -75,4 +75,4 @@ CodeError = coding.CodeError
 # pylint: enable=g-import-not-at-top
 # pylint: enable=g-bad-import-order
 
-__version__ = "0.0.2"
+__version__ = "0.1.0"

langfun/core/language_model.py

@@ -17,6 +17,7 @@ import abc
 import contextlib
 import dataclasses
 import enum
+import threading
 import time
 from typing import Annotated, Any, Callable, Iterator, Sequence, Tuple, Type, Union
 from langfun.core import component
@@ -728,6 +729,7 @@ class _UsageTracker:
 
   def __init__(self, model_ids: set[str] | None):
     self.model_ids = model_ids
+    self._lock = threading.Lock()
     self.usages = {
         m: LMSamplingUsage(0, 0, 0, 0) for m in model_ids
     } if model_ids else {}
@@ -735,10 +737,11 @@ class _UsageTracker:
   def track(self, model_id: str, usage: LMSamplingUsage):
     if self.model_ids is not None and model_id not in self.model_ids:
       return
-    if not isinstance(usage, UsageNotAvailable) and model_id in self.usages:
-      self.usages[model_id] += usage
-    else:
-      self.usages[model_id] = usage
+    with self._lock:
+      if not isinstance(usage, UsageNotAvailable) and model_id in self.usages:
+        self.usages[model_id] += usage
+      else:
+        self.usages[model_id] = usage
 
 
 @contextlib.contextmanager

langfun/core/modalities/image.py

@@ -14,7 +14,9 @@
 """Image modality."""
 
 import functools
+import io
 from langfun.core.modalities import mime
+from PIL import Image as pil_image
 
 
 class Image(mime.Mime):
@@ -28,3 +30,7 @@ class Image(mime.Mime):
 
   def _html(self, uri: str) -> str:
     return f'<img src="{uri}">'
+
+  def size(self) -> tuple[int, int]:
+    img = pil_image.open(io.BytesIO(self.to_bytes()))
+    return img.size

langfun/core/modalities/image_test.py

@@ -77,6 +77,12 @@ class ImageTest(unittest.TestCase):
       self.assertEqual(image._repr_html_(), '<img src="http://mock/web/a.png">')
       self.assertEqual(image.to_bytes(), image_content)
 
+  def test_image_size(self):
+    image = image_lib.Image.from_uri('http://mock/web/a.png')
+    with mock.patch('requests.get') as mock_requests_get:
+      mock_requests_get.side_effect = mock_request
+      self.assertEqual(image.size(), (24, 24))
+
 
 if __name__ == '__main__':
   unittest.main()

langfun/core/structured/prompting.py

@@ -193,6 +193,11 @@ def query(
   if isinstance(prompt, pg.Symbolic) and prompt.sym_partial and schema is None:
     schema = prompt.__class__
 
+  # Create a copy of the prompt if it has a parent object, so all child modality
+  # objects could be referred by path relative to the prompt.
+  if isinstance(prompt, lf.Template) and prompt.sym_parent:
+    prompt = prompt.clone()
+
   if schema in (None, str):
     # Query with natural language output.
     output = lf.LangFunc.from_value(prompt, **kwargs)(

langfun/core/structured/prompting_test.py

@@ -361,6 +361,17 @@ class QueryTest(unittest.TestCase):
             """),
     )
 
+  def test_query_prompt_with_unrooted_template(self):
+    output = prompting.query_prompt(
+        pg.Dict(
+            input=lf.Template(
+                'what is {{image}}',
+                image=modalities.Image.from_bytes(b'mock_image')
+            )
+        ).input,
+    )
+    self.assertIsNotNone(output.get_modality('image'))
+
   def test_query_output(self):
     self.assertEqual(
         prompting.query_output(

langfun-0.1.0.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.1
+Name: langfun
+Version: 0.1.0
+Summary: Langfun: Language as Functions.
+Home-page: https://github.com/google/langfun
+Author: Langfun Authors
+Author-email: langfun-authors@google.com
+License: Apache License 2.0
+Keywords: llm generative-ai machine-learning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-cloud-aiplatform >=1.5.0
+Requires-Dist: google-generativeai >=0.3.2
+Requires-Dist: jinja2 >=3.1.2
+Requires-Dist: openai ==0.27.2
+Requires-Dist: openpyxl >=3.1.0
+Requires-Dist: pandas >=2.1.4
+Requires-Dist: pyglove >=0.4.5.dev20240423
+Requires-Dist: python-docx >=0.8.11
+Requires-Dist: python-magic >=0.4.27
+Requires-Dist: requests >=2.31.0
+Requires-Dist: termcolor ==1.1.0
+Requires-Dist: tqdm >=4.64.1
+Requires-Dist: pillow >=10.1.0
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/google/langfun/main/docs/_static/logo.svg" width="520px" alt="logo"></img>
+</div>
+
+# Langfun
+
+[![PyPI version](https://badge.fury.io/py/langfun.svg)](https://badge.fury.io/py/langfun)
+[![codecov](https://codecov.io/gh/google/langfun/branch/main/graph/badge.svg)](https://codecov.io/gh/google/langfun)
+![pytest](https://github.com/google/langfun/actions/workflows/ci.yaml/badge.svg)
+
+[**Installation**](#install) | [**Getting started**](#hello-langfun) | [**Tutorial**](https://colab.research.google.com/github/google/langfun/blob/main/docs/notebooks/langfun101.ipynb)
+
+## Introduction
+
+Langfun is a [PyGlove](https://github.com/google/pyglove) powered library that
+aims to *make language models (LM) fun to work with*. Its central principle is
+to enable seamless integration between natural language and programming by
+treating language as functions. Through the introduction of *Object-Oriented Prompting*, 
+Langfun empowers users to prompt LLMs using objects and types, offering enhanced
+control and simplifying agent development.
+
+To unlock the magic of Langfun, you can start with
+[Langfun 101](https://colab.research.google.com/github/google/langfun/blob/main/docs/notebooks/langfun101.ipynb). Notably, Langfun is compatible with popular LLMs such as Gemini, GPT,
+Claude, all without the need for additional fine-tuning.
+
+## Why Langfun?
+
+Langfun is *powerful and scalable*:
+
+*   Seamless integration between natural language and computer programs.
+*   Modular prompts, which allows a natural blend of texts and modalities;
+*   Efficient for both request-based workflows and batch jobs;
+*   A powerful eval framework that thrives dimension explosions.
+
+Langfun is *simple and elegant*:
+
+*   An intuitive programming model, graspable in 5 minutes;
+*   Plug-and-play into any Python codebase, making an immediate difference;
+*   Comprehensive LLMs under a unified API: Gemini, GPT, Claude, Llama3, and more.
+*   Designed for agile developement: offering intellisense, easy debugging, with minimal overhead;
+
+## Hello, Langfun
+
+```python
+import langfun as lf
+import pyglove as pg
+
+from typing import Literal
+from IPython import display
+
+class Item(pg.Object):
+  name: str
+  size: Literal['large', 'medium', 'small']
+
+class ImageDescription(pg.Object):
+  items: list[Item]
+
+image = lf.Image.from_uri('https://upload.wikimedia.org/wikipedia/commons/thumb/8/83/Solar_system.jpg/1646px-Solar_system.jpg')
+display.display(image)
+
+desc = lf.query(
+    'Describe objects in {{my_image}} from top to bottom.',
+    ImageDescription,
+    lm=lf.llms.Gpt4o(api_key='<your-openai-api-key>'),
+    my_image=image,
+)
+print(desc)
+```
+*Output:*
+
+<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/83/Solar_system.jpg/1646px-Solar_system.jpg" width="520px" alt="my_image"></img>
+
+```
+ImageDescription(
+  items = [
+    0 : Item(
+      name = 'Mercury',
+      color = 'Gray'
+    ),
+    1 : Item(
+      name = 'Venus',
+      color = 'Yellow'
+    ),
+    2 : Item(
+      name = 'Earth',
+      color = 'Blue and white'
+    ),
+    3 : Item(
+      name = 'Moon',
+      color = 'Gray'
+    ),
+    4 : Item(
+      name = 'Mars',
+      color = 'Red'
+    ),
+    5 : Item(
+      name = 'Jupiter',
+      color = 'Brown and white'
+    ),
+    6 : Item(
+      name = 'Saturn',
+      color = 'Yellowish-brown with rings'
+    ),
+    7 : Item(
+      name = 'Uranus',
+      color = 'Light blue'
+    ),
+    8 : Item(
+      name = 'Neptune',
+      color = 'Dark blue'
+    )
+  ]
+)
+```
+See [Langfun 101](https://colab.research.google.com/github/google/langfun/blob/main/docs/notebooks/langfun101.ipynb) for more examples.
+
+## Install
+
+```
+pip install langfun
+```
+
+Or install nightly build with:
+
+```
+pip install langfun --pre
+```
+
+
+
+*Disclaimer: this is not an officially supported Google product.*

{langfun-0.0.2.dev20240717.dist-info → langfun-0.1.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-langfun/__init__.py,sha256=P62MnqA6-f0h8iYfQ3MT6Yg7a4qRnQeb4GrIn6dcSnY,2274
+langfun/__init__.py,sha256=mPN6TszWxnQKhlnMGvEvu56etujXb1Zcy4DDMUy1IH8,2274
 langfun/core/__init__.py,sha256=Mdp1a2YnXdSmfTfbUwuAnEWYbjA3rXXGtbxl5fljZyg,4812
 langfun/core/component.py,sha256=Icyoj9ICoJoK2r2PHbrFXbxnseOr9QZZOvKWklLWNo8,10276
 langfun/core/component_test.py,sha256=q15Xn51cVTu2RKxZ9U5VQgT3bm6RQ4638bKhWBtvW5o,8220
@@ -8,7 +8,7 @@ langfun/core/console.py,sha256=bk5rNPNm9rMGW5YT2HixxU04p2umnoabn5SDz6Dqe88,2317
 langfun/core/console_test.py,sha256=5SYJdxpJGLgdSSQqqMPoA1X6jpsLD8rgcyk-EgI65oE,1077
 langfun/core/langfunc.py,sha256=RvIcRjIq0jWYRu1xim-FYe4HSrt97r3GMBO_PuagUmw,11060
 langfun/core/langfunc_test.py,sha256=lyt-UzkD8972cxZwzCkps0_RMLeSsOBrcUFIW-fB6us,8653
-langfun/core/language_model.py,sha256=tHB2otsHx-EM4TaDNgXZ-qvnhJXNJKuK2-OdseQzGdI,23948
+langfun/core/language_model.py,sha256=ihcLy7WWrUByZ4Yfikb2OBppM6QGwMyjTYecBzelNCs,24028
 langfun/core/language_model_test.py,sha256=TlNmVUfBfDQZzIiiBqCBTrxgcoyj2qNp3kONvmr2pX4,21273
 langfun/core/logging.py,sha256=FyZRxUy2TTF6tWLhQCRpCvfH55WGUdNgQjUTK_SQLnY,5320
 langfun/core/logging_test.py,sha256=qvm3RObYP3knO2PnXR9evBRl4gH621GnjnwywbGbRfg,1833
@@ -79,8 +79,8 @@ langfun/core/memories/conversation_history_test.py,sha256=AaW8aNoFjxNusanwJDV0r3
 langfun/core/modalities/__init__.py,sha256=F8P72IwFiTpEseTR2tYEJyQMlDW7fd9csvGJquLKJNg,1269
 langfun/core/modalities/audio.py,sha256=Qxo7bYjLKQ1gVJVomr9RqR2SvxY826QgXhTzzk437Sk,952
 langfun/core/modalities/audio_test.py,sha256=gWCB9h3FyrdGqro3ajBXqkw0lU0W1sBjOOq6wZbl7Fg,2027
-langfun/core/modalities/image.py,sha256=qi7B9uYLxBoKvMzApdOQNpVcp_dKaRwLzeshg2nvo9k,926
-langfun/core/modalities/image_test.py,sha256=qU7G4ucUihIQ9ZB453FsUfcOipUYx5TnnuoMB1GIMfE,3034
+langfun/core/modalities/image.py,sha256=sMMmjNYUTdPViDOqc93WtSFrzE1-GRrEv-6I3eb8iYY,1083
+langfun/core/modalities/image_test.py,sha256=Rcq4b77E9-Vp6rhqJ5ZIh0yJkEtcJbZZwjTjlu9dx8E,3282
 langfun/core/modalities/mime.py,sha256=7oYvwYZHb3uhjiL2rF6kvQWsWufY0UXl72wfDXC59ys,5918
 langfun/core/modalities/mime_test.py,sha256=kmRiPP-3Py02NnKPu0oPexSIJ-MXaaE2UYY82ga0TV8,2913
 langfun/core/modalities/ms_office.py,sha256=jOidMSdWCaV9RILpGz8VJkpTSpHJNoirD53jzQvcytM,3388
@@ -100,8 +100,8 @@ langfun/core/structured/mapping.py,sha256=QKbSnvOgut-sx2mZPjHJcdlDLxR8b3ZC16ZLWo
 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=W1FmbOfMXhBV8uZ3WN1fBxKLtdYngvR9l1JYo46HqJQ,22723
+langfun/core/structured/prompting.py,sha256=_U6Z65AwXvVvfaQFCY9GawB_QV9S3u7P7BOU2URABmw,8873
+langfun/core/structured/prompting_test.py,sha256=Yc5GevbTyxtW6FAORXiqzakcuoJF-IPjoZ8kvLJW5is,23057
 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
@@ -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.dev20240717.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-langfun-0.0.2.dev20240717.dist-info/METADATA,sha256=Ho6QyM-oWmPyKZ5Q5S6Zh7gh1R00X_cyS-0ChbUCzRU,3550
-langfun-0.0.2.dev20240717.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-langfun-0.0.2.dev20240717.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
-langfun-0.0.2.dev20240717.dist-info/RECORD,,
+langfun-0.1.0.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+langfun-0.1.0.dist-info/METADATA,sha256=MUO2hj8fPm1zMlG9yIN8x0Ct1zisC39u769k5TlPJG0,5293
+langfun-0.1.0.dist-info/WHEEL,sha256=-oYQCr74JF3a37z2nRlQays_SX2MqOANoqVjBBAP2yE,91
+langfun-0.1.0.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
+langfun-0.1.0.dist-info/RECORD,,

{langfun-0.0.2.dev20240717.dist-info → langfun-0.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (71.0.3)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

langfun-0.0.2.dev20240717.dist-info/METADATA

@@ -1,103 +0,0 @@
-Metadata-Version: 2.1
-Name: langfun
-Version: 0.0.2.dev20240717
-Summary: Langfun: Language as Functions.
-Home-page: https://github.com/google/langfun
-Author: Langfun Authors
-Author-email: langfun-authors@google.com
-License: Apache License 2.0
-Keywords: llm generative-ai machine-learning
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Libraries
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: google-cloud-aiplatform >=1.5.0
-Requires-Dist: google-generativeai >=0.3.2
-Requires-Dist: jinja2 >=3.1.2
-Requires-Dist: openai ==0.27.2
-Requires-Dist: openpyxl >=3.1.0
-Requires-Dist: pandas >=2.1.4
-Requires-Dist: pyglove >=0.4.5.dev20240423
-Requires-Dist: python-docx >=0.8.11
-Requires-Dist: python-magic >=0.4.27
-Requires-Dist: requests >=2.31.0
-Requires-Dist: termcolor ==1.1.0
-Requires-Dist: tqdm >=4.64.1
-
-<div align="center">
-<img src="https://raw.githubusercontent.com/google/langfun/main/docs/_static/logo.svg" width="520px" alt="logo"></img>
-</div>
-
-# Langfun
-
-[![PyPI version](https://badge.fury.io/py/langfun.svg)](https://badge.fury.io/py/langfun)
-[![codecov](https://codecov.io/gh/google/langfun/branch/main/graph/badge.svg)](https://codecov.io/gh/google/langfun)
-![pytest](https://github.com/google/langfun/actions/workflows/ci.yaml/badge.svg)
-
-[**Installation**](#install) | [**Getting started**](#hello-world)
-
-## What is Langfun
-
-Langfun is a Python library that aims to make language models (LM) fun
-to work with. Its design enables a programming model that flows naturally,
-resembling the human thought process. It emphasizes the reuse and combination of
-language pieces to form prompts, thereby accelerating innovation. In contrast to
-other LM frameworks, which feed program-generated data into the LM, langfun
-takes a distinct approach: It starts with natural language, allowing for
-seamless interactions between language and program logic, and concludes with
-natural language and optional structured output. Consequently, langfun can
-aptly be described as Language as functions, capturing the core of its
-methodology.
-
-## Install
-
-```
-pip install langfun
-```
-
-Or install nightly build with:
-
-```
-pip install langfun --pre
-```
-
-## Hello World
-
-```python
-import langfun as lf
-
-class NumericAnswerExtractor(lf.LangFunc):
-  """Numeric answer extractor.
-
-  Here is my question:
-  {{question}}
-
-  Here is the response:
-  {{question()}}
-
-  Can you help me extract a number from the response as the answer to my
-  question? Your response should only contain a number in numeric form.
-  If the answer is not a number or you cannot extract it, respond with UNKNOWN.
-  """
-  output_transform = lf.transforms.Match('\d+').to_int()
-
-l = NumericAnswerExtractor()
-
-with lf.context(lm=lf.llms.Gpt35(debug=True)):
-  r = l(question=lf.LangFunc('What is result of {{x}} plus {{y}}?'),
-        x='one',
-        y='two')
-  print('Result:', r.result)
-```
-
-*Disclaimer: this is not an officially supported Google product.*