VW::LEARNER Namespace Reference

Contains the VW::LEARNER::learner object and utilities for interacting with it. More...

Namespaces
namespace	details

Classes
class	bottom_learner_builder
class	common_learner_builder
class	learner
	Defines the interface for a learning algorithm. More...
class	reduction_learner_builder
class	reduction_no_data_learner_builder

Functions
void	generic_driver (VW::workspace &all)
void	generic_driver (const std::vector< VW::workspace * > &alls)
void	generic_driver_onethread (VW::workspace &all)
bool	ec_is_example_header (example const &ec, label_type_t label_type)
learner *	require_multiline (learner *l)
learner *	require_singleline (learner *l)
std::shared_ptr< learner >	require_multiline (std::shared_ptr< learner > l)
std::shared_ptr< learner >	require_singleline (std::shared_ptr< learner > l)
template<bool is_learn>
void	multiline_learn_or_predict (learner &base, multi_ex &examples, const uint64_t offset, const uint32_t id=0)
template<class DataT , class ExampleT >
reduction_learner_builder< DataT, ExampleT >	make_reduction_learner (std::unique_ptr< DataT > &&data, std::shared_ptr< learner > base, void(*learn_fn)(DataT &, learner &, ExampleT &), void(*predict_fn)(DataT &, learner &, ExampleT &), const std::string &name)
template<class ExampleT >
reduction_no_data_learner_builder< ExampleT >	make_no_data_reduction_learner (std::shared_ptr< learner > base, void(*learn_fn)(learner &, ExampleT &), void(*predict_fn)(learner &, ExampleT &), const std::string &name)
template<class DataT , class ExampleT >
bottom_learner_builder< DataT, ExampleT >	make_bottom_learner (std::unique_ptr< DataT > &&data, void(*learn_fn)(DataT &, ExampleT &), void(*predict_fn)(DataT &, ExampleT &), const std::string &name, prediction_type_t out_pred_type, label_type_t in_label_type)
template<class ExampleT >
bottom_learner_builder< char, ExampleT >	make_no_data_bottom_learner (void(*learn_fn)(char &, ExampleT &), void(*predict_fn)(char &, ExampleT &), const std::string &name, prediction_type_t out_pred_type, label_type_t in_label_type)

Detailed Description

Contains the VW::LEARNER::learner object and utilities for interacting with it.

Function Documentation

ec_is_example_header()

bool VW::LEARNER::ec_is_example_header	(	example const &	ec,
		label_type_t	label_type
	)

generic_driver() [1/2]

void VW::LEARNER::generic_driver

(

const std::vector< VW::workspace * > &

alls

)

generic_driver() [2/2]

void VW::LEARNER::generic_driver

(

VW::workspace &

all

)

generic_driver_onethread()

void VW::LEARNER::generic_driver_onethread

(

VW::workspace &

all

)

make_bottom_learner()

template<class DataT , class ExampleT >

bottom_learner_builder< DataT, ExampleT > VW::LEARNER::make_bottom_learner	(	std::unique_ptr< DataT > &&	data,
		void(*)(DataT &, ExampleT &)	learn_fn,
		void(*)(DataT &, ExampleT &)	predict_fn,
		const std::string &	name,
		prediction_type_t	out_pred_type,
		label_type_t	in_label_type
	)

make_no_data_bottom_learner()

template<class ExampleT >

bottom_learner_builder< char, ExampleT > VW::LEARNER::make_no_data_bottom_learner	(	void(*)(char &, ExampleT &)	learn_fn,
		void(*)(char &, ExampleT &)	predict_fn,
		const std::string &	name,
		prediction_type_t	out_pred_type,
		label_type_t	in_label_type
	)

make_no_data_reduction_learner()

template<class ExampleT >

reduction_no_data_learner_builder< ExampleT > VW::LEARNER::make_no_data_reduction_learner	(	std::shared_ptr< learner >	base,
		void(*)(learner &, ExampleT &)	learn_fn,
		void(*)(learner &, ExampleT &)	predict_fn,
		const std::string &	name
	)

make_reduction_learner()

template<class DataT , class ExampleT >

reduction_learner_builder< DataT, ExampleT > VW::LEARNER::make_reduction_learner	(	std::unique_ptr< DataT > &&	data,
		std::shared_ptr< learner >	base,
		void(*)(DataT &, learner &, ExampleT &)	learn_fn,
		void(*)(DataT &, learner &, ExampleT &)	predict_fn,
		const std::string &	name
	)

multiline_learn_or_predict()

template<bool is_learn>

void VW::LEARNER::multiline_learn_or_predict	(	learner &	base,
		multi_ex &	examples,
		const uint64_t	offset,
		const uint32_t	id = 0
	)

require_multiline() [1/2]

learner * VW::LEARNER::require_multiline

(

learner *

l

)

require_multiline() [2/2]

std::shared_ptr< learner > VW::LEARNER::require_multiline

(

std::shared_ptr< learner >

l

)

require_singleline() [1/2]

learner * VW::LEARNER::require_singleline

(

learner *

l

)

require_singleline() [2/2]

std::shared_ptr< learner > VW::LEARNER::require_singleline

(

std::shared_ptr< learner >

l

)