Skip to main content

A Python implementation of the Fisher Scoring algorithm for logistic regression, multinomial regression, and focal loss regression

Project description

Fisher Scoring with Python

Author: xRiskLab
Version: v2.0.2
License: MIT License (2024)

Title

This repository contains optimized Python implementations of the Fisher Scoring algorithm for various logistic regression models. With version 2.0, the core algorithms are now significantly faster due to optimized matrix operations and reduced memory usage, providing faster convergence for larger datasets.

%pip install fisher-scoring
from fisher_scoring import FisherScoringLogisticRegression

# Initialize and fit model
model = FisherScoringLogisticRegression(epsilon=1e-5)
model.fit(X_train, y_train)

# Make predictions
predictions = model.predict(X_test)
probabilities = model.predict_proba(X_test)

Overview

Introduction

This repository contains a Python package with scikit-learn compatible implementations of the Fisher Scoring algorithm for various logistic regression use cases:

  1. Binary classification problems: Logistic Regression.
  2. Multi-class classification problems: Multinomial Logistic Regression.
  3. Imbalanced classification problems: Focal Loss Logistic Regression.

Fisher Scoring Algorithm

The Fisher Scoring algorithm is an iterative optimization technique that estimates maximum likelihood estimates by leveraging the expected or observed Fisher information matrix. This second-order optimization method allows to avoid the use of learning rates and provides more stable convergence compared to gradient descent.

There are two types of information matrices used in the Fisher Scoring algorithm:

  • Observed Information Matrix: Uses ground truth labels to calculate the information matrix, often resulting in more reliable inference metrics.
  • Expected Information Matrix: Relies on predicted probabilities, providing an efficient approximation for the information matrix.

These information matrices are used to derive standard errors of estimates to calculate detailed model statistics, including Wald statistics, p-values, and confidence intervals at a chosen level.

Implementation Notes

  • Fisher Scoring Multinomial Regression
    The FisherScoringMultinomialRegression model differs from standard statistical multinomial logistic regression by using all classes rather than ( K - 1 ). This approach allows multi-class classification problems to be converted to binary problems by calculating (1 - probability of the target class).

  • Fisher Scoring Focal Regression
    The FisherScoringFocalRegression class employs a non-standard log-likelihood function in its optimization process.

    The focal loss function, originally developed for object detection, prioritizes difficult-to-classify examples—often the minority class—by reducing the contribution of easy-to-classify samples. It introduces a focusing parameter, gamma, which down-weights the influence of easily classified instances, thereby concentrating learning on challenging cases.

    Source: Focal Loss for Dense Object Detection.

Models

Fisher Scoring Logistic Regression

The FisherScoringLogisticRegression class is a custom implementation of logistic regression using the Fisher scoring algorithm. It provides methods for fitting the model, making predictions, and computing model statistics, including standard errors, Wald statistics, p-values, and confidence intervals.

Parameters:

  • epsilon: Convergence threshold for the algorithm.
  • max_iter: Maximum number of iterations for the algorithm.
  • information: Type of information matrix to use ('expected' or 'observed').
  • use_bias: Include a bias term in the model.
  • significance: Significance level for computing confidence intervals.

Methods:

  • fit(X, y): Fit the model to the data.
  • predict(X): Predict target labels for input data.
  • predict_proba(X): Predict class probabilities for input data.
  • get_params(): Get model parameters.
  • set_params(**params): Set model parameters.
  • summary(): Get a summary of model parameters, standard errors, p-values, and confidence intervals.
  • display_summary(): Display a summary of model parameters, standard errors, p-values, and confidence intervals.

Fisher Scoring Multinomial Regression

The FisherScoringMultinomialRegression class implements the Fisher Scoring algorithm for multinomial logistic regression, suitable for multi-class classification tasks.

Parameters:

  • epsilon: Convergence threshold for the algorithm.
  • max_iter: Maximum number of iterations for the algorithm.
  • information: Type of information matrix to use ('expected' or 'observed').
  • use_bias: Include a bias term in the model.
  • significance: Significance level for computing confidence intervals.
  • verbose: Enable verbose output.

Methods:

  • fit(X, y): Fit the model to the data.
  • predict(X): Predict target labels for input data.
  • predict_proba(X): Predict class probabilities for input data.
  • summary(class_idx): Get a summary of model parameters, standard errors, p-values, and confidence intervals for a specific class.
  • display_summary(class_idx): Display a summary of model parameters, standard errors, p-values, and confidence intervals for a specific class.

The algorithm is in a beta version and may require further testing and optimization to speed up matrix operations.

Fisher Scoring Focal Loss Regression

The FisherScoringFocalRegression class implements the Fisher Scoring algorithm with focal loss, designed for imbalanced classification problems where the positive class is rare.

Parameters:

  • gamma: Focusing parameter for focal loss.
  • epsilon: Convergence threshold for the algorithm.
  • max_iter: Maximum number of iterations for the algorithm.
  • information: Type of information matrix to use ('expected' or 'observed').
  • use_bias: Include a bias term in the model.
  • verbose: Enable verbose output.

Note: The algorithm does not have a summary method for model statistics implemented yet.

Installation

To use the models, clone the repository and install the required dependencies.

git clone https://github.com/xRiskLab/fisher-scoring.git
cd fisher-scoring
pip install -r requirements.txt

Alternatively, install the package directly from PyPI.

pip install fisher-scoring

Change Log

  • v2.0.2

    • Bug Fixes: Fixed the FisherScoringMultinomialRegression class to have flexible NumPy data types.
  • v2.0.1

    • Bug Fixes: Removed the debug print statement from the FisherScoringLogisticRegression class.
  • v2.0

    • Performance Improvements: Performance Enhancements: Optimized matrix calculations for substantial speed and memory efficiency improvements across all models. Leveraging streamlined operations, this version achieves up to 290x faster convergence. Performance gains per model:
      • Multinomial Logistic Regression: Training time reduced from 125.10s to 0.43s (~290x speedup).
      • Logistic Regression: Training time reduced from 0.24s to 0.05s (~5x speedup).
      • Focal Loss Logistic Regression: Training time reduced from 0.26s to 0.01s (~26x speedup).
    • Bug Fixes: verbose parameter in Focal Loss Logistic Regression now functions as expected, providing accurate logging during training.
  • v0.1.4

    • Updated log likelihood for Multinomial Regression and minor changes to Logistic Regression for integration with scikit-learn.
  • v0.1.3

    • Added coefficients, standard errors, p-values, and confidence intervals for Multinomial Regression.
  • v0.1.2

    • Updated NumPy dependency.
  • v0.1.1

    • Added support for Python 3.9+ 🐍.
  • v0.1.0

    • Initial release of Fisher Scoring Logistic, Multinomial, and Focal Loss Regression.

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

fisher_scoring-2.0.2.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

fisher_scoring-2.0.2-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file fisher_scoring-2.0.2.tar.gz.

File metadata

  • Download URL: fisher_scoring-2.0.2.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Darwin/23.6.0

File hashes

Hashes for fisher_scoring-2.0.2.tar.gz
Algorithm Hash digest
SHA256 9e2bcd51b5740eb5240f72f32ea74e157e40e6a07d70885e1e65dba41a91a939
MD5 f8b572088c613f0ed8ead22139765b5c
BLAKE2b-256 6d05482c5ad2fb5e3053f7f8166c3170953ef818a5ecf038b7aed0085e2f5b56

See more details on using hashes here.

Provenance

File details

Details for the file fisher_scoring-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: fisher_scoring-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Darwin/23.6.0

File hashes

Hashes for fisher_scoring-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 738160bed25d4e9fce4d7e06d6c1aba250f90da6eb7edb5e7ae543a1eb7dfe2d
MD5 07d36cadb1ba66b793a89b90894ded03
BLAKE2b-256 8b30e4965771b60a62bc5226f06d0849e0362b9eb7f0fefb67f4e60a5d7030f6

See more details on using hashes here.

Provenance

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