#include <toolkits/evaluation/evaluation_interface-inl.hpp>

Public Member Functions
	confusion_matrix (std::map< size_t, flexible_type > index_map=std::map< size_t, flexible_type >())

std::string	name () const

void	init (size_t _n_threads=1)

virtual bool	is_table_printer_compatible () const

void	register_example (const flexible_type &target, const flexible_type &prediction, size_t thread_id=0)

void	gather_counts_and_labels ()

variant_type	get_metric ()

virtual bool	is_prob_evaluator () const

virtual void	register_unmapped_example (const size_t &target, const size_t &prediction, size_t thread_id=0)

Detailed Description

Computes the confusion matrix for a set of predictions, where all predictions above the provided threshold are considered positive labels.

true_label predicted_label count

Definition at line 800 of file evaluation_interface-inl.hpp.

Constructor & Destructor Documentation

◆ confusion_matrix()

turi::evaluation::confusion_matrix::confusion_matrix ( std::map< size_t, flexible_type > index_map = std::map<size_t, flexible_type>() )

inline

Constructor.

Definition at line 822 of file evaluation_interface-inl.hpp.

Member Function Documentation

◆ gather_counts_and_labels()

void turi::evaluation::confusion_matrix::gather_counts_and_labels ( )

inline

Gather all final counts.

Definition at line 874 of file evaluation_interface-inl.hpp.

◆ get_metric()

variant_type turi::evaluation::confusion_matrix::get_metric ( )

inlinevirtual

Return the final metric.

Implements turi::evaluation::supervised_evaluation_interface.

Reimplemented in turi::evaluation::flexible_accuracy, turi::evaluation::recall, turi::evaluation::precision, turi::evaluation::fbeta_score, and turi::evaluation::precision_recall_base.

Definition at line 905 of file evaluation_interface-inl.hpp.

◆ init()

void turi::evaluation::confusion_matrix::init ( size_t _n_threads = 1 )

inlinevirtual

Init the state with a variant type.

Implements turi::evaluation::supervised_evaluation_interface.

Definition at line 837 of file evaluation_interface-inl.hpp.

◆ is_prob_evaluator()

virtual bool turi::evaluation::supervised_evaluation_interface::is_prob_evaluator ( ) const

inlinevirtualinherited

Returns true of this evaluator works on probabilities/scores (vs) classes.

Reimplemented in turi::evaluation::roc_curve.

Definition at line 253 of file evaluation_interface-inl.hpp.

◆ is_table_printer_compatible()

virtual bool turi::evaluation::confusion_matrix::is_table_printer_compatible ( ) const

inlinevirtual

Returns true of this evaluator can be displayed as a single float value.

Reimplemented from turi::evaluation::supervised_evaluation_interface.

Reimplemented in turi::evaluation::precision_recall_base.

Definition at line 845 of file evaluation_interface-inl.hpp.

◆ name()

std::string turi::evaluation::confusion_matrix::name ( ) const

inlinevirtual

Name of the evaluator.

Implements turi::evaluation::supervised_evaluation_interface.

Reimplemented in turi::evaluation::flexible_accuracy, turi::evaluation::recall, turi::evaluation::precision, turi::evaluation::fbeta_score, and turi::evaluation::precision_recall_base.

Definition at line 830 of file evaluation_interface-inl.hpp.

◆ register_example()

void turi::evaluation::confusion_matrix::register_example	(	const flexible_type &	target,
		const flexible_type &	prediction,
		size_t	thread_id = `0`
	)

inlinevirtual

Register a (target, prediction) pair

Parameters

[in]	target	Target of a simple example.
[in]	prediction	Prediction of a single example.
[in]	thread_id	Thread id

Implements turi::evaluation::supervised_evaluation_interface.

Definition at line 857 of file evaluation_interface-inl.hpp.

◆ register_unmapped_example()

virtual void turi::evaluation::supervised_evaluation_interface::register_unmapped_example	(	const size_t &	target,
		const size_t &	prediction,
		size_t	thread_id = `0`
	)

inlinevirtualinherited

Register an unmapped (target, prediction) pair. Use this for performance only. Here the target and prediction are assumed to be integers to avoid flexible_type comparisons and flexible_type hashing.

Parameters