VW::model_utils Namespace Reference

Namespaces
	details

Functions
size_t	read_model_field (io_buf &, CB::cb_class &)
size_t	write_model_field (io_buf &, const CB::cb_class &, const std::string &, bool)
size_t	read_model_field (io_buf &, CB::label &)
size_t	write_model_field (io_buf &, const CB::label &, const std::string &, bool)
size_t	read_model_field (io_buf &, CB_EVAL::label &)
size_t	write_model_field (io_buf &, const CB_EVAL::label &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::cb_continuous::continuous_label_elm &)
size_t	write_model_field (io_buf &, const VW::cb_continuous::continuous_label_elm &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::cb_continuous::continuous_label &)
size_t	write_model_field (io_buf &, const VW::cb_continuous::continuous_label &, const std::string &, bool)
size_t	read_model_field (io_buf &, CCB::conditional_contextual_bandit_outcome &)
size_t	write_model_field (io_buf &, const CCB::conditional_contextual_bandit_outcome &, const std::string &, bool)
size_t	read_model_field (io_buf &, CCB::label &)
size_t	write_model_field (io_buf &, const CCB::label &, const std::string &, bool)
size_t	read_model_field (io_buf &, COST_SENSITIVE::wclass &)
size_t	write_model_field (io_buf &, const COST_SENSITIVE::wclass &, const std::string &, bool)
size_t	read_model_field (io_buf &, COST_SENSITIVE::label &)
size_t	write_model_field (io_buf &, const COST_SENSITIVE::label &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::distributionally_robust::Duals &)
size_t	write_model_field (io_buf &, const VW::distributionally_robust::Duals &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::distributionally_robust::ChiSquared &)
size_t	write_model_field (io_buf &, const VW::distributionally_robust::ChiSquared &, const std::string &, bool)
size_t	read_model_field (io_buf &io, flat_example &fe, VW::label_parser &lbl_parser)
size_t	write_model_field (io_buf &io, const flat_example &fe, const std::string &upstream_name, bool text, VW::label_parser &lbl_parser, uint64_t parse_mask)
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&std::is_trivially_copyable< T >::value &&std::is_pod< T >::value, bool >::type = true>
size_t	read_model_field (io_buf &io, T &var)
	This function is the uniform interface reading a variable from the model file. The value must be a POD type. More...
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&std::is_trivially_copyable< T >::value &&std::is_pod< T >::value, bool >::type = true>
size_t	write_model_field (io_buf &io, const T &var, const std::string &name_or_readable_field_template, bool text)
	This function is the uniform interface for serializing a variable to the model file. The value must be a POD type. More...
size_t	read_model_field (io_buf &, std::string &)
size_t	write_model_field (io_buf &, const std::string &, const std::string &, bool)
template<typename T >
size_t	read_model_field (io_buf &, std::set< T > &)
template<typename T >
size_t	write_model_field (io_buf &, const std::set< T > &, const std::string &, bool)
template<typename T >
size_t	read_model_field (io_buf &, std::vector< T > &)
template<typename T >
size_t	write_model_field (io_buf &, const std::vector< T > &, const std::string &, bool)
template<typename T >
size_t	read_model_field (io_buf &, v_array< T > &)
template<typename T >
size_t	write_model_field (io_buf &, const v_array< T > &, const std::string &, bool)
template<typename F , typename S >
size_t	read_model_field (io_buf &, std::pair< F, S > &)
template<typename F , typename S >
size_t	write_model_field (io_buf &, const std::pair< F, S > &, const std::string &, bool)
template<typename T >
size_t	read_model_field (io_buf &, std::priority_queue< T > &)
template<typename T >
size_t	write_model_field (io_buf &, const std::priority_queue< T > &, const std::string &, bool)
template<typename K , typename V >
size_t	read_model_field (io_buf &, std::map< K, V > &)
template<typename K , typename V >
size_t	write_model_field (io_buf &, const std::map< K, V > &, const std::string &, bool)
size_t	read_model_field (io_buf &, MULTICLASS::label_t &)
size_t	write_model_field (io_buf &, const MULTICLASS::label_t &, const std::string &, bool)
size_t	read_model_field (io_buf &, MULTILABEL::labels &)
size_t	write_model_field (io_buf &, const MULTILABEL::labels &, const std::string &, bool)
template<typename CMType >
size_t	write_model_field (io_buf &, const VW::reductions::automl::automl< CMType > &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::reductions::automl::exclusion_config &)
size_t	read_model_field (io_buf &, VW::reductions::automl::aml_score &)
size_t	read_model_field (io_buf &, VW::reductions::automl::interaction_config_manager &)
template<typename CMType >
size_t	read_model_field (io_buf &, VW::reductions::automl::automl< CMType > &)
size_t	write_model_field (io_buf &, const VW::reductions::automl::exclusion_config &, const std::string &, bool)
size_t	write_model_field (io_buf &, const VW::reductions::automl::aml_score &, const std::string &, bool)
size_t	write_model_field (io_buf &, const VW::reductions::automl::interaction_config_manager &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::scored_config &)
size_t	write_model_field (io_buf &, const VW::scored_config &, const std::string &, bool)
size_t	read_model_field (io_buf &, label_data &)
size_t	write_model_field (io_buf &, const label_data &, const std::string &, bool)
size_t	read_model_field (io_buf &, simple_label_reduction_features &)
size_t	write_model_field (io_buf &, const simple_label_reduction_features &, const std::string &, bool)
size_t	read_model_field (io_buf &, VW::slates::label &)
size_t	write_model_field (io_buf &, const VW::slates::label &, const std::string &, bool)

Function Documentation

read_model_field() [1/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		label_data &
	)

read_model_field() [2/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		simple_label_reduction_features &
	)

read_model_field() [3/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::distributionally_robust::Duals &
	)

read_model_field() [4/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::distributionally_robust::ChiSquared &
	)

read_model_field() [5/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::scored_config &
	)

read_model_field() [6/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		MULTILABEL::labels &
	)

read_model_field() [7/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::cb_continuous::continuous_label_elm &
	)

read_model_field() [8/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::cb_continuous::continuous_label &
	)

read_model_field() [9/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		MULTICLASS::label_t &
	)

read_model_field() [10/30]

template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&std::is_trivially_copyable< T >::value &&std::is_pod< T >::value, bool >::type = true>

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		T &	var
	)

This function is the uniform interface reading a variable from the model file. The value must be a POD type.

Template Parameters

T	type of value to serialize or deserialize. This is important as it determines the number of bytes to be processed.

Parameters

io	model file io_buf to read from or write to
var	Variable to write into for the deserialized value. Must be a type which supports validly bit casting to a sequence of bytes. Does not need to be initialized.

Returns

size_t the number of bytes read

read_model_field() [11/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		COST_SENSITIVE::wclass &
	)

read_model_field() [12/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::slates::label &
	)

read_model_field() [13/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		COST_SENSITIVE::label &
	)

read_model_field() [14/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		CB::cb_class &
	)

read_model_field() [15/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		CB::label &
	)

read_model_field() [16/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		CB_EVAL::label &
	)

read_model_field() [17/30]

size_t VW::model_utils::read_model_field ( io_buf &  io, std::string &  str  )

inline

read_model_field() [18/30]

template<typename T >

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		std::set< T > &	set
	)

read_model_field() [19/30]

template<typename T >

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		std::vector< T > &	vec
	)

read_model_field() [20/30]

template<typename T >

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		v_array< T > &	vec
	)

read_model_field() [21/30]

template<typename F , typename S >

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		std::pair< F, S > &	pair
	)

read_model_field() [22/30]

template<typename T >

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		std::priority_queue< T > &	pq
	)

read_model_field() [23/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		CCB::conditional_contextual_bandit_outcome &
	)

read_model_field() [24/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		CCB::label &
	)

read_model_field() [25/30]

template<typename K , typename V >

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		std::map< K, V > &	map
	)

read_model_field() [26/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::reductions::automl::exclusion_config &
	)

read_model_field() [27/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::reductions::automl::aml_score &
	)

read_model_field() [28/30]

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::reductions::automl::interaction_config_manager &
	)

read_model_field() [29/30]

template<typename CMType >

size_t VW::model_utils::read_model_field	(	io_buf &	,
		VW::reductions::automl::automl< CMType > &
	)

read_model_field() [30/30]

size_t VW::model_utils::read_model_field	(	io_buf &	io,
		flat_example &	fe,
		VW::label_parser &	lbl_parser
	)

write_model_field() [1/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const label_data &	,
		const std::string &	,
		bool
	)

write_model_field() [2/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const simple_label_reduction_features &	,
		const std::string &	,
		bool
	)

write_model_field() [3/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::distributionally_robust::Duals &	,
		const std::string &	,
		bool
	)

write_model_field() [4/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::distributionally_robust::ChiSquared &	,
		const std::string &	,
		bool
	)

write_model_field() [5/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::scored_config &	,
		const std::string &	,
		bool
	)

write_model_field() [6/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const MULTILABEL::labels &	,
		const std::string &	,
		bool
	)

write_model_field() [7/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::cb_continuous::continuous_label_elm &	,
		const std::string &	,
		bool
	)

write_model_field() [8/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::cb_continuous::continuous_label &	,
		const std::string &	,
		bool
	)

write_model_field() [9/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const MULTICLASS::label_t &	,
		const std::string &	,
		bool
	)

write_model_field() [10/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const COST_SENSITIVE::wclass &	,
		const std::string &	,
		bool
	)

write_model_field() [11/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::slates::label &	,
		const std::string &	,
		bool
	)

write_model_field() [12/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const COST_SENSITIVE::label &	,
		const std::string &	,
		bool
	)

write_model_field() [13/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const CB::cb_class &	,
		const std::string &	,
		bool
	)

write_model_field() [14/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const CB::label &	,
		const std::string &	,
		bool
	)

write_model_field() [15/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const CB_EVAL::label &	,
		const std::string &	,
		bool
	)

write_model_field() [16/30]

template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&std::is_trivially_copyable< T >::value &&std::is_pod< T >::value, bool >::type = true>

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const T &	var,
		const std::string &	name_or_readable_field_template,
		bool	text
	)

This function is the uniform interface for serializing a variable to the model file. The value must be a POD type.

Template Parameters

T	type of value to serialize or deserialize. This is important as it determines the number of bytes to be processed.

Parameters

io	model file io_buf to read from or write to
var	value to serialize. Must be a type which supports validly bit casting to a sequence of bytes. Must be initialized.
name_or_readable_field_template	(Only used when text == true) The name of the variable or a template string to use when writing. If empty, then no output is written for this call If the string contains a "{}", then the variable value will be substituted for that. Note: more than one "{}" in the string will result in a runtime error due to the templating failure. Otherwise, if the string is non-empty and does not contain a "{}" the value will be used as the name of the variable and be outputted in the form ("{} = {}\n", name_or_readable_field_template, var)
text	whether to write in text mode or binary mode.

Returns

size_t the number of bytes written

write_model_field() [17/30]

size_t VW::model_utils::write_model_field ( io_buf &  io, const std::string &  str, const std::string &  upstream_name, bool  text  )

inline

write_model_field() [18/30]

template<typename T >

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const std::set< T > &	set,
		const std::string &	upstream_name,
		bool	text
	)

write_model_field() [19/30]

template<typename T >

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const std::vector< T > &	vec,
		const std::string &	upstream_name,
		bool	text
	)

write_model_field() [20/30]

template<typename T >

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const v_array< T > &	vec,
		const std::string &	upstream_name,
		bool	text
	)

write_model_field() [21/30]

template<typename F , typename S >

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const std::pair< F, S > &	pair,
		const std::string &	upstream_name,
		bool	text
	)

write_model_field() [22/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const CCB::conditional_contextual_bandit_outcome &	,
		const std::string &	,
		bool
	)

write_model_field() [23/30]

template<typename T >

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const std::priority_queue< T > &	pq,
		const std::string &	upstream_name,
		bool	text
	)

write_model_field() [24/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const CCB::label &	,
		const std::string &	,
		bool
	)

write_model_field() [25/30]

template<typename K , typename V >

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const std::map< K, V > &	map,
		const std::string &	upstream_name,
		bool	text
	)

write_model_field() [26/30]

template<typename CMType >

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::reductions::automl::automl< CMType > &	,
		const std::string &	,
		bool
	)

write_model_field() [27/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::reductions::automl::exclusion_config &	,
		const std::string &	,
		bool
	)

write_model_field() [28/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::reductions::automl::aml_score &	,
		const std::string &	,
		bool
	)

write_model_field() [29/30]

size_t VW::model_utils::write_model_field	(	io_buf &	,
		const VW::reductions::automl::interaction_config_manager &	,
		const std::string &	,
		bool
	)

write_model_field() [30/30]

size_t VW::model_utils::write_model_field	(	io_buf &	io,
		const flat_example &	fe,
		const std::string &	upstream_name,
		bool	text,
		VW::label_parser &	lbl_parser,
		uint64_t	parse_mask
	)