Skip to main content

A Python library for quantitative reasoning.

Project description

formative

Python library for quantitative reasoning.

Requirements

  • Python 3.10+

Installation

pip install formative-ds

Docs

Comprehensive documentation is available at docs.getformative.dev.

Usage

Causal estimation

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.

Decision rules

from formative.game import maximin, maximax, hurwicz, laplace, minimax_regret

outcomes = {
    "stocks": {"recession": -20, "stagnation":  5, "growth": 30},
    "bonds":  {"recession":   5, "stagnation":  5, "growth":  7},
    "cash":   {"recession":   2, "stagnation":  2, "growth":  2},
}

maximin(outcomes).solve()        # safest choice (best worst case)
maximax(outcomes).solve()        # most optimistic (best best case)
hurwicz(outcomes, alpha=0.5).solve()  # blend of optimism and pessimism
laplace(outcomes).solve()        # highest average payoff
minimax_regret(outcomes).solve() # lowest worst-case regret

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-1.2.0.tar.gz (145.0 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-1.2.0-py3-none-any.whl (53.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for formative_ds-1.2.0.tar.gz
Algorithm Hash digest
SHA256 cafea79fa7e83e8a197a0d1d938e7d5ffa3693809d0adc51bb0cdfee7d887079
MD5 266889a6a0ed6759e140d36af0c208d6
BLAKE2b-256 e8bd2629a83c87a4fb5887e9462d8820ef2a621e2f45729c893a4781b2a92376

See more details on using hashes here.

Provenance

The following attestation bundles were made for formative_ds-1.2.0.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-1.2.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for formative_ds-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e800f37c26675d2195231bdf509384f9da0816d6819fd41110db253abd8745f4
MD5 1b20a3beb86fcda196a35d5b47db610a
BLAKE2b-256 73724b856b58a50fcca8e7d40772e2b27e0ff57ef75761515485d00f886dcfa7

See more details on using hashes here.

Provenance

The following attestation bundles were made for formative_ds-1.2.0-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