turi::evaluation::classifier_accuracy Class Reference

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

Public Member Functions
std::string	name () const
void	init (size_t _n_threads=1)
void	register_unmapped_example (const size_t &target, const size_t &prediction, size_t thread_id=0)
void	register_example (const flexible_type &target, const flexible_type &prediction, size_t thread_id=0)
variant_type	get_metric ()
virtual bool	is_prob_evaluator () const
virtual bool	is_table_printer_compatible () const

Detailed Description

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

accuaracy = num_right / num_examples

where num_right are the things you got right!

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

Member Function Documentation

get_metric()

variant_type turi::evaluation::classifier_accuracy::get_metric ( )

inlinevirtual

Return the final metric.

Implements turi::evaluation::supervised_evaluation_interface.

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

init()

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

inlinevirtual

Init the state with a variant type.

Implements turi::evaluation::supervised_evaluation_interface.

Definition at line 725 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::supervised_evaluation_interface::is_table_printer_compatible ( ) const

inlinevirtualinherited

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

Reimplemented in turi::evaluation::roc_curve, turi::evaluation::precision_recall_base, and turi::evaluation::confusion_matrix.

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

name()

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

inlinevirtual

Name of the evaluator.

Implements turi::evaluation::supervised_evaluation_interface.

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

register_example()

void turi::evaluation::classifier_accuracy::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 763 of file evaluation_interface-inl.hpp.

register_unmapped_example()

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

inlinevirtual

Register a (target, prediction) pair that are unmapped

Parameters

[in]	target	target of a simple example.
[in]	prediction	prediction of a single example.
[in]	thread_id	thread id

Note

Use this for performance because it does not perform a a flexible_type compare.

Reimplemented from turi::evaluation::supervised_evaluation_interface.

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

---

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

• toolkits/evaluation/evaluation_interface-inl.hpp