Skip to main content

Generalized additive models in Python.

Project description

Actions PythonVersion PyPi Black

https://raw.githubusercontent.com/tommyod/generalized-additive-models/prepare-alpha/docs/_static/readme_figure.png?token=GHSAT0AAAAAABHJPRNESAGIMSDHQ652ZK74ZAKCICA

generalized-additive-models

About

Generalized Additive Models (GAM) are the Predictive Modeling Silver Bullet. A GAM is a statistical model in which the target variable depends on unknown smooth functions of the features, and interest focuses on inference about these smooth functions.

https://latex.codecogs.com/svg.image?Y_i&space;sim&space;textup{ExponentialFamily}(mu_i,&space;phi)&space;\g(mu_i)&space;=&space;f_1(x_{i1})&space;+&space;f_2(x_{i2})&space;+&space;f_3(x_{i3},&space;x_{i4})&space;+&space;cdots

An exponential family distribution is specified for the target Y (.e.g Normal, Binomial or Poisson) along with a link function g (for example the identity or log functions) relating the expected value of Y to the predictor variables.

Installation

Install using pip:

pip install generalized-additive-models

Example

from sklearn.datasets import load_diabetes
from sklearn.model_selection import cross_val_score
from generalized_additive_models import GAM, Spline, Categorical

# Load data
data = load_diabetes(as_frame=True)
df, y = data.data, data.target

# Create model
terms = Spline("bp") + Spline("bmi", constraint="increasing") + Categorical("sex")
gam = GAM(terms)

# Cross validate
scores = cross_val_score(gam, df, y, scoring="r2")
print(scores) # array([0.26, 0.4 , 0.41, 0.35, 0.42])

Contributing

Contributions are very welcome. You can correct spelling mistakes, write documentation, clean up code, implement new features, etc.

Some guidelines:

  • Code must comply with the standard. See the GitHub action pipeline for more information.

  • If possible, use existing algorithms from numpy, scipy and scikit-learn.

  • Write tests, especically regression tests if a bug is fixed.

  • Take backward compatibility seriously. API changes require good reason.

Citing

TODO

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

generalized_additive_models-0.0.0.tar.gz (37.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file generalized_additive_models-0.0.0.tar.gz.

File metadata

File hashes

Hashes for generalized_additive_models-0.0.0.tar.gz
Algorithm Hash digest
SHA256 fa22074314475c76cfc8f9fb7ba5dd516827a37340cfa888d977f94189608ebd
MD5 c3214d1c985b3ec638fd93786921ad93
BLAKE2b-256 b26b7b910f3a33b114033a7aa3dc7e2f115d78838657ac69dc4dc2ac094b0570

See more details on using hashes here.

File details

Details for the file generalized_additive_models-0.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for generalized_additive_models-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44daeba7c08bda267fa95fdc4e49632c89a7d1302cc1ce444021d15a2f2d2f9f
MD5 dee1179d7c3818a7b1a0a012e3403e03
BLAKE2b-256 691d0586a45b057e7bc2324e2b56c98309a0f60b7536b1a325d26bf8917faae8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page