# APLR
**Automatic Piecewise Linear Regression**

## About
APLR allows you to build predictive and interpretable regression or classification machine learning models in Python, using the Automatic Piecewise Linear Regression (APLR) methodology developed by Mathias von Ottenbreit. APLR often rivals tree-based methods in predictive accuracy, while offering smoother, more interpretable predictions. 

## Documentation
**Resources:**
- [Presentation and guides](https://github.com/ottenbreit-data-science/aplr/tree/main/documentation)
- [Examples](https://github.com/ottenbreit-data-science/aplr/tree/main/examples)
- [Published Article](https://rdcu.be/dz7bF)
- [Medium Article](https://medium.com/@ottenbreitdatascience/beyond-black-boxes-high-performance-regression-with-automatic-piecewise-linear-regression-aplr-550fe142160e)

*Note: APLR has been updated with additional functionality since the article was published.*

**API Reference:**
- [Regression](https://github.com/ottenbreit-data-science/aplr/blob/main/API_REFERENCE_FOR_REGRESSION.md)
- [Classification](https://github.com/ottenbreit-data-science/aplr/blob/main/API_REFERENCE_FOR_CLASSIFICATION.md)
- [Tuning](https://github.com/ottenbreit-data-science/aplr/blob/main/API_REFERENCE_FOR_APLR_TUNER.md)

## Installation
To install APLR, use the following command:

```bash
pip install aplr
```

To include dependencies for plotting, use this command instead:

```bash
pip install aplr[plots]
```

## Availability
APLR is available for Windows, most Linux distributions, and macOS.

## Sponsorship
Consider sponsoring Von Ottenbreit Data Science by clicking the **Sponsor** button on the repository. Sufficient funding will help maintain and further develop APLR.

## Contact Information
For inquiries, please email: [ottenbreitdatascience@gmail.com](mailto:ottenbreitdatascience@gmail.com)

## Citation
If you use APLR in your research, please cite the published article:

> von Ottenbreit, M., De Bin, R. Automatic piecewise linear regression. *Comput Stat* 39, 1867–1907 (2024). https://doi.org/10.1007/s00180-024-01475-4