VW::metrics_collector Class Reference

#include <metrics_collector.h>

Public Types
using	metrics_callback_fn = std::function< void(VW::metric_sink &)>

Public Member Functions
	metrics_collector (bool enabled=false)
bool	are_metrics_enabled () const
void	register_metrics_callback (const metrics_callback_fn &callback)
VW::metric_sink	collect_metrics (LEARNER::learner *l=nullptr) const

Member Typedef Documentation

metrics_callback_fn

using VW::metrics_collector::metrics_callback_fn = std::function<void(VW::metric_sink&)>

Constructor & Destructor Documentation

metrics_collector()

VW::metrics_collector::metrics_collector

(

bool

enabled = false

)

Member Function Documentation

are_metrics_enabled()

bool VW::metrics_collector::are_metrics_enabled

(

)

const

collect_metrics()

VW::metric_sink VW::metrics_collector::collect_metrics

(

LEARNER::learner *

l = nullptr

)

const

register_metrics_callback()

void VW::metrics_collector::register_metrics_callback

(

const metrics_callback_fn &

callback

)

---

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

• /nix/store/lp9wjr07fg70x7djxjnivn11qk52df1s-source/vowpalwabbit/core/include/vw/core/metrics_collector.h