Skip to main content

Minimax Risk Classification

Project description

MRCpy: A Library for Minimax Risk Classifiers

Build Status Coverage Status

MRCpy library implements minimax risk classifiers (MRCs) that are based on robust risk minimization and can utilize 0-1 loss, in contrast to existing libraries for supervised classification using techniques based on empirical risk minimization and surrogate losses.

Such techniques give rise to a manifold of classification methods that can provide tight bounds on the expected loss. MRCpy provides a unified interface for different variants of MRCs and follows the standards of popular Python libraries. This library also provides implementation for popular techniques that can be seen as MRCs such as L1-regularized logistic regression, zero-one adversarial, and maximum entropy machines.

In addition, MRCpy implements recent feature mappings such as Fourier, ReLU, and threshold features. The library is designed with an object-oriented approach that facilitates collaborators and users. The source code is available under the MIT license at https://github.com/MachineLearningBCAM/MRCpy.

IMPORTANT NOTE

When downloading the MRCpy library from PyPI (via pip), the MRCpy.datasets module (including the data loaders) are not downloaded due to space issues. If you want to obtain the datasets module, please download it from MRCpy github page.

Algorithms

  • MRC with 0-1 loss (MRC)
  • MRC with log loss (MRC)
  • MRC with 0-1 loss and fixed instances' marginals (CMRC)
  • MRC with log loss and fixed instances' marginals (CMRC)

Installation

Python 3.6

From a terminal (OS X & linux), you can install MRCpy and its requirements directly by running the setup.py script as follows

git clone https://github.com/MachineLearningBCAM/MRCpy.git
cd MRCpy
python3 setup.py install

NOTE: CVXpy optimization uses MOSEK optimizer(by default) which requires a license. You can get a free academic license from here.

Dependencies

  • Python >= 3.6
  • numpy >= 1.18.1, scipy>= 1.4.1, scikit-learn >= 0.21.0, cvxpy, mosek, pandas

Usage

See the MRCpy documentation page for full documentation about installation, API, usage, and examples.

Citations

This repository is the official implementation of Minimax Risk Classifiers proposed in the following papers. If you use MRCpy in a scientific publication, we would appreciate citations to:

Updates and Discussion

You can subscribe to the MRCpy's mailing list for updates and discussion

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

MRCpy-0.1.3.tar.gz (24.8 kB view hashes)

Uploaded Source

Built Distribution

MRCpy-0.1.3-py3-none-any.whl (37.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page