Skip to main content

Python Documentation Github MIT License LinkedIn


Constrained Gradient Boosting

Constrained Optimization of Gradient Boosting models which is written on top of Sklearn gradient boosting.
Explore the docs »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This is the companion code for the Master Thesis entitled "". The master thesis is done in Bosch Center of AI research, and licenced by GNU AFFERO GENERAL PUBLIC LICENSE. The code allows the users to apply constrained for one type of error, such as false negative rate to do safe classification using gradient boosting. Besides, one can reproduce the results in the paper as it is provided in the examples.

This library enables user to define their own constraints and apply them on for the gradient boosting. To see how to do this visit here.

Built With

This project language is Python and it is built on top of scikit-learn gradient boosting. For hyper-parameter optimization GPyOpt bayesian optimization is used.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

To use the constrained_gb library, you need to have scikit-learn>=0.22.0 installed, which is probably installed if you are using Machine Learning algorithm in Python. To do hyper-parameter optimization using .optimize(), you need to have GPyOpt installed. To install GPyOpt simply run

pip install gpyopt

If you have problem with GPyOpt installation visit here.

Installation

  1. Clone the repo
    git clone https://github.com/maryami66/constrained_gb.git
    
  2. Install
    pip install constrained_gb
    

Usage

In this example, we are looking for a classifier to Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

import constrained_gb as gbmco
from sklearn.datasets import load_breast_cancer
from sklearn.model_selection import train_test_split
from sklearn.metrics import *

X, y = load_breast_cancer(return_X_y=True)

X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.5, random_state=2)
 
 
constraints = [gbmco.FalseNegativeRate(0.001)]
 
parms = {'constraints': constraints,
         'multiplier_stepsize': 0.01,
         'learning_rate': 0.1,
         'min_samples_split': 99,
         'min_samples_leaf': 19,
         'max_depth': 8,
         'max_leaf_nodes': None,
         'min_weight_fraction_leaf': 0.0,
         'n_estimators': 300,
         'max_features': 'sqrt',
         'subsample': 0.7,
         'random_state': 2
         }
 
clf = gbmco.ConstrainedClassifier(**parms)
clf.fit(X_train, y_train)
 
test_predictions = clf.predict(X_test)
 
print("Test F1 Measure: {} \n".format(f1_score(y_test, test_predictions)))
print("Test FNR: {} \n".format(1-recall_score(y_test, test_predictions)))

License

Distributed under the GNU AFFERO GENERAL PUBLIC LICENSE License v3 or later (GPLv3+). See LICENSE for more information.

Contact

Maryam Bahrami - maryami_66@yahoo.com

Project Link: https://github.com/maryami66/constrained_gb

Acknowledgements

Metadata

Release files for constrained-gb 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for constrained-gb 0.1.3
File Size Uploaded
constrained_gb-0.1.3.tar.gz 16.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for constrained-gb 0.1.3
File Interpreter ABI Platform
constrained_gb-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 32.9 kB

Release files / constrained_gb-0.1.3.tar.gz

Download URL constrained_gb-0.1.3.tar.gz
Size 16.6 kB
Tags Source
SHA-256 checksum
How to use checksums
07e632fa8e3a29bba1b66f2350e5206ffb98d7881356fd83829608da77392bf6
BLAKE2b-256 checksum
How to use checksums
6923e2a09e8be3c8abdfdd045d8324fd7289328538dcc78c8c7413741fc30386
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.6.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

Release files / constrained_gb-0.1.3-py3-none-any.whl

Download URL constrained_gb-0.1.3-py3-none-any.whl
Size 16.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
afcfd424cace7a124d8719117cf23d3599a0a60fbcd6f74b5a303e261d093207
BLAKE2b-256 checksum
How to use checksums
7d299c84cb5e229f65d36756c3ce72cbfd6e2b612670d9a1abfee3cf5bc6f97a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.6.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page