Metadata-Version: 2.1
Name: fklearn
Version: 3.0.0
Summary: Functional machine learning
Home-page: https://github.com/nubank/fklearn
Author: Nubank
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.8,<3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: joblib <2,>=1.3.2
Requires-Dist: numpy <2,>=1.24.4
Requires-Dist: pandas <3,>=2
Requires-Dist: scikit-learn <2,>=1
Requires-Dist: statsmodels <1,>=0.14.0
Requires-Dist: toolz <1,>=0.12.0
Provides-Extra: all
Requires-Dist: lightgbm <5,>=4 ; extra == 'all'
Requires-Dist: xgboost <3,>=2 ; extra == 'all'
Requires-Dist: catboost <2,>=1.2.2 ; extra == 'all'
Requires-Dist: shap <1,>=0.43 ; extra == 'all'
Requires-Dist: swifter <2,>=0.24 ; extra == 'all'
Provides-Extra: all_models
Requires-Dist: lightgbm <5,>=4 ; extra == 'all_models'
Requires-Dist: xgboost <3,>=2 ; extra == 'all_models'
Requires-Dist: catboost <2,>=1.2.2 ; extra == 'all_models'
Provides-Extra: catboost
Requires-Dist: catboost <2,>=1.2.2 ; extra == 'catboost'
Provides-Extra: devel
Requires-Dist: pytest <8,>=7.4.3 ; extra == 'devel'
Requires-Dist: pytest-cov <3,>=2.6.1 ; extra == 'devel'
Requires-Dist: pytest-xdist <4,>=3.3.1 ; extra == 'devel'
Requires-Dist: mypy <2,>=1.6.1 ; extra == 'devel'
Requires-Dist: coverage <5 ; extra == 'devel'
Requires-Dist: codecov <3,>=2.0 ; extra == 'devel'
Requires-Dist: hypothesis <7,>=6.88.3 ; extra == 'devel'
Requires-Dist: lightgbm <5,>=4 ; extra == 'devel'
Requires-Dist: xgboost <3,>=2 ; extra == 'devel'
Requires-Dist: catboost <2,>=1.2.2 ; extra == 'devel'
Requires-Dist: shap <1,>=0.43 ; extra == 'devel'
Requires-Dist: swifter <2,>=0.24 ; extra == 'devel'
Provides-Extra: lgbm
Requires-Dist: lightgbm <5,>=4 ; extra == 'lgbm'
Provides-Extra: test_deps
Requires-Dist: pytest <8,>=7.4.3 ; extra == 'test_deps'
Requires-Dist: pytest-cov <3,>=2.6.1 ; extra == 'test_deps'
Requires-Dist: pytest-xdist <4,>=3.3.1 ; extra == 'test_deps'
Requires-Dist: mypy <2,>=1.6.1 ; extra == 'test_deps'
Requires-Dist: coverage <5 ; extra == 'test_deps'
Requires-Dist: codecov <3,>=2.0 ; extra == 'test_deps'
Requires-Dist: hypothesis <7,>=6.88.3 ; extra == 'test_deps'
Provides-Extra: tools
Requires-Dist: shap <1,>=0.43 ; extra == 'tools'
Requires-Dist: swifter <2,>=0.24 ; extra == 'tools'
Provides-Extra: xgboost
Requires-Dist: xgboost <3,>=2 ; extra == 'xgboost'

# fklearn: Functional Machine Learning

![PyPI](https://img.shields.io/pypi/v/fklearn.svg?style=flat-square)
[![Documentation Status](https://readthedocs.org/projects/fklearn/badge/?version=latest)](https://fklearn.readthedocs.io/en/latest/?badge=latest)
[![Gitter](https://badges.gitter.im/fklearn-python/community.svg)](https://gitter.im/fklearn-python/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
![Tests](https://github.com/nubank/fklearn/actions/workflows/push.yaml/badge.svg?branch=master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

**fklearn** uses functional programming principles to make it easier to solve real problems with Machine Learning.

The name is a reference to the widely known [scikit-learn](https://scikit-learn.org/stable/) library.

**fklearn Principles**

1. Validation should reflect real-life situations.
2. Production models should match validated models.
3. Models should be production-ready with few extra steps.
4. Reproducibility and in-depth analysis of model results should be easy to achieve.


[Documentation](https://fklearn.readthedocs.io/en/latest/) |
[Getting Started](https://fklearn.readthedocs.io/en/latest/getting_started.html) |
[API Docs](https://fklearn.readthedocs.io/en/latest/api/modules.html) |
[Contributing](https://fklearn.readthedocs.io/en/latest/contributing.html) |


## Installation

To install via pip:

```
pip install fklearn
```

You can also install from the source:

```sh
git clone git@github.com:nubank/fklearn.git
cd fklearn
git checkout master
pip install -e .
```

## License

[Apache License 2.0](LICENSE)
