Skip to main content

Formula-first generalized additive models with a high-performance Rust core

Project description

gamfit

PyPI Python Docs License

Formula-based generalized additive models for Python, backed by a Rust engine.

gamfit fits Gaussian, binomial (including Bernoulli marginal-slope), Poisson, and Gamma GLMs with smooth terms, random effects, bounded/constrained coefficients, location-scale extensions, survival likelihoods, and flexible/learnable links. Smoothing parameters are selected by REML or LAML. Posterior sampling uses NUTS where supported, and a Gaussian Laplace approximation otherwise.

Manifold smooths handle predictor spaces that wrap or close: circles, cylinders, tori, and the sphere (intrinsic Wahba and spherical-harmonic kernels), plus periodic tensor products and boundary-conditioned B-splines. The Möbius example in the gallery is a 4π-periodic double-cover parameterization, not a twisted Möbius-strip basis.

rotating recovery of a trefoil knot, latent-free loop, wobbly cylinder, lumpy sphere, bumpy torus, and Möbius double-cover from noisy 3-D point clouds

Docs: https://gamfit.readthedocs.io/.

Install

uv add gamfit

Wheels are published for Linux (x86_64, aarch64), macOS (x86_64, Apple silicon), and Windows. No Rust toolchain is required.

Example

import gamfit

train = [
    {"y": 1.2, "x": 0.0},
    {"y": 1.9, "x": 1.0},
    {"y": 3.1, "x": 2.0},
    {"y": 4.5, "x": 3.0},
]

model = gamfit.fit(train, "y ~ s(x)")
print(model.predict([{"x": 1.5}, {"x": 2.5}], interval=0.95))
print(model.summary())
model.save("model.gam")

pandas, polars, pyarrow, numpy, dict-of-columns, and list-of-records inputs are all accepted without conversion.

Features

  • Polyharmonic / Duchon smooths combine magnitude, gradient, and curvature penalty operators on the same basis. P-spline and thin-plate smooths use their standard derivative penalties. Each penalized block has its own smoothing parameter.
  • Flexible link functions: flexible(base) adds a spline offset on a base link; blended(...) learns a mixture weight; sas and beta-logistic learn shape parameters.
  • Surface smooths in arbitrary dimension: thin-plate, Duchon (scale-free by default, hybrid with length_scale=...), and Matérn, with automatic knot placement.
  • Manifold smooths: periodic 1-D, cylinder / torus tensor products, intrinsic sphere (Wahba kernel or spherical harmonics), and boundary-conditioned B-splines.
  • Per-axis anisotropy inside a single joint smooth.
  • Marginal-slope models that separate baseline risk from a calibrated score's effect, for Bernoulli and survival outcomes.
  • Posterior sampling via NUTS where supported, Gaussian Laplace otherwise, behind one API.

API examples

import gamfit
from gamfit.sklearn import GAMRegressor, GAMClassifier

# Validate before you fit
gamfit.validate_formula(train, "y ~ s(x) + group(site)")

# Posterior sampling and mean bands
posterior = model.sample(train, seed=42)
bands = posterior.predict(test, level=0.95)

# Survival
gamfit.fit(df,
    "Surv(entry, exit, event) ~ s(age) + bmi + timewiggle(internal_knots=6)",
    survival_likelihood="transformation",
    baseline_target="weibull",
)

# scikit-learn
est = GAMRegressor(formula="y ~ s(x)")
est.fit(X, y)

# Diagnose, plot, report
model.diagnose(train).metrics
model.plot(train, x="x", kind="prediction")
model.report("report.html")

Public API

Symbol Purpose
gamfit.fit(data, formula, **kwargs) Fit a model.
gamfit.load(path) / gamfit.loads(bytes) Reload a saved model.
gamfit.load_posterior(path) Reload a PosteriorSamples archive.
gamfit.validate_formula(data, formula, ...) Type-check a formula without fitting.
gamfit.build_info() Native extension build metadata.
gamfit.cuda_diagnostics() / gamfit.format_cuda_diagnostics() CUDA probe results.
gamfit.explain_error(exc) Human-readable hint for a gamfit exception.
gamfit.Model Fitted model: predict, summary, check, diagnose, plot, report, sample, save.
gamfit.SurvivalPrediction Per-row hazard / survival surface.
gamfit.CompetingRisksPrediction, competing_risks_cif Competing-risks CIF evaluation.
gamfit.SamplingConfig, PosteriorSamples, PosteriorPredictive, PairedPosteriorSamples Posterior interface.
gamfit.ResponseGeometryModel, sphere_frechet_mean, simplex_frechet_mean, alr, clr, closure Response-geometry utilities.
gamfit.sklearn.GAMRegressor / GAMClassifier scikit-learn estimators.

Full reference: https://gamfit.readthedocs.io/en/latest/api-reference/.

Optional extras

uv add "gamfit[pandas]"     # pandas + pyarrow input/output
uv add "gamfit[plot]"       # matplotlib-based plotting
uv add "gamfit[sklearn]"    # scikit-learn integration
uv add "gamfit[torch]"      # PyTorch bridge
uv add "gamfit[all]"        # everything

GPU acceleration

CUDA support (cuBLAS / cuSOLVER / cuSPARSE) is built into the same wheel; there is no separate gamfit-gpu package. Per-op dispatch thresholds are derived at probe time from measured GPU FP64 throughput, CPU FP64 throughput, and PCIe bandwidth, so small kernels stay on the CPU. Inspect the calibrated thresholds with gamfit.build_info()["cuda_diagnostics"] or gamfit.format_cuda_diagnostics().

If both a system CUDA toolkit and pip nvidia-*-cu12 wheels are present in the same environment, gamfit warns once per conflict-set and continues; glibc resolves dlopen(SONAME) to a single file, so this is usually benign. If you use gamfit with torch, install a torch build whose CUDA suffix matches your driver.

License

AGPL-3.0-or-later. See LICENSE.

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

gamfit-0.1.123.tar.gz (3.7 MB view details)

Uploaded Source

Built Distributions

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

gamfit-0.1.123-cp310-abi3-win_amd64.whl (15.6 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.123-cp310-abi3-musllinux_1_2_x86_64.whl (14.9 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ x86-64

gamfit-0.1.123-cp310-abi3-musllinux_1_2_aarch64.whl (12.9 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.123-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.6 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ x86-64

gamfit-0.1.123-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.123-cp310-abi3-macosx_11_0_arm64.whl (12.5 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.123-cp310-abi3-macosx_10_12_x86_64.whl (14.1 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file gamfit-0.1.123.tar.gz.

File metadata

  • Download URL: gamfit-0.1.123.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for gamfit-0.1.123.tar.gz
Algorithm Hash digest
SHA256 f0ea89802c41cedb161fe5154f58dbd8a0e496ea1bb893f0d654cd2203553c20
MD5 7e5d15b415a97eb0460c3748d3265df7
BLAKE2b-256 dbea36db3a5c712259f20494b3e737f29c015356bf049f649cdfe90f3a6e589d

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: gamfit-0.1.123-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 15.6 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 73aae9d0cdba1d7cf5badf4c2f3e1d8ed077c75c5d209ed35db7e008d4d1d7b2
MD5 57f1d8125ce70e5dec07eeb7a4a790f5
BLAKE2b-256 87b7d4c0c7893cff8df376fe179aa16b2278a290734c69b2e01244edf0e3c311

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 b557dbdf97227246b13985c2d90379ea5270d895c1e5f6f3acc568373ee20257
MD5 24a5a6646f0ce095c78fc54bdb8a348b
BLAKE2b-256 8f29f0f049f72469064f506642b0e7441b36fd7ff94515396d70b4cbb872ba69

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 a76a433ab286155ef58f76e6514c2ae4723863f4b48a63cf7007c7d415162294
MD5 09225d974d628dc3d2075e2bff2450ed
BLAKE2b-256 1111a3f255a3b638a72617f8eb67ea02d71f70f175b5381abbe3402243549c3a

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 477af0201ecacebf602b45ae1bc1dc76a6af64cdee095c7283c48508071fb634
MD5 41a81933b8c6b9dddb381ae3520a9f6e
BLAKE2b-256 887c027e544670b2e3299e735193dea7142c34a53951bb15bc7c8e68992b3225

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 738ad0a611e85e88fcb819e20f6163396d0580875dfea96a7f018664dbb1170a
MD5 f6c866b80efdcefceae4c3d68ffa38d7
BLAKE2b-256 8aa4cd7a8578d162e3fcb085eed26ecad62b79657f9e18a13abac3a8044ebd84

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cc25e8b399d6fa3d0a6e96029235d4952402a3f43017fc5c4d2cf0df7e01d372
MD5 481a386df6d1878e1e7a556146ab8647
BLAKE2b-256 415d3423247d01efa9ba353904b055edc05cd954b526257bd884ac2d48b51e89

See more details on using hashes here.

File details

Details for the file gamfit-0.1.123-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for gamfit-0.1.123-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 177e62cc9d27bbac0e243cc486becabcdebf9209ba8833d21253786d07020c72
MD5 d09c878b72643ef07975a073396d289e
BLAKE2b-256 3733fe9918d9aaabc2340df985bd38cc4d22211194dd5b1fc2e750e0adcde6c3

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