Metadata-Version: 2.1
Name: regmod
Version: 0.2.0
Summary: General regression models
Author-email: IHME Math Sciences <ihme.math.sciences@gmail.com>
License: BSD 2-Clause License
        
        Copyright (c) 2023, IHME Math Sciences
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: stash, https://github.com/ihmeuw-msca/regmod
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
Provides-Extra: test
License-File: LICENSE

.. image:: https://github.com/ihmeuw-msca/regmod/workflows/build/badge.svg
    :target: https://github.com/ihmeuw-msca/regmod/actions

.. image:: https://badge.fury.io/py/regmod.svg
    :target: https://badge.fury.io/py/regmod

Regression Models
=================

This package is design for general regression models including
generalized linear models and others.

It features

* Bayesian framework, allows user to include priors into the mdoel.
* Easy spline interface and spline shape priors and constraint.

Current model pool contains:

* Linear model
* Poisson model
* Binomial model

Install
-------
Package requires Python version above ``>=3.10``.

To install the package, the simplest way is through ``pip``,

.. code-block:: bash

    pip install regmod

Or you could clone this repository and do,

.. code-block:: bash

    python setup.py install

Acknowledgement
---------------
Design idea of this package comes from
`"Animal" package <https://github.com/ihmeuw-msca/anml>`_.
It is a general tool building template, for more detail please check the link above.
