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.2.2.tar.gz (97.6 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.2.2-py3-none-any.whl (64.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectful-0.2.2.tar.gz
Algorithm Hash digest
SHA256 752412de879f4e825663c67022eb29c45f5faad958246b89e21d56c58c0e0722
MD5 14d19390b9d84367fdee350f5eb70700
BLAKE2b-256 42fe69b220b6377dfe25baeaa5d5daa4986d5aa612973e4b0186af1cfa49e485

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectful-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 21180c27d108fd4d8be811b6125dc3db58a458f0b408c7331ac6d53182e71569
MD5 70858e5c5917e5ec7c48d7ea0b4f37e8
BLAKE2b-256 da0ee6a0305e351b22071ff1a94bacbf4f85758aaf0ebf0b6a853ea6c82d7a03

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