Skip to main content

Metaprogramming infrastructure

Project description

Effectful is an algebraic effect system for Python, intended for use in the implementation of probabilistic programming languages. It is a core component of the ChiRho causal modeling language.

Installation

Install From Source

git clone git@github.com:BasisResearch/effectful.git
cd effectful
git checkout master
pip install -e .[pyro]

Install With Optional PyTorch/Pyro Support

effectful has optional support for:

  • PyTorch (tensors with named dimensions)

  • Pyro (wrappers for Pyro effects)

  • Jax (tensors with named dimensions)

  • Numpyro (operations for Numpyro distributions)

To enable PyTorch support:

pip install effectful[torch]

Pyro support (which includes PyTorch support):

pip install effectful[pyro]

Jax support:

pip install effectful[jax]

Numpyro support (which includes Jax support):

pip install effectful[numpyro]

Getting Started

Here’s an example demonstrating how effectful can be used to implement a simple DSL that performs arithmetic on terms with free variables.

import functools

from effectful.ops.types import Term
from effectful.ops.syntax import defdata, defop
from effectful.ops.semantics import handler, evaluate, coproduct, fwd

add = defdata.dispatch(int).__add__

def beta_add(x: int, y: int) -> int:
    match x, y:
        case int(), int():
            return x + y
        case _:
            return fwd()

def commute_add(x: int, y: int) -> int:
    match x, y:
        case Term(), int():
            return y + x
        case _:
            return fwd()

def assoc_add(x: int, y: int) -> int:
    match x, y:
        case _, Term(op, (a, b)) if op == add:
            return (x + a) + b
        case _:
            return fwd()

beta_rules = {add: beta_add}
commute_rules = {add: commute_add}
assoc_rules = {add: assoc_add}

eager_mixed = functools.reduce(coproduct, (beta_rules, commute_rules, assoc_rules))

We can represent free variables as operations with no arguments, generated using defop:

>>> x = defop(int, name="x")
>>> y = defop(int, name="y")

If we evaluate an expression containing free variables, we get a term:

>>> e = 1 + 1 + (x() + 1) + (5 + y())
>>> print(e)
add(2, add(add(x(), 1), add(5, y())))

We can make the evaluation strategy smarter by taking advantage of the commutativity and associativity of addition, as expressed by the commute_add and assoc_add handlers.

>>> with handler(eager_mixed):
>>>     print(evaluate(e))
add(8, add(x(), y()))

Learn More

More examples and API documentation can be found in the docs.

Project details


Download files

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

Source Distribution

effectful-0.3.1.tar.gz (140.0 kB view details)

Uploaded Source

Built Distribution

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

effectful-0.3.1-py3-none-any.whl (84.8 kB view details)

Uploaded Python 3

File details

Details for the file effectful-0.3.1.tar.gz.

File metadata

  • Download URL: effectful-0.3.1.tar.gz
  • Upload date:
  • Size: 140.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for effectful-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3840d80cd4d57384926659cc7aa8457d472d8d17049da752ec3a3a9c5a5f3bfd
MD5 b7d4b55c999051e9617bf7959e590b82
BLAKE2b-256 f32b93dfb96dbef5e485eb7724add480a431abb20418586b3bb361d9fb92d902

See more details on using hashes here.

File details

Details for the file effectful-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: effectful-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 84.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for effectful-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3752bb533e2d403cc2615ff7980c87bbb2f80528a2750402ef6da4dc6b0cda60
MD5 f7ebdd58d8e94c663b8d011ec91ba2e2
BLAKE2b-256 f30ef796f3a684d6e62f711e51b45c2419ab82d685766bb27c17651f4e7a5e70

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