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


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.110.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.110-cp310-abi3-win_amd64.whl (14.4 MB view details)

Uploaded CPython 3.10+Windows x86-64

gamfit-0.1.110-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.110-cp310-abi3-musllinux_1_2_aarch64.whl (12.0 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

gamfit-0.1.110-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.110-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.110-cp310-abi3-macosx_11_0_arm64.whl (11.6 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

gamfit-0.1.110-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.110.tar.gz.

File metadata

  • Download URL: gamfit-0.1.110.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.110.tar.gz
Algorithm Hash digest
SHA256 b6f3fa2df70ea31045878e20f30b73de3ffb0f66db76f9d9c4ea52fb23b13fa6
MD5 1e9bd9a9768ee6ade00920fd03bd545c
BLAKE2b-256 46e3337355095e4884e5033d4f45847c2c2a79c180e7ff82b08f84ac8045cec8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gamfit-0.1.110-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.110-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 cdc68c46f5535cf5e8a1b621410a2fb61ff7821ccbc14a0267bdbb7d3cf26087
MD5 ff6616b380bc93421c8204acd3938a0e
BLAKE2b-256 18ce2cea283a87471345befaad948aeecc7c905308259de4c4db693bdcc7cde7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.110-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 bf0832a96281d3dabdc7956f4ecf02831eba5abe1e512ab4da0f7abc0dc12d2f
MD5 7a1be35953a3bd572c8a8662deb3ad09
BLAKE2b-256 f7fbe8b364d4b6f728a433ebd904aad36f48a78ca2c52f61bae34387a3a48d3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.110-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 de42388fb8e574eb66e69d5da433e073b6bd2cebd7a380e78a2b289dce6715fc
MD5 53286e9805bf927febfa29767b8b89d0
BLAKE2b-256 ceaa45c1a09f7b0b9063dd11dfddf0ceef5cec9d379e4b3b13fe00e2038c32f9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.110-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 860e80876b1ddf8d6ea6425a3ee79db4cc5a36681d6aaf46e64177a96f5bf66c
MD5 b6e919dd3b6903dfe09339dccf8a9f1d
BLAKE2b-256 f2033033099a31e7457008c943e0331555ea74f6d5e8716b5ac73b89fc23d533

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.110-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 e970b85ea539b9ce1901e9615fd00af577ed1dff7e4406f98d68f23a25e5b179
MD5 cee3d73ff3f3c0c6b2dfae3a75778105
BLAKE2b-256 e517ea0c71b653359e435103c366910b76dab5bf1b6ee02a9a79770d263c676e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.110-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e79cf7fe2ba986aa90c8360c6c245ee4672fe3407e5e4b4810e41227e797905b
MD5 31209591b593152eb656ec2ce0e5198d
BLAKE2b-256 015b1f8800967e0bc2147a94d65d41e4d98a5bd58486003980fc5634b786627e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gamfit-0.1.110-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 41c5f3743fe5993480c89d687d7993ebf69463abe38e7b520a213b783d06588f
MD5 1fef4218964d07dffeb00e91b6c12bf0
BLAKE2b-256 646b9b53e8334efeb603a253c6c5f83a9e1e77038fbf12a423d740439f72804c

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