Skip to main content

A Python library for causal effect estimation.

Project description

formative

Python library for causal effect estimation. You declare your causal assumptions as a DAG before choosing an estimation method, making identification explicit rather than implicit.

Requirements

  • Python 3.11+

Installation

pip install formative

Docs

Comprehensive documentation is available at docs.getformative.dev.

Usage

from formative import DAG, OLSObservational

dag = DAG()
dag.assume("ability").causes("education", "income")
dag.assume("education").causes("income")

result = OLSObservational(
    dag,
    treatment="education",
    outcome="income"
).fit(df)

print(result.summary())

Confounders declared in the DAG are controlled for automatically. If a confounder is absent from the dataframe, an IdentificationError is raised before any estimation runs. See online documentation at docs.getformative.dev for more examples and details.

Local development

Requires uv.

git clone https://github.com/maxpagels/formative
cd formative
uv sync --dev

This creates a .venv, installs all dependencies, and installs the package in editable mode.

Releasing a new version

uvx bump-my-version bump patch   # 0.1.0 → 0.1.1 (bug fixes)
uvx bump-my-version bump minor   # 0.1.0 → 0.2.0 (new features)
uvx bump-my-version bump major   # 0.1.0 → 1.0.0 (breaking changes)
git push --follow-tags            # triggers publish to PyPI

Running tests

uv run pytest

Importing without installing

To use formative from a script outside this repo without installing it, either prepend the path at runtime:

import sys
sys.path.insert(0, "/path/to/formative")

from formative import DAG, OLSObservational

Or set PYTHONPATH before running:

PYTHONPATH=/path/to/formative python your_script.py

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

formative_ds-0.1.1.tar.gz (107.3 kB view details)

Uploaded Source

Built Distribution

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

formative_ds-0.1.1-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file formative_ds-0.1.1.tar.gz.

File metadata

  • Download URL: formative_ds-0.1.1.tar.gz
  • Upload date:
  • Size: 107.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for formative_ds-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0cfbd8ed9e1c4052731eb54dbec75e176b095789f38ca1c7a127875f6d119db0
MD5 f726ee7b8fd3cce8ed981dc70e3038fc
BLAKE2b-256 ae55cc93db1c96c69b874f3bdeb1c28fda658de9201af1e17859da84768fbea7

See more details on using hashes here.

Provenance

The following attestation bundles were made for formative_ds-0.1.1.tar.gz:

Publisher: publish.yml on maxpagels/formative

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file formative_ds-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: formative_ds-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for formative_ds-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a083868093ff9ac588a308699148a532ad4f6da34d4c7de6222528740a8664cc
MD5 d0de45390f814993af934eba082d1afc
BLAKE2b-256 8fa207d3b92fa133f88affce81aae679de2386522d1e0859ec08514f39cc6b25

See more details on using hashes here.

Provenance

The following attestation bundles were made for formative_ds-0.1.1-py3-none-any.whl:

Publisher: publish.yml on maxpagels/formative

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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