Vowpal Wabbit
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT > Class Template Reference

#include <learner.h>

Public Member Functions

 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 & operator= (const common_learner_builder &)=delete
 
 common_learner_builder (common_learner_builder &&) noexcept=default
 
common_learner_builder & operator= (common_learner_builder &&) noexcept=default
 
FluentBuilderT & set_learn_returns_prediction (bool learn_returns_prediction) &
 
FluentBuilderT && set_learn_returns_prediction (bool learn_returns_prediction) &&
 
FluentBuilderT & set_save_load (void(*fn_ptr)(DataT &, io_buf &, bool, bool)) &
 
FluentBuilderT && set_save_load (void(*fn_ptr)(DataT &, io_buf &, bool, bool)) &&
 
FluentBuilderT & set_finish (void(*fn_ptr)(DataT &)) &
 
FluentBuilderT && set_finish (void(*fn_ptr)(DataT &)) &&
 
FluentBuilderT & set_end_pass (void(*fn_ptr)(DataT &)) &
 
FluentBuilderT && set_end_pass (void(*fn_ptr)(DataT &)) &&
 
FluentBuilderT & set_end_examples (void(*fn_ptr)(DataT &)) &
 
FluentBuilderT && set_end_examples (void(*fn_ptr)(DataT &)) &&
 
FluentBuilderT & set_init_driver (void(*fn_ptr)(DataT &)) &
 
FluentBuilderT && set_init_driver (void(*fn_ptr)(DataT &)) &&
 
FluentBuilderT & set_finish_example (void(*fn_ptr)(VW::workspace &all, DataT &, ExampleT &)) &
 
FluentBuilderT && set_finish_example (void(*fn_ptr)(VW::workspace &all, DataT &, ExampleT &)) &&
 
FluentBuilderT & set_update_stats (learner_update_stats_func< DataT, ExampleT > *fn_ptr) &
 
FluentBuilderT && set_update_stats (learner_update_stats_func< DataT, ExampleT > *fn_ptr) &&
 
FluentBuilderT & set_output_example_prediction (learner_output_example_prediction_func< DataT, ExampleT > *fn_ptr) &
 
FluentBuilderT && set_output_example_prediction (learner_output_example_prediction_func< DataT, ExampleT > *fn_ptr) &&
 
FluentBuilderT & set_print_update (learner_print_update_func< DataT, ExampleT > *fn_ptr) &
 
FluentBuilderT && set_print_update (learner_print_update_func< DataT, ExampleT > *fn_ptr) &&
 
FluentBuilderT & set_cleanup_example (learner_cleanup_example_func< DataT, ExampleT > *fn_ptr) &
 
FluentBuilderT && set_cleanup_example (learner_cleanup_example_func< DataT, ExampleT > *fn_ptr) &&
 
FluentBuilderT & set_persist_metrics (void(*fn_ptr)(DataT &, metric_sink &)) &
 
FluentBuilderT && set_persist_metrics (void(*fn_ptr)(DataT &, metric_sink &)) &&
 
FluentBuilderT & set_pre_save_load (void(*fn_ptr)(VW::workspace &all, DataT &)) &
 
FluentBuilderT && set_pre_save_load (void(*fn_ptr)(VW::workspace &all, DataT &)) &&
 
FluentBuilderT & set_input_label_type (label_type_t label_type) &
 
FluentBuilderT && set_input_label_type (label_type_t label_type) &&
 
FluentBuilderT & set_output_label_type (label_type_t label_type) &
 
FluentBuilderT && set_output_label_type (label_type_t label_type) &&
 
FluentBuilderT & set_input_prediction_type (prediction_type_t pred_type) &
 
FluentBuilderT && set_input_prediction_type (prediction_type_t pred_type) &&
 
FluentBuilderT & set_output_prediction_type (prediction_type_t pred_type) &
 
FluentBuilderT && set_output_prediction_type (prediction_type_t pred_type) &&
 

Public Attributes

std::shared_ptr< learner > learner_ptr = nullptr
 
std::shared_ptr< DataT > learner_data = nullptr
 

Constructor & Destructor Documentation

◆ common_learner_builder() [1/3]

template<class FluentBuilderT , class DataT , class ExampleT >
VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::common_learner_builder ( std::shared_ptr< learner >  input_learner,
std::unique_ptr< DataT > &&  data,
const std::string &  name 
)
inline

◆ common_learner_builder() [2/3]

template<class FluentBuilderT , class DataT , class ExampleT >
VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::common_learner_builder ( const common_learner_builder< FluentBuilderT, DataT, ExampleT > &  )
delete

◆ common_learner_builder() [3/3]

template<class FluentBuilderT , class DataT , class ExampleT >
VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::common_learner_builder ( common_learner_builder< FluentBuilderT, DataT, ExampleT > &&  )
defaultnoexcept

Member Function Documentation

◆ operator=() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
common_learner_builder & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::operator= ( common_learner_builder< FluentBuilderT, DataT, ExampleT > &&  )
defaultnoexcept

◆ operator=() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
common_learner_builder & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::operator= ( const common_learner_builder< FluentBuilderT, DataT, ExampleT > &  )
delete

◆ set_cleanup_example() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_cleanup_example ( learner_cleanup_example_func< DataT, ExampleT > *  fn_ptr) &
inline

◆ set_cleanup_example() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_cleanup_example ( learner_cleanup_example_func< DataT, ExampleT > *  fn_ptr) &&
inline

◆ set_end_examples() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_end_examples ( void(*)(DataT &)  fn_ptr) &
inline

◆ set_end_examples() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_end_examples ( void(*)(DataT &)  fn_ptr) &&
inline

◆ set_end_pass() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_end_pass ( void(*)(DataT &)  fn_ptr) &
inline

◆ set_end_pass() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_end_pass ( void(*)(DataT &)  fn_ptr) &&
inline

◆ set_finish() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_finish ( void(*)(DataT &)  fn_ptr) &
inline

◆ set_finish() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_finish ( void(*)(DataT &)  fn_ptr) &&
inline

◆ set_finish_example() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_finish_example ( void(*)(VW::workspace &all, DataT &, ExampleT &)  fn_ptr) &
inline

◆ set_finish_example() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_finish_example ( void(*)(VW::workspace &all, DataT &, ExampleT &)  fn_ptr) &&
inline

◆ set_init_driver() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_init_driver ( void(*)(DataT &)  fn_ptr) &
inline

◆ set_init_driver() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_init_driver ( void(*)(DataT &)  fn_ptr) &&
inline

◆ set_input_label_type() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_input_label_type ( label_type_t  label_type) &
inline

◆ set_input_label_type() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_input_label_type ( label_type_t  label_type) &&
inline

◆ set_input_prediction_type() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_input_prediction_type ( prediction_type_t  pred_type) &
inline

◆ set_input_prediction_type() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_input_prediction_type ( prediction_type_t  pred_type) &&
inline

◆ set_learn_returns_prediction() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_learn_returns_prediction ( bool  learn_returns_prediction) &
inline

◆ set_learn_returns_prediction() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_learn_returns_prediction ( bool  learn_returns_prediction) &&
inline

◆ set_output_example_prediction() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_output_example_prediction ( learner_output_example_prediction_func< DataT, ExampleT > *  fn_ptr) &
inline

◆ set_output_example_prediction() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_output_example_prediction ( learner_output_example_prediction_func< DataT, ExampleT > *  fn_ptr) &&
inline

◆ set_output_label_type() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_output_label_type ( label_type_t  label_type) &
inline

◆ set_output_label_type() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_output_label_type ( label_type_t  label_type) &&
inline

◆ set_output_prediction_type() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_output_prediction_type ( prediction_type_t  pred_type) &
inline

◆ set_output_prediction_type() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_output_prediction_type ( prediction_type_t  pred_type) &&
inline

◆ set_persist_metrics() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_persist_metrics ( void(*)(DataT &, metric_sink &)  fn_ptr) &
inline

◆ set_persist_metrics() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_persist_metrics ( void(*)(DataT &, metric_sink &)  fn_ptr) &&
inline

◆ set_pre_save_load() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_pre_save_load ( void(*)(VW::workspace &all, DataT &)  fn_ptr) &
inline

◆ set_pre_save_load() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_pre_save_load ( void(*)(VW::workspace &all, DataT &)  fn_ptr) &&
inline

◆ set_print_update() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_print_update ( learner_print_update_func< DataT, ExampleT > *  fn_ptr) &
inline

◆ set_print_update() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_print_update ( learner_print_update_func< DataT, ExampleT > *  fn_ptr) &&
inline

◆ set_save_load() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_save_load ( void(*)(DataT &, io_buf &, bool, bool)  fn_ptr) &
inline

◆ set_save_load() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_save_load ( void(*)(DataT &, io_buf &, bool, bool)  fn_ptr) &&
inline

◆ set_update_stats() [1/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT & VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_update_stats ( learner_update_stats_func< DataT, ExampleT > *  fn_ptr) &
inline

◆ set_update_stats() [2/2]

template<class FluentBuilderT , class DataT , class ExampleT >
FluentBuilderT && VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::set_update_stats ( learner_update_stats_func< DataT, ExampleT > *  fn_ptr) &&
inline

Member Data Documentation

◆ learner_data

template<class FluentBuilderT , class DataT , class ExampleT >
std::shared_ptr<DataT> VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::learner_data = nullptr

◆ learner_ptr

template<class FluentBuilderT , class DataT , class ExampleT >
std::shared_ptr<learner> VW::LEARNER::common_learner_builder< FluentBuilderT, DataT, ExampleT >::learner_ptr = nullptr
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.5