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.113.tar.gz (3.3 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.113-cp310-abi3-win_amd64.whl (14.4 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.113-cp310-abi3-musllinux_1_2_x86_64.whl (13.7 MB view details)

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

gamfit-0.1.113-cp310-abi3-musllinux_1_2_aarch64.whl (12.0 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.113-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (13.6 MB view details)

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

gamfit-0.1.113-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (11.9 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

gamfit-0.1.113-cp310-abi3-macosx_11_0_arm64.whl (11.6 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.113-cp310-abi3-macosx_10_12_x86_64.whl (13.0 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: gamfit-0.1.113.tar.gz
  • Upload date:
  • Size: 3.3 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.113.tar.gz
Algorithm Hash digest
SHA256 24c4bbe72c5739973bb6b05741d26ef399ac9a12a470caf036a675dced2f9b86
MD5 824b84c26877225af07d3ba4d869592e
BLAKE2b-256 4792f4d6a6d2db60517c99b4817b20536b456b09930808393093253f9ee1b4eb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.113-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 14.4 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.113-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d186be702bed273e9e51c836a0ac635d8c1bb2bb8a5e525330bf55b5a4bbed22
MD5 7c1b8b8794bf0a71ff369ee232ad80e7
BLAKE2b-256 87d9924d7750e04b5830b6e7cced0a75f051ee76c7756f5aa0af4cb25f9893d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.113-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 6f714c84cf1cc0b177182b4d0f94acb0a630394731c8ce0de761d029c35c34f9
MD5 a29555a64f7edb7bbdb2010e00b2c952
BLAKE2b-256 7f1fb5790527f9d93b5a68e6f006c7be7205d9d2aed2131cbd1a7ad57851b5e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.113-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 bbc223d30f2e9bb4c86dc8cf3eb9d9216b41925beae61db8b7abc66869e73f77
MD5 829d67bb1610ecca7fa80189275a8735
BLAKE2b-256 7d54c9c30a23db1251245d6db684c564f22493be7288d8a22179e17f5eda807a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.113-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0fdd61e729bd6d098c5c221ee06b47122c361368a988fb9fc9c6d30c52a3f0a8
MD5 3f0b424ed74bc295bd1af5b98b13f8a7
BLAKE2b-256 e237eac62c2bcb4ee476f679b08629c6a14111e250ef989861202b47e3a8be9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.113-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 b22648129f9ab1629df201c94303ca5769d6d6078d06216dbb145c6e3f1ed863
MD5 4431360bee574660c78487aa9ebfa2d2
BLAKE2b-256 ae68edabdc0a8b7e551d6734b46df117cf310ced8caaf431268df5026061ec92

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.113-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0ae99718d67d9dfa90b9c3b19f13452e3bc97262057fdde3bd7b7930ac6ca043
MD5 b7f4fbb96b3ebb813de64f86f87beb6a
BLAKE2b-256 7def066aedde70f497f8f8e9fa777309db2588cc08d064e9a7431a12d689bcf7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.113-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 fea2de004484b72ba228a74169f50be8a395340c1157224022a321389ff74213
MD5 f9e19e66439486e1569ccb1baef69a2a
BLAKE2b-256 f5ec9df63c7a4d28554491a2fe0078834f4a1048dd77e53d4d0825f1c35a70a3

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