API Reference

The optimal-classification-cutoffs library provides a comprehensive API for threshold optimization across binary and multiclass classification problems.

Overview

The main entry points are:

  • get_optimal_threshold() - Core optimization function for binary and multiclass problems

  • ThresholdOptimizer - Scikit-learn compatible wrapper class

  • cv_threshold_optimization() - Cross-validation utilities

Core Functions

The primary interface for threshold optimization:

Metrics System

Built-in metrics and utilities for custom metric registration:

Scikit-learn Interface

High-level wrapper for integration with scikit-learn workflows:

Cross-Validation

Utilities for robust threshold estimation:

Multiclass Support

Specialized functionality for multiclass classification:

Type Definitions

Type hints and protocols used throughout the library: