Metadata-Version: 2.1
Name: profile-t
Version: 1.0.2
Summary: Profile t calculation and plots for regression model
Home-page: https://github.com/folivetti/profile_t
Author: Fabricio Olivetti de Franca, Gabriel Kronberger
Author-email: Fabricio Olivetti de Franca <folivetti@ufabc.edu.br>, Gabriel Kronberger <Gabriel.Kronberger@fh-hagenberg.at>
License: MIT License
        
        Copyright (c) 2022 Fabricio Olivetti de Franca and Gabriel Kronberger
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/folivetti/profile_t
Project-URL: Bug Tracker, https://github.com/folivetti/profile_t/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

<img src="figs/logo.svg" width="100" height="100" align="left">

**profile_t** is a Python module for calculating confidence intervals of nonlinear regression models.

Quantification of uncertainty of regression models is important for the interpretation of models and for decision making. The linear approximation and likelihood profiles are well-known possibilities for the calculation of confidence and prediction intervals for nonlinear regression models.

This module allows the calculation of confidence regions of the numerical parameters and the prediction interval for any nonlinear regression model compatible with sympy. It provides helper functions to build the sympy-expressions from a string representation of the model and some support plots to analyse the model.

The tau-theta plot shows the nonlinearity of the confidence interval of each parameter:

<p align="center">
<img src="figs/BOD_tau_theta_0.png" width="50%" height="50%">
</p>

The theta-theta plot shows the relationship between a pair of numerical parameters:

<p align="center">
<img src="figs/BOD_theta_theta.png" width="50%" height="50%">
</p>

The prediction interval shows the uncertainties around the predictions of the training data:

<p align="center">
<img src="figs/BOD_predictions.png" width="50%" height="50%">
</p>

More information available at the paper:

```bibtex
    @article{
    }
```


# Installation

## Dependencies

profile_t requires:

- Python
- NumPy
- SciPy
- SymPy
- Matplotlib

=======

## User installation

To install from source, first clone this github repository and then run:

```bash
pip install -U .
```

Or from pypy:

```bash
pip install -U profile_t
```

## Changelog

See the `Changelog` file for the last changes.

## Examples of usage

The folder `examples` contain some examples of usage of this module.

## Documentation

The documentation is available at [link](link).

## Testing

You can test the module with the `test_profile.py` script in the `tests` folder.

## Citation

TODO

## AUTHORS

- Fabricio Olivetti de Franca <folivetti (at) ufabc.edu.br>
- Gabriel Kronberger <Gabriel.Kronberger (at) fh-hagenberg.at>

A joint work of:

<table border="0">
 <tr>
    <td><a href="https://pesquisa.ufabc.edu.br/hal/index.html" target="_blank"><img src="figs/hal.svg" height="90" align="left"></a> Heuristics, Analysis and Learning Laboratory (HAL)</td>
    <td><a href="https://heal.heuristiclab.com/" target="_blank"><img src="figs/HEAL.png" height="80" align="left"></a> Heuristics and Evolutionary Algorithms Laboratory (HEAL)</td>
 </tr>
</table>
