Skip to main content

Langfun: Language as Functions.

Project description

logo

Langfun

PyPI version codecov pytest

Installation | Getting started | Tutorial | Discord community

Introduction

Langfun is a 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. 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

import langfun as lf
import pyglove as pg

from IPython import display

class Item(pg.Object):
  name: str
  color: str

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:

my_image

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 for more examples.

Install

Langfun offers a range of features through Extras, allowing users to install only what they need. The minimal installation of Langfun requires only PyGlove, Jinja2, and requests. To install Langfun with its minimal dependencies, use:

pip install langfun

For a complete installation with all dependencies, use:

pip install langfun[all]

To install a nightly build, include the --pre flag, like this:

pip install langfun[all] --pre

If you want to customize your installation, you can select specific features using package names like langfun[X1, X2, ..., Xn], where Xi corresponds to a tag from the list below:

Tag Description
all All Langfun features.
vertexai VertexAI access.
mime All MIME supports.
mime-auto Automatic MIME type detection.
mime-pil Image support for PIL.
ui UI enhancements

For example, to install a nightly build that includes VertexAI access, full modality support, and UI enhancements, use:

pip install langfun[vertexai,mime,ui] --pre

Solving import issue with libmagic

Langfun utilizes libmagic for automatic MIME type detection to support multi-modal functionalities. However, pip install libmagic may not work out-of-the-box on all operation systems, sometimes leading to an 'ImportError: failed to find libmagic.' error after Langfun installation.

If you encounter this error, you will need to follow the recommendations below to fix the installation of libmagic library.

OSX

conda install conda-forge::libmagic

Windows:

pip install python-magic
pip uninstall python-magic-bin
pip install python-magic-bin

Disclaimer: this is not an officially supported Google product.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langfun-0.1.2.dev202505220804.tar.gz (280.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langfun-0.1.2.dev202505220804-py3-none-any.whl (398.1 kB view details)

Uploaded Python 3

File details

Details for the file langfun-0.1.2.dev202505220804.tar.gz.

File metadata

  • Download URL: langfun-0.1.2.dev202505220804.tar.gz
  • Upload date:
  • Size: 280.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for langfun-0.1.2.dev202505220804.tar.gz
Algorithm Hash digest
SHA256 914ba6617c017ee51e6d7fae50055a4085f8c045943761a34982d393674b5224
MD5 e20c008b04e9c84e0ca00d3d32165cab
BLAKE2b-256 677ad6e37b8d25530afefb87144c869b533eae7c2536ed0a119996d00c57af90

See more details on using hashes here.

File details

Details for the file langfun-0.1.2.dev202505220804-py3-none-any.whl.

File metadata

File hashes

Hashes for langfun-0.1.2.dev202505220804-py3-none-any.whl
Algorithm Hash digest
SHA256 5bae4b02f54bd9dcc7c2e1b72ac97114417201f9a1883534001ecb105eec1ada
MD5 8e02dcc208b02a4d776bfff289862165
BLAKE2b-256 2577ae85647f7a70f4b010a761acf711d29afe99ed6c940506cd5eaaafa4feae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page