Metadata-Version: 2.1
Name: gumbi
Version: 0.2.3
Summary: Gaussian Process Model Building Interface
Home-page: https://github.com/JohnGoertz/Gumbi
Author: John Goertz
Author-email: 
License: Apache 2.0
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=1.2.3
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: matplotlib
Requires-Dist: pymc>=5.3.1
Requires-Dist: arviz
Requires-Dist: uncertainties

# Gumbi: Gaussian Process Model Building Interface

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/JohnGoertz/Gumbi/HEAD)

## Overview

Gumbi simplifies the steps needed to build a Gaussian Process model from tabular data. It takes care of shaping,
transforming, and standardizing data as necessary while applying best practices and sensible defaults to the
construction of the GP model itself. Taking inspiration from popular packages such as
__[Bambi](https://bambinos.github.io/bambi/main/index.html)__ and __[Seaborn](https://seaborn.pydata.org/index.html)__,
Gumbi's aim is to allow quick iteration on both model structure and prediction visualization. Gumbi is primarily built
on top of __[Pymc](https://docs.pymc.io/)__, though additional support for __[GPflow](https://gpflow.readthedocs.io/)__
is planned.

## Quickstart

Read in some data and store it as a Gumbi `DataSet`:

```python
import gumbi as gmb
import seaborn as sns
cars = sns.load_dataset('mpg').dropna()
ds = gmb.DataSet(cars, outputs=['mpg', 'acceleration'], log_vars=['mpg', 'acceleration', 'weight', 'horsepower', 'displacement'])
```

Create a Gumbi `GP` object and fit a model that predicts *mpg* from *horsepower*:

```python
gp = gmb.GP(ds)
gp.fit(outputs=['mpg'], continuous_dims=['horsepower']);
```

Make predictions and plot!

```python
X = gp.prepare_grid()
y = gp.predict_grid()
gmb.ParrayPlotter(X, y).plot()
```

More complex GPs are also possible, such as correlated multi-input and multi-output systems. See the docs for more examples.

## Installation

### Via pip

    pip install gumbi

### Bleeding edge

    pip install git+git://github.com/JohnGoertz/Gumbi.git@develop

### Local developmenst

* Clone the repo and navigate to the new directory
  * `git clone https://gitlab.com/JohnGoertz/gumbi gumbi`
  * `cd gumbi`
* Create a new conda environment using mamba
  * `conda install mamba`
  * `mamba install -f dev_environment.yaml`
* Install `gumbi` via `pip` in editable/development mode
  * From within the `gumbi` repo
  * `pip install --editable ./`
* To update the `gumbi` module
  * From within the `gumbi` repo
  * `git pull`
