SummaryFunction: Abstract class to computing performance across resamples.

SummaryFunctionR Documentation

Abstract class to computing performance across resamples.

Description

Abstract used as template to define customized metrics to compute model performance during train.

Details

This class is an archetype, so it cannot be instantiated.

Methods

Public methods


Method new()

The function carries out the initialization of parameters during runtime.

Usage
SummaryFunction$new(measures)
Arguments
measures

A character vector with the measures used.


Method execute()

Abstract function used to implement the performance calculator method. To guarantee a proper operation, this method is automatically invoked by D2MCS framework.

Usage
SummaryFunction$execute()

Method getMeasures()

The function obtains the measures used to compute the performance across resamples.

Usage
SummaryFunction$getMeasures()
Returns

A character vector of NULL if measures are not defined.


Method clone()

The objects of this class are cloneable with this method.

Usage
SummaryFunction$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

NoProbability, UseProbability


D2MCS documentation built on Aug. 23, 2022, 5:07 p.m.