File probability_calibration_marginal.hpp

class IMarginalProbabilityCalibrationModel
#include <probability_calibration_marginal.hpp>

Defines an interface for all classes that implement a model for the calibration of marginal probabilities.

Subclassed by IIsotonicProbabilityCalibrationModel, INoProbabilityCalibrationModel

Public Functions

inline virtual ~IMarginalProbabilityCalibrationModel()
virtual float64 calibrateMarginalProbability(uint32 labelIndex, float64 marginalProbability) const = 0

Calibrates the marginal probability that is predicted for a specific label.

Parameters:
  • labelIndex – The index of the label, the probability is predicted for

  • marginalProbability – The marginal probability to be calibrated

Returns:

The calibrated probability

class IMarginalProbabilityCalibrator : public IProbabilityCalibrator<IMarginalProbabilityCalibrationModel>
#include <probability_calibration_marginal.hpp>

Defines an interface for all classes that implement a method for fitting models for the calibration of marginal probabilities.

Public Functions

inline virtual ~IMarginalProbabilityCalibrator() override
class IMarginalProbabilityCalibratorFactory
#include <probability_calibration_marginal.hpp>

Defines an interface for all factories that allow to create instances of the type IMarginalProbabilityCalibrator.

Subclassed by NoMarginalProbabilityCalibratorFactory

Public Functions

inline virtual ~IMarginalProbabilityCalibratorFactory()
virtual std::unique_ptr<IMarginalProbabilityCalibrator> create() const = 0

Creates and returns a new object of type IMarginalProbabilityCalibrator.

Returns:

An unique pointer to an object of type IMarginalProbabilityCalibrator that has been created

class IMarginalProbabilityCalibratorConfig
#include <probability_calibration_marginal.hpp>

Defines an interface for all classes that allow to configure a method for fitting a model for the calibration of marginal probabilities.

Subclassed by NoMarginalProbabilityCalibratorConfig

Public Functions

inline virtual ~IMarginalProbabilityCalibratorConfig()
virtual bool shouldUseHoldoutSet() const = 0

Returns whether a holdout set should be used, if available, or not.

Returns:

True, if a holdout set should be used, false otherwise

virtual std::unique_ptr<IMarginalProbabilityCalibratorFactory> createMarginalProbabilityCalibratorFactory() const = 0

Creates and returns a new object of template type IMarginalProbabilityCalibratorFactory according to the configuration.

Returns:

An unique pointer to an object of template type IMarginalProbabilityCalibratorFactory that has been created