Metadata-Version: 2.1
Name: lestpy
Version: 0.0.10
Summary: Regression model with logical interactions
Home-page: https://github.com/Pyonysos/lestpy
Author: Pyonysos (Paul-Hubert Baudelet)
Author-email: 
License: UNKNOWN
Keywords: python,modeling,regression
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown

# lestpy

## Overview
### Why
Lestpy is aimed to model regression problems with a bunch of logical interactions. This approach is an alternative way to describe the relationship between the features and the targets.


## Getting Started
### Installation

You can install LestPy from [PyPI]():

```sh
    python -m pip install lestpy
```

### Main classes, methods and attributes
* Interaction
* InteractionBuilder
* LBM_Regression
* Display
Methods:
    1. ternary_diagram
    2. response_surface
    3. pareto_frontier
    4. sensibility_analysis
    5. display_interaction
    6. residues
    7. fit
    8. metrics_curve
    9. describe
    10. corr_graph (in development)
* Outliers_Inspection
Methods:
    1. cooks_distance
    2. mahalanobis_distance
    3. z_score

### How to

## Use
Lestpy is designed to be used similarly to sklearn modelization classes and their methods (fit(), transform(), predict(), ...)

## Contributing
There are many ways to support the development of lestpy:

* **File an issue** on Github, if you encounter problems, have a proposal, etc.
* **Send an email with ideas** to the author.
* **Submit a pull request** on Github if you improved the code and know how to use git.


## Links
The source code and issue tracker of this package is to be found on **Github**: [pyonysos/lestpy].


[pyonysos/lestpy]: https://github.com/pyonysos/lestpy

