VW::LEARNER::bottom_learner_builder< DataT, ExampleT > Class Template Reference

#include <learner.h>

Inheritance diagram for VW::LEARNER::bottom_learner_builder< DataT, ExampleT >:

Public Types
using	FluentBuilderT = bottom_learner_builder< DataT, ExampleT >
using	super = common_learner_builder< bottom_learner_builder< DataT, ExampleT >, DataT, ExampleT >

Public Member Functions
	bottom_learner_builder (std::unique_ptr< DataT > &&data, const std::string &name, prediction_type_t out_pred_type, label_type_t in_label_type)
FluentBuilderT &	set_predict (void(*fn_ptr)(DataT &, ExampleT &)) &
FluentBuilderT &&	set_predict (void(*fn_ptr)(DataT &, ExampleT &)) &&
FluentBuilderT &	set_learn (void(*fn_ptr)(DataT &, ExampleT &)) &
FluentBuilderT &&	set_learn (void(*fn_ptr)(DataT &, ExampleT &)) &&
FluentBuilderT &	set_multipredict (void(*fn_ptr)(DataT &, ExampleT &, size_t, size_t, polyprediction *, bool)) &
FluentBuilderT &&	set_multipredict (void(*fn_ptr)(DataT &, ExampleT &, size_t, size_t, polyprediction *, bool)) &&
FluentBuilderT &	set_update (void(*fn_ptr)(DataT &data, ExampleT &)) &
FluentBuilderT &&	set_update (void(*fn_ptr)(DataT &data, ExampleT &)) &&
FluentBuilderT &	set_sensitivity (float(*fn_ptr)(DataT &data, example &)) &
FluentBuilderT &&	set_sensitivity (float(*fn_ptr)(DataT &data, example &)) &&
FluentBuilderT &	set_merge_with_all (void(*fn_ptr)(const std::vector< float > &, const std::vector< const VW::workspace * > &, const std::vector< const DataT * > &, VW::workspace &, DataT &)) &
FluentBuilderT &&	set_merge_with_all (void(*fn_ptr)(const std::vector< float > &, const std::vector< const VW::workspace * > &, const std::vector< const DataT * > &, VW::workspace &, DataT &)) &&
FluentBuilderT &	set_add_with_all (void(*fn_ptr)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)) &
FluentBuilderT &&	set_add_with_all (void(*fn_ptr)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)) &&
FluentBuilderT &	set_subtract_with_all (void(*fn_ptr)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)) &
FluentBuilderT &&	set_subtract_with_all (void(*fn_ptr)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)) &&
std::shared_ptr< learner >	build ()
Public Member Functions inherited from VW::LEARNER::common_learner_builder< bottom_learner_builder< DataT, ExampleT >, DataT, ExampleT >
	common_learner_builder (std::shared_ptr< learner > input_learner, std::unique_ptr< DataT > &&data, const std::string &name)
	common_learner_builder (const common_learner_builder &)=delete
	common_learner_builder (common_learner_builder &&) noexcept=default
common_learner_builder &	operator= (const common_learner_builder &)=delete
common_learner_builder &	operator= (common_learner_builder &&) noexcept=default
bottom_learner_builder< DataT, ExampleT > &	set_learn_returns_prediction (bool learn_returns_prediction) &
bottom_learner_builder< DataT, ExampleT > &&	set_learn_returns_prediction (bool learn_returns_prediction) &&
bottom_learner_builder< DataT, ExampleT > &	set_save_load (void(*fn_ptr)(DataT &, io_buf &, bool, bool)) &
bottom_learner_builder< DataT, ExampleT > &&	set_save_load (void(*fn_ptr)(DataT &, io_buf &, bool, bool)) &&
bottom_learner_builder< DataT, ExampleT > &	set_finish (void(*fn_ptr)(DataT &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_finish (void(*fn_ptr)(DataT &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_end_pass (void(*fn_ptr)(DataT &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_end_pass (void(*fn_ptr)(DataT &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_end_examples (void(*fn_ptr)(DataT &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_end_examples (void(*fn_ptr)(DataT &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_init_driver (void(*fn_ptr)(DataT &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_init_driver (void(*fn_ptr)(DataT &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_finish_example (void(*fn_ptr)(VW::workspace &all, DataT &, ExampleT &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_finish_example (void(*fn_ptr)(VW::workspace &all, DataT &, ExampleT &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_update_stats (learner_update_stats_func< DataT, ExampleT > *fn_ptr) &
bottom_learner_builder< DataT, ExampleT > &&	set_update_stats (learner_update_stats_func< DataT, ExampleT > *fn_ptr) &&
bottom_learner_builder< DataT, ExampleT > &	set_output_example_prediction (learner_output_example_prediction_func< DataT, ExampleT > *fn_ptr) &
bottom_learner_builder< DataT, ExampleT > &&	set_output_example_prediction (learner_output_example_prediction_func< DataT, ExampleT > *fn_ptr) &&
bottom_learner_builder< DataT, ExampleT > &	set_print_update (learner_print_update_func< DataT, ExampleT > *fn_ptr) &
bottom_learner_builder< DataT, ExampleT > &&	set_print_update (learner_print_update_func< DataT, ExampleT > *fn_ptr) &&
bottom_learner_builder< DataT, ExampleT > &	set_cleanup_example (learner_cleanup_example_func< DataT, ExampleT > *fn_ptr) &
bottom_learner_builder< DataT, ExampleT > &&	set_cleanup_example (learner_cleanup_example_func< DataT, ExampleT > *fn_ptr) &&
bottom_learner_builder< DataT, ExampleT > &	set_persist_metrics (void(*fn_ptr)(DataT &, metric_sink &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_persist_metrics (void(*fn_ptr)(DataT &, metric_sink &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_pre_save_load (void(*fn_ptr)(VW::workspace &all, DataT &)) &
bottom_learner_builder< DataT, ExampleT > &&	set_pre_save_load (void(*fn_ptr)(VW::workspace &all, DataT &)) &&
bottom_learner_builder< DataT, ExampleT > &	set_input_label_type (label_type_t label_type) &
bottom_learner_builder< DataT, ExampleT > &&	set_input_label_type (label_type_t label_type) &&
bottom_learner_builder< DataT, ExampleT > &	set_output_label_type (label_type_t label_type) &
bottom_learner_builder< DataT, ExampleT > &&	set_output_label_type (label_type_t label_type) &&
bottom_learner_builder< DataT, ExampleT > &	set_input_prediction_type (prediction_type_t pred_type) &
bottom_learner_builder< DataT, ExampleT > &&	set_input_prediction_type (prediction_type_t pred_type) &&
bottom_learner_builder< DataT, ExampleT > &	set_output_prediction_type (prediction_type_t pred_type) &
bottom_learner_builder< DataT, ExampleT > &&	set_output_prediction_type (prediction_type_t pred_type) &&

Additional Inherited Members
Public Attributes inherited from VW::LEARNER::common_learner_builder< bottom_learner_builder< DataT, ExampleT >, DataT, ExampleT >
std::shared_ptr< learner >	learner_ptr
std::shared_ptr< DataT >	learner_data

Member Typedef Documentation

FluentBuilderT

template<class DataT , class ExampleT >

using VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::FluentBuilderT = bottom_learner_builder<DataT, ExampleT>

super

template<class DataT , class ExampleT >

using VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::super = common_learner_builder<bottom_learner_builder<DataT, ExampleT>, DataT, ExampleT>

Constructor & Destructor Documentation

bottom_learner_builder()

template<class DataT , class ExampleT >

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

inline

Member Function Documentation

build()

template<class DataT , class ExampleT >

std::shared_ptr< learner > VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::build ( )

inline

set_add_with_all() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_add_with_all ( void(*)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)  fn_ptr ) &

inline

set_add_with_all() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_add_with_all ( void(*)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)  fn_ptr ) &&

inline

set_learn() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_learn ( void(*)(DataT &, ExampleT &)  fn_ptr ) &

inline

set_learn() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_learn ( void(*)(DataT &, ExampleT &)  fn_ptr ) &&

inline

set_merge_with_all() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_merge_with_all ( void(*)(const std::vector< float > &, const std::vector< const VW::workspace * > &, const std::vector< const DataT * > &, VW::workspace &, DataT &)  fn_ptr ) &

inline

set_merge_with_all() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_merge_with_all ( void(*)(const std::vector< float > &, const std::vector< const VW::workspace * > &, const std::vector< const DataT * > &, VW::workspace &, DataT &)  fn_ptr ) &&

inline

set_multipredict() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_multipredict ( void(*)(DataT &, ExampleT &, size_t, size_t, polyprediction *, bool)  fn_ptr ) &

inline

set_multipredict() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_multipredict ( void(*)(DataT &, ExampleT &, size_t, size_t, polyprediction *, bool)  fn_ptr ) &&

inline

set_predict() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_predict ( void(*)(DataT &, ExampleT &)  fn_ptr ) &

inline

set_predict() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_predict ( void(*)(DataT &, ExampleT &)  fn_ptr ) &&

inline

set_sensitivity() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_sensitivity ( float(*)(DataT &data, example &)  fn_ptr ) &

inline

set_sensitivity() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_sensitivity ( float(*)(DataT &data, example &)  fn_ptr ) &&

inline

set_subtract_with_all() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_subtract_with_all ( void(*)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)  fn_ptr ) &

inline

set_subtract_with_all() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_subtract_with_all ( void(*)(const VW::workspace &, const DataT &, const VW::workspace &, const DataT &, VW::workspace &, DataT &)  fn_ptr ) &&

inline

set_update() [1/2]

template<class DataT , class ExampleT >

FluentBuilderT & VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_update ( void(*)(DataT &data, ExampleT &)  fn_ptr ) &

inline

set_update() [2/2]

template<class DataT , class ExampleT >

FluentBuilderT && VW::LEARNER::bottom_learner_builder< DataT, ExampleT >::set_update ( void(*)(DataT &data, ExampleT &)  fn_ptr ) &&

inline

---

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

• /nix/store/2saqbz278bj3pvhbfxlcc50cjbvs3h0h-source/vowpalwabbit/core/include/vw/core/learner.h