turi::evaluation::precision_recall_base Class Reference

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

Public Member Functions
flexible_type	get_reference_label ()
std::string	name () const =0
bool	is_table_printer_compatible () const
void	gather_global_metrics ()
variant_type	get_metric ()=0
void	init (size_t _n_threads=1)
void	register_example (const flexible_type &target, const flexible_type &prediction, size_t thread_id=0)
void	gather_counts_and_labels ()
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

Compute the F-Beta score.

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

Member Function Documentation

gather_counts_and_labels()

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

inlineinherited

Gather all final counts.

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

gather_global_metrics()

void turi::evaluation::precision_recall_base::gather_global_metrics ( )

inline

Gather global metrics for true_positives and false negatives

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

get_metric()

variant_type turi::evaluation::precision_recall_base::get_metric ( )

pure virtual

Get the metric!

Reimplemented from turi::evaluation::confusion_matrix.

Implemented in turi::evaluation::flexible_accuracy, turi::evaluation::recall, turi::evaluation::precision, and turi::evaluation::fbeta_score.

get_reference_label()

flexible_type turi::evaluation::precision_recall_base::get_reference_label ( )

inline

Get the "highest" label as the reference label.

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

init()

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

inlinevirtualinherited

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()

bool turi::evaluation::precision_recall_base::is_table_printer_compatible ( ) const

inlinevirtual

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

Reimplemented from turi::evaluation::confusion_matrix.

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

name()

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

pure virtual

Name of the evaluator.

Reimplemented from turi::evaluation::confusion_matrix.

Implemented in turi::evaluation::flexible_accuracy, turi::evaluation::recall, turi::evaluation::precision, and turi::evaluation::fbeta_score.

register_example()

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

inlinevirtualinherited

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

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

Reimplemented in turi::evaluation::classifier_accuracy.

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

---

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

• toolkits/evaluation/evaluation_interface-inl.hpp