vw.h File Reference

#include "vw/common/future_compat.h"
#include "vw/common/hash.h"
#include "vw/core/error_reporting.h"
#include "vw/core/global_data.h"
#include "vw/core/hashstring.h"
#include "vw/core/parser.h"
#include "vw/core/setup_base.h"
#include "vw/core/vw_fwd.h"
#include <memory>

Classes
class	VW::primitive_feature_space

Namespaces
namespace	VW

Typedefs
using	VW::driver_output_func_t = VW::trace_message_t

Functions
VW::workspace *	VW::initialize (std::unique_ptr< config::options_i, options_deleter_type > options, io_buf *model=nullptr, bool skip_model_load=false, trace_message_t trace_listener=nullptr, void *trace_context=nullptr)
VW::workspace *	VW::initialize (config::options_i &options, io_buf *model=nullptr, bool skip_model_load=false, trace_message_t trace_listener=nullptr, void *trace_context=nullptr)
VW::workspace *	VW::initialize (const std::string &s, io_buf *model=nullptr, bool skip_model_load=false, trace_message_t trace_listener=nullptr, void *trace_context=nullptr)
VW::workspace *	VW::initialize (int argc, char *argv[], io_buf *model=nullptr, bool skip_model_load=false, trace_message_t trace_listener=nullptr, void *trace_context=nullptr)
VW::workspace *	VW::seed_vw_model (VW::workspace *vw_model, const std::string &extra_args, trace_message_t trace_listener=nullptr, void *trace_context=nullptr)
VW::workspace *	VW::initialize_escaped (std::string const &s, io_buf *model=nullptr, bool skip_model_load=false, trace_message_t trace_listener=nullptr, void *trace_context=nullptr)
VW::workspace *	VW::initialize_with_builder (const std::string &s, io_buf *model=nullptr, bool skip_model_load=false, trace_message_t trace_listener=nullptr, void *trace_context=nullptr, std::unique_ptr< VW::setup_base_i >=nullptr)
std::unique_ptr< VW::workspace >	VW::initialize (std::unique_ptr< config::options_i > options, std::unique_ptr< VW::io::reader > model_override_reader=nullptr, driver_output_func_t driver_output_func=nullptr, void *driver_output_func_context=nullptr, VW::io::logger *custom_logger=nullptr)
	Initialize a workspace. More...
std::unique_ptr< VW::workspace >	VW::seed_vw_model (VW::workspace &vw_model, const std::vector< std::string > &extra_args, driver_output_func_t driver_output_func=nullptr, void *driver_output_func_context=nullptr, VW::io::logger *custom_logger=nullptr)
std::unique_ptr< VW::workspace >	VW::initialize_experimental (std::unique_ptr< config::options_i > options, std::unique_ptr< VW::io::reader > model_override_reader=nullptr, driver_output_func_t driver_output_func=nullptr, void *driver_output_func_context=nullptr, VW::io::logger *custom_logger=nullptr, std::unique_ptr< VW::setup_base_i > setup_base=nullptr)
	Initialize a workspace. This interface is currently experimental, but will replace the existing array of initialize functions. More...
void	VW::cmd_string_replace_value (std::stringstream *&ss, std::string flag_to_replace, const std::string &new_value)
char **	VW::to_argv (std::string const &s, int &argc)
char **	VW::to_argv_escaped (std::string const &s, int &argc)
void	VW::free_args (int argc, char *argv[])
const char *	VW::are_features_compatible (const VW::workspace &vw1, const VW::workspace &vw2)
void	VW::finish (VW::workspace &all, bool delete_all=true)
	Call finish() after you are done with the vw instance. This cleans up memory usage if delete_all is true. Finish will cause final stat printouts and model serialization to occur. IMPORTANT: If lifetime is managed by a unique_ptr from initialize_experimental, then you must call this with delete_all = false. More...
void	VW::sync_stats (VW::workspace &all)
void	VW::start_parser (VW::workspace &all)
void	VW::end_parser (VW::workspace &all)
bool	VW::is_ring_example (const VW::workspace &all, const example *ae)
example *	VW::read_example (VW::workspace &all, const char *example_line)
example *	VW::read_example (VW::workspace &all, const std::string &example_line)
example *	VW::import_example (VW::workspace &all, const std::string &label, primitive_feature_space *features, size_t len)
example *	VW::alloc_examples (size_t count)
void	VW::dealloc_examples (example *example_ptr, size_t count)
void	VW::parse_example_label (VW::workspace &all, example &ec, const std::string &label)
void	VW::setup_examples (VW::workspace &all, VW::multi_ex &examples)
void	VW::setup_example (VW::workspace &all, example *ae)
example *	VW::new_unused_example (VW::workspace &all)
example *	VW::get_example (parser *pf)
float	VW::get_topic_prediction (example *ec, size_t i)
float	VW::get_label (example *ec)
float	VW::get_importance (example *ec)
float	VW::get_initial (example *ec)
float	VW::get_prediction (example *ec)
float	VW::get_cost_sensitive_prediction (example *ec)
v_array< float > &	VW::get_cost_sensitive_prediction_confidence_scores (example *ec)
uint32_t *	VW::get_multilabel_predictions (example *ec, size_t &len)
float	VW::get_action_score (example *ec, size_t i)
size_t	VW::get_action_score_length (example *ec)
size_t	VW::get_tag_length (example *ec)
const char *	VW::get_tag (example *ec)
size_t	VW::get_feature_number (example *ec)
float	VW::get_confidence (example *ec)
feature *	VW::get_features (VW::workspace &all, example *ec, size_t &feature_number)
void	VW::return_features (feature *f)
void	VW::add_constant_feature (const VW::workspace &all, example *ec)
void	VW::add_label (example *ec, float label, float weight=1, float base=0)
void	VW::finish_example (VW::workspace &all, example &ec)
void	VW::finish_example (VW::workspace &all, multi_ex &ec)
void	VW::empty_example (VW::workspace &all, example &ec)
void	VW::move_feature_namespace (example *dst, example *src, namespace_index c)
void	VW::copy_example_metadata (example *, const example *)
void	VW::copy_example_data (example *dst, const example *src)
void	VW::copy_example_data_with_label (example *dst, const example *src)
primitive_feature_space *	VW::export_example (VW::workspace &all, example *e, size_t &len)
void	VW::release_feature_space (primitive_feature_space *features, size_t len)
void	VW::releaseFeatureSpace (primitive_feature_space *features, size_t len)
void	VW::save_predictor (VW::workspace &all, const std::string &reg_name)
void	VW::save_predictor (VW::workspace &all, io_buf &buf)
uint64_t	VW::hash_space (VW::workspace &all, const std::string &s)
uint64_t	VW::hash_space_static (const std::string &s, const std::string &hash)
uint64_t	VW::hash_space_cstr (VW::workspace &all, const char *fstr)
uint64_t	VW::hash_feature (VW::workspace &all, const std::string &s, uint64_t u)
uint64_t	VW::hash_feature_static (const std::string &s, uint64_t u, const std::string &h, uint32_t num_bits)
uint64_t	VW::hash_feature_cstr (VW::workspace &all, const char *fstr, uint64_t u)
uint64_t	VW::chain_hash (VW::workspace &all, const std::string &name, const std::string &value, uint64_t u)
uint64_t	VW::chain_hash_static (const std::string &name, const std::string &value, uint64_t u, hash_func_t hash_func, uint64_t parse_mask)
float	VW::get_weight (VW::workspace &all, uint32_t index, uint32_t offset)
void	VW::set_weight (VW::workspace &all, uint32_t index, uint32_t offset, float value)
uint32_t	VW::num_weights (VW::workspace &all)
uint32_t	VW::get_stride (VW::workspace &all)
void	VW::init_features (primitive_feature_space &fs, size_t features_count)
void	VW::set_feature (primitive_feature_space &fs, size_t index, uint64_t feature_hash, float value)