ppforest2::stats::ClassificationMetrics Struct Reference

Classification evaluation metrics. More...

#include <Metrics.hpp>

Public Types
using	Maybe = std::optional<ClassificationMetrics>

Public Member Functions
	ClassificationMetrics ()=default
	ClassificationMetrics (ConfusionMatrix cm)
	ClassificationMetrics (types::GroupIdVector const &predictions, types::GroupIdVector const &actual)
double	error_rate () const

Public Attributes
ConfusionMatrix	confusion_matrix

Detailed Description

Classification evaluation metrics.

Wraps the confusion matrix and exposes the overall error rate.

Member Typedef Documentation

Maybe

using ppforest2::stats::ClassificationMetrics::Maybe = std::optional<ClassificationMetrics>

Constructor & Destructor Documentation

ClassificationMetrics() [1/3]

ppforest2::stats::ClassificationMetrics::ClassificationMetrics ( )

default

ClassificationMetrics() [2/3]

ppforest2::stats::ClassificationMetrics::ClassificationMetrics ( ConfusionMatrix cm )

inlineexplicit

ClassificationMetrics() [3/3]

ppforest2::stats::ClassificationMetrics::ClassificationMetrics ( types::GroupIdVector const & predictions, types::GroupIdVector const & actual )

inline

Member Function Documentation

error_rate()

double ppforest2::stats::ClassificationMetrics::error_rate ( ) const

inline

Member Data Documentation

confusion_matrix

ConfusionMatrix ppforest2::stats::ClassificationMetrics::confusion_matrix

---

The documentation for this struct was generated from the following file:

• core/src/stats/Metrics.hpp