File label_binning.hpp

namespace boosting
struct LabelInfo
#include <label_binning.hpp>

Stores information about a vector that provides access to the statistics for individual labels. This includes the number of positive and negative bins, the labels should be assigned to, as well as the minimum and maximum statistic in the vector.

Public Members

uint32 numPositiveBins

The number of positive bins.

float64 minPositive

The minimum among all statistics that belong to the positive bins.

float64 maxPositive

The maximum among all statistics that belong to the positive bins.

uint32 numNegativeBins

The number of negative bins.

float64 minNegative

The minimum among all statistics that belong to the negative bins.

float64 maxNegative

The maximum among all statistics that belong to the negative bins.

class ILabelBinning
#include <label_binning.hpp>

Defines an interface for methods that assign labels to bins, based on the corresponding gradients and Hessians.

Public Types

typedef std::function<void(uint32 binIndex, uint32 labelIndex)> Callback

A callback function that is invoked when a label is assigned to a bin. It takes the index of the bin and the index of the label as arguments.

typedef std::function<void(uint32 labelIndex)> ZeroCallback

A callback function that is invoked when a label with zero statistics is encountered. It takes the index of the label as an argument.

Public Functions

inline virtual ~ILabelBinning()
virtual uint32 getMaxBins(uint32 numLabels) const = 0

Returns an upper bound for the number of bins used by the binning method, given a specific number of labels for which rules may predict.

Parameters:

numLabels – The number of labels for which rules may predict

Returns:

The maximum number of bins used by the binning method

virtual LabelInfo getLabelInfo(View<float64>::const_iterator criteria, uint32 numCriteria) const = 0

Retrieves and returns information that is required to apply the binning method.

This function must be called prior to the function createBins to obtain information, e.g. the number of bins to be used, that is required to apply the binning method. This function may also be used to prepare, e.g. sort, the given vector. The LabelInfo returned by this function must be passed to the function createBins later on.

Parameters:

  • criteria – An iterator to the label-wise criteria that should be used to assign individual labels to bins

  • numCriteria – The number of label-wise criteria

Returns:

A struct of type LabelInfo that stores the information

virtual void createBins(LabelInfo labelInfo, View<float64>::const_iterator criteria, uint32 numCriteria, Callback callback, ZeroCallback zeroCallback) const = 0

Assigns the labels to bins based on label-wise criteria.

Parameters:

  • labelInfo – A struct of type LabelInfo that stores information that is required to apply the binning method

  • criteria – An iterator to the label-wise criteria that should be used to assign individual labels to bins

  • numCriteria – The number of label-wise criteria

  • callback – A callback that is invoked when a label is assigned to a bin

  • zeroCallback – A callback that is invoked when a label for which the criterion is zero is encountered

class ILabelBinningFactory
#include <label_binning.hpp>

Defines an interface for all factories that allows to create instances of the type ILabelBinning.

Public Functions

inline virtual ~ILabelBinningFactory()
virtual std::unique_ptr<ILabelBinning> create() const = 0

Creates and returns a new object of type ILabelBinning.

Returns:

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

class ILabelBinningConfig
#include <label_binning.hpp>

Defines an interface for all classes that allow to configure a method that assigns labels to bins.

Subclassed by boosting::AutomaticLabelBinningConfig, boosting::EqualWidthLabelBinningConfig, boosting::NoLabelBinningConfig

Public Functions

inline virtual ~ILabelBinningConfig()
virtual std::unique_ptr<ILabelWiseRuleEvaluationFactory> createLabelWiseCompleteRuleEvaluationFactory() const = 0

Creates and returns a new object of type ILabelWiseRuleEvaluationFactory that allows to calculate the predictions of complete rules according to the specified configuration.

Returns:

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

virtual std::unique_ptr<ISparseLabelWiseRuleEvaluationFactory> createLabelWiseFixedPartialRuleEvaluationFactory(float32 labelRatio, uint32 minLabels, uint32 maxLabels) const = 0

Creates and returns a new object of type ISparseLabelWiseRuleEvaluationFactory that allows to calculate the prediction of partial rules, which predict for a predefined number of labels, according to the specified configuration.

Parameters:

  • labelRatio – A percentage that specifies for how many labels the rule heads should predict

  • minLabels – The minimum number of labels for which the rule heads should predict

  • maxLabels – The maximum number of labels for which the rule heads should predict

Returns:

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

virtual std::unique_ptr<ISparseLabelWiseRuleEvaluationFactory> createLabelWiseDynamicPartialRuleEvaluationFactory(float32 threshold, float32 exponent) const = 0

Creates and returns a new object of type ISparseLabelWiseRuleEvaluationFactory that allows to calculate the prediction of partial rules, which predict for a subset of the available labels that is determined dynamically, according to the specified configuration.

Parameters:

  • threshold – A threshold that affects for how many labels the rule heads should predict

  • exponent – An exponent that is used to weigh the estimated predictive quality for individual labels

Returns:

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

virtual std::unique_ptr<IExampleWiseRuleEvaluationFactory> createExampleWiseCompleteRuleEvaluationFactory(const Blas &blas, const Lapack &lapack) const = 0

Creates and returns a new object of type IExampleWiseRuleEvaluationFactory that allows to calculate the predictions of complete rules according to the specified configuration.

Parameters:

  • blas – A reference to an object of type Blas that allows to execute BLAS routines

  • lapack – A reference to an object of type Lapack that allows to execute LAPACK routines

Returns:

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

virtual std::unique_ptr<IExampleWiseRuleEvaluationFactory> createExampleWiseFixedPartialRuleEvaluationFactory(float32 labelRatio, uint32 minLabels, uint32 maxLabels, const Blas &blas, const Lapack &lapack) const = 0

Creates and returns a new object of type IExampleWiseRuleEvaluationFactory that allows to calculate the predictions of partial rules, which predict for a predefined number of labels, according to the specified configuration.

Parameters:

  • labelRatio – A percentage that specifies for how many labels the rule heads should predict

  • minLabels – The minimum number of labels for which the rule heads should predict

  • maxLabels – The maximum number of labels for which the rule heads should predict

  • blas – A reference to an object of type Blas that allows to execute BLAS routines

  • lapack – A reference to an object of type Lapack that allows to execute LAPACK routines

Returns:

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

virtual std::unique_ptr<IExampleWiseRuleEvaluationFactory> createExampleWiseDynamicPartialRuleEvaluationFactory(float32 threshold, float32 exponent, const Blas &blas, const Lapack &lapack) const = 0

Creates and returns a new object of type IExampleWiseRuleEvaluationFactory that allows to calculate the predictions of partial rules, which predict for a subset of the available labels that is determined dynamically, according to the specified configuration.

Parameters:

  • threshold – A threshold that affects for how many labels the rule heads should predict

  • exponent – An exponent that is used to weigh the estimated predictive quality for individual labels

  • blas – A reference to an object of type Blas that allows to execute BLAS routines

  • lapack – A reference to an object of type Lapack that allows to execute LAPACK routines

Returns:

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