File predictor_probability.hpp

class IProbabilityPredictor : public IPredictor<DensePredictionMatrix<float64>>
#include <predictor_probability.hpp>

Defines an interface for all classes that allow to predict probability estimates for given query examples.

Public Functions

inline virtual ~IProbabilityPredictor() override
class IProbabilityPredictorFactory
#include <predictor_probability.hpp>

Defines an interface for all classes that allow to create instances of the type IProbabilityPredictor.

Public Functions

inline virtual ~IProbabilityPredictorFactory()
virtual std::unique_ptr<IProbabilityPredictor> create(const CContiguousView<const float32> &featureMatrix, const RuleList &model, const LabelVectorSet *labelVectorSet, const IMarginalProbabilityCalibrationModel &marginalProbabilityCalibrationModel, const IJointProbabilityCalibrationModel &jointProbabilityCalibrationModel, uint32 numLabels) const = 0

Creates and returns a new object of the type IProbabilityPredictor.

Parameters:

  • featureMatrix – A reference to an object of type CContiguousView that stores the feature values of the query examples to predict for

  • model – A reference to an object of type RuleList that should be used to obtain predictions

  • labelVectorSet – A pointer to an object of type LabelVectorSet that stores all known label vectors or a null pointer, if no such set is available

  • marginalProbabilityCalibrationModel – A reference to an object of type IMarginalProbabilityCalibrationModel that may be used for the calibration of marginal probabilities

  • jointProbabilityCalibrationModel – A reference to an object of type IJointProbabilityCalibrationModel that may be used for the calibration of joint probabilities

  • numLabels – The number of labels to predict for

Returns:

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

virtual std::unique_ptr<IProbabilityPredictor> create(const CsrView<const float32> &featureMatrix, const RuleList &model, const LabelVectorSet *labelVectorSet, const IMarginalProbabilityCalibrationModel &marginalProbabilityCalibrationModel, const IJointProbabilityCalibrationModel &jointProbabilityCalibrationModel, uint32 numLabels) const = 0

Creates and returns a new object of the type IProbabilityPredictor.

Parameters:

  • featureMatrix – A reference to an object of type CsrView that stores the feature values of the query examples to predict for

  • model – A reference to an object of type RuleList that should be used to obtain predictions

  • labelVectorSet – A pointer to an object of type LabelVectorSet that stores all known label vectors or a null pointer, if no such set is available

  • marginalProbabilityCalibrationModel – A reference to an object of type IMarginalProbabilityCalibrationModel that may be used for the calibration of marginal probabilities

  • jointProbabilityCalibrationModel – A reference to an object of type IJointProbabilityCalibrationModel that may be used for the calibration of joint probabilities

  • numLabels – The number of labels to predict for

Returns:

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

class IProbabilityPredictorConfig : public IPredictorConfig<IProbabilityPredictorFactory>
#include <predictor_probability.hpp>

Defines an interface for all classes that allow to configure a IProbabilityPredictor.

Public Functions

inline virtual ~IProbabilityPredictorConfig() override