Metadata-Version: 2.1
Name: bokbokbok
Version: 0.3
Summary: Custom Losses and Metrics for XGBoost, LightGBM, CatBoost
Home-page: https://github.com/orchardbirds/bokbokbok
Author: Daniel Timbrell
Author-email: dantimbrell@gmail.com
License: Open Source
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.19.2)
Requires-Dist: scikit-learn (>=0.23.2)
Provides-Extra: all
Requires-Dist: numpy (>=1.19.2) ; extra == 'all'
Requires-Dist: scikit-learn (>=0.23.2) ; extra == 'all'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'all'
Requires-Dist: black (>=19.10b0) ; extra == 'all'
Requires-Dist: pre-commit (>=2.5.0) ; extra == 'all'
Requires-Dist: mypy (>=0.770) ; extra == 'all'
Requires-Dist: flake8-docstrings (>=1.4.0pytest>=6.0.0) ; extra == 'all'
Requires-Dist: pytest-cov (>=2.10.0) ; extra == 'all'
Requires-Dist: lightgbm (>=3.0.0) ; extra == 'all'
Requires-Dist: xgboost (>=1.3.3) ; extra == 'all'
Requires-Dist: mkdocs-material (>=6.1.0) ; extra == 'all'
Requires-Dist: mkdocs-git-revision-date-localized-plugin (>=0.7.2) ; extra == 'all'
Requires-Dist: mkdocs-git-authors-plugin (>=0.3.2) ; extra == 'all'
Requires-Dist: mkdocs-table-reader-plugin (>=0.4.1) ; extra == 'all'
Requires-Dist: mkdocs-enumerate-headings-plugin (>=0.4.3) ; extra == 'all'
Requires-Dist: mkdocs-awesome-pages-plugin (>=2.4.0) ; extra == 'all'
Requires-Dist: mkdocs-minify-plugin (>=0.3.0) ; extra == 'all'
Requires-Dist: mknotebooks (>=0.6.2) ; extra == 'all'
Requires-Dist: mkdocstrings (>=0.13.6) ; extra == 'all'
Requires-Dist: mkdocs-print-site-plugin (>=0.8.2) ; extra == 'all'
Requires-Dist: mkdocs-markdownextradata-plugin (>=0.1.9) ; extra == 'all'
Provides-Extra: base
Requires-Dist: numpy (>=1.19.2) ; extra == 'base'
Requires-Dist: scikit-learn (>=0.23.2) ; extra == 'base'

<img src="https://github.com/orchardbirds/bokbokbok/raw/main/docs/img/bokbokbok.png" width="120" align="right">

[![PyPi Version](https://img.shields.io/pypi/pyversions/bokbokbok)](#)
[![PyPI](https://img.shields.io/pypi/v/bokbokbok)](#)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/bokbokbok)](#)
![GitHub contributors](https://img.shields.io/github/contributors/orchardbirds/bokbokbok)


# bokbokbok

## Overview

**bokbokbok** is a python package that enables you to use Custom Loss Functions and Evaluation Metrics for XGBoost and LightGBM.
Main features:

- [Weighted Cross Entropy](https://orchardbirds.github.io/bokbokbok/tutorials/weighted_cross_entropy.html)
- [Weighted Focal Loss](https://orchardbirds.github.io/bokbokbok/tutorials/focal_loss.html)
- [Log Cosh Loss](https://orchardbirds.github.io/bokbokbok/tutorials/log_cosh_loss.html)
- [F1 score](https://orchardbirds.github.io/bokbokbok/tutorials/F1_score.html)

## Installation

```bash
pip install bokbokbok
```

## Documentation

The documentation can [be found here.](https://orchardbirds.github.io/bokbokbok/)

## Contributing

To learn more about making a contribution to bokbokbok, please see [CONTRIBUTING.md.](https://github.com/orchardbirds/bokbokbok/blob/main/CONTRIBUTING.md)

