File instance_sampling_stratified_output_wise.hpp

class IOutputWiseStratifiedInstanceSamplingConfig

#include <instance_sampling_stratified_output_wise.hpp>

Defines an interface for all classes that allow to configure a method for selecting a subset of the available training examples using stratification, such that for each label the proportion of relevant and irrelevant examples is maintained.

Subclassed by OutputWiseStratifiedInstanceSamplingConfig

Public Functions

inline virtual ~IOutputWiseStratifiedInstanceSamplingConfig()

virtual float32 getSampleSize() const = 0

Returns the fraction of examples that are included in a sample.

Returns:

The fraction of examples that are included in a sample

virtual IOutputWiseStratifiedInstanceSamplingConfig &setSampleSize(float32 sampleSize) = 0

Sets the fraction of examples that should be included in a sample.

Parameters:

sampleSize – The fraction of examples that should be included in a sample, e.g., a value of 0.6 corresponds to 60 % of the available training examples. Must be in (0, 1)

Returns:

A reference to an object of type IOutputWiseStratifiedInstanceSamplingConfig that allows further configuration of the method for sampling instances

class OutputWiseStratifiedInstanceSamplingConfig : public IClassificationInstanceSamplingConfig, public IOutputWiseStratifiedInstanceSamplingConfig

#include <instance_sampling_stratified_output_wise.hpp>

Allows to configure a method for selecting a subset of the available training examples using stratification, such that for each label the proportion of relevant and irrelevant examples is maintained.

Public Functions

OutputWiseStratifiedInstanceSamplingConfig()

virtual float32 getSampleSize() const override

Returns the fraction of examples that are included in a sample.

Returns:

The fraction of examples that are included in a sample

virtual IOutputWiseStratifiedInstanceSamplingConfig &setSampleSize(float32 sampleSize) override

Sets the fraction of examples that should be included in a sample.

Parameters:

sampleSize – The fraction of examples that should be included in a sample, e.g., a value of 0.6 corresponds to 60 % of the available training examples. Must be in (0, 1)

Returns:

A reference to an object of type IOutputWiseStratifiedInstanceSamplingConfig that allows further configuration of the method for sampling instances

virtual std::unique_ptr<IClassificationInstanceSamplingFactory> createClassificationInstanceSamplingFactory() const override

Creates and returns a new object of type IClassificationInstanceSamplingFactory according to the specified configuration.

Returns:

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

Private Members

float32 sampleSize_