Detailed Description

This class implements streaming features for use with VW.

Each example is stored in a VwExample object, which also contains label and other information. Features are hashed and are supposed to be used with a weight vector of preallocated dimensions.

Definition at line 41 of file StreamingVwFeatures.h.

Inheritance diagram for CStreamingVwFeatures:

[legend]

Public Member Functions
	CStreamingVwFeatures ()

	CStreamingVwFeatures (CStreamingVwFile *file, bool is_labelled, int32_t size)

	CStreamingVwFeatures (CStreamingVwCacheFile *file, bool is_labelled, int32_t size)

	~CStreamingVwFeatures ()

CFeatures *	duplicate () const

virtual void	set_vector_reader ()

virtual void	set_vector_and_label_reader ()

virtual void	start_parser ()

virtual void	end_parser ()

virtual void	reset_stream ()

virtual CVwEnvironment *	get_env ()

virtual void	set_env (CVwEnvironment *vw_env)

virtual bool	get_next_example ()

virtual VwExample *	get_example ()

virtual float64_t	get_label ()

virtual void	release_example ()

virtual void	expand_if_required (float32_t *&vec, int32_t &len)

virtual void	expand_if_required (float64_t *&vec, int32_t &len)

virtual int32_t	get_dim_feature_space () const

virtual float32_t	real_weight (float32_t w, float32_t gravity)

virtual float32_t	dot (CStreamingDotFeatures *df)

virtual float32_t	dense_dot (VwExample &ex, const float32_t vec2)

virtual float32_t	dense_dot (const float32_t *vec2, int32_t vec2_len)

virtual float32_t	dense_dot (SGSparseVector< float32_t > vec1, const float32_t vec2)

virtual float32_t	dense_dot_truncated (const float32_t vec2, VwExample &ex, float32_t gravity)

virtual void	add_to_dense_vec (float32_t alpha, VwExample &ex, float32_t vec2, int32_t vec2_len, bool abs_val=false)

virtual void	add_to_dense_vec (float32_t alpha, float32_t *vec2, int32_t vec2_len, bool abs_val=false)

virtual int32_t	get_nnz_features_for_vector ()

virtual int32_t	get_num_features ()

virtual EFeatureType	get_feature_type () const

virtual EFeatureClass	get_feature_class () const

virtual const char *	get_name () const

virtual int32_t	get_num_vectors () const

virtual void	dense_dot_range (float32_t output, float32_t alphas, float32_t *vec, int32_t dim, float32_t b, int32_t num_vec=0)

virtual void *	get_feature_iterator ()

virtual bool	get_next_feature (int32_t &index, float32_t &value, void *iterator)

virtual void	free_feature_iterator (void *iterator)

void	set_read_functions ()

virtual bool	get_has_labels ()

virtual bool	is_seekable ()

virtual CFeatures *	get_streamed_features (index_t num_elements)

virtual void	add_preprocessor (CPreprocessor *p)

virtual void	del_preprocessor (int32_t num)

CPreprocessor *	get_preprocessor (int32_t num) const

void	set_preprocessed (int32_t num)

bool	is_preprocessed (int32_t num) const

int32_t	get_num_preprocessed () const

int32_t	get_num_preprocessors () const

void	clean_preprocessors ()

void	list_preprocessors ()

int32_t	get_cache_size () const

virtual bool	reshape (int32_t num_features, int32_t num_vectors)

void	list_feature_obj () const

virtual void	load (CFile *loader)

virtual void	save (CFile *writer)

bool	check_feature_compatibility (CFeatures *f) const

bool	has_property (EFeatureProperty p) const

void	set_property (EFeatureProperty p)

void	unset_property (EFeatureProperty p)

virtual CFeatures *	create_merged_copy (CList *others)

virtual CFeatures *	create_merged_copy (CFeatures *other)

virtual void	add_subset (SGVector< index_t > subset)

virtual void	add_subset_in_place (SGVector< index_t > subset)

virtual void	remove_subset ()

virtual void	remove_all_subsets ()

virtual CSubsetStack *	get_subset_stack ()

virtual void	subset_changed_post ()

virtual CFeatures *	copy_subset (SGVector< index_t > indices)

virtual CFeatures *	copy_dimension_subset (SGVector< index_t > dims)

virtual bool	support_compatible_class () const

virtual bool	get_feature_class_compatibility (EFeatureClass rhs) const

virtual CFeatures *	shallow_subset_copy ()

virtual CSGObject *	shallow_copy () const

virtual CSGObject *	deep_copy () const

virtual bool	is_generic (EPrimitiveType *generic) const

template<class T >
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

template<>
void	set_generic ()

void	unset_generic ()

virtual void	print_serializable (const char *prefix="")

virtual bool	save_serializable (CSerializableFile file, const char prefix="")

virtual bool	load_serializable (CSerializableFile file, const char prefix="")

void	set_global_io (SGIO *io)

SGIO *	get_global_io ()

void	set_global_parallel (Parallel *parallel)

Parallel *	get_global_parallel ()

void	set_global_version (Version *version)

Version *	get_global_version ()

SGStringList< char >	get_modelsel_names ()

void	print_modsel_params ()

char *	get_modsel_param_descr (const char *param_name)

index_t	get_modsel_param_index (const char *param_name)

void	build_gradient_parameter_dictionary (CMap< TParameter , CSGObject > *dict)

bool	has (const std::string &name) const

template<typename T >
bool	has (const Tag< T > &tag) const

template<typename T , typename U = void>
bool	has (const std::string &name) const

template<typename T >
void	set (const Tag< T > &_tag, const T &value)

template<typename T , typename U = void>
void	set (const std::string &name, const T &value)

template<typename T >
T	get (const Tag< T > &_tag) const

template<typename T , typename U = void>
T	get (const std::string &name) const

virtual void	update_parameter_hash ()

virtual bool	parameter_hash_changed ()

virtual bool	equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)

virtual CSGObject *	clone ()

Public Attributes
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected Member Functions
virtual void	load_serializable_pre () throw (ShogunException)

virtual void	load_serializable_post () throw (ShogunException)

virtual void	save_serializable_pre () throw (ShogunException)

virtual void	save_serializable_post () throw (ShogunException)

template<typename T >
void	register_param (Tag< T > &_tag, const T &value)

template<typename T >
void	register_param (const std::string &name, const T &value)

Protected Attributes
CInputParser< VwExample >	parser
	The parser object, which reads from input and returns parsed example objects. More...

vw_size_t	example_count
	Number of examples processed at a point of time. More...

float64_t	current_label
	The current example's label. More...

int32_t	current_length
	Number of features in current example. More...

CVwEnvironment *	env
	Environment for VW. More...

VwExample *	current_example
	Example currently being processed. More...

bool	has_labels
	Whether examples are labelled or not. More...

CStreamingFile *	working_file
	The StreamingFile object to read from. More...

bool	seekable
	Whether the stream is seekable. More...

CSubsetStack *	m_subset_stack

Constructor & Destructor Documentation

CStreamingVwFeatures ( )

Default constructor.

Sets the reading functions to be CStreamingFile::get_*_vector and get_*_vector_and_label depending on the type T.

Definition at line 20 of file StreamingVwFeatures.cpp.

CStreamingVwFeatures	(	CStreamingVwFile *	file,
		bool	is_labelled,
		int32_t	size
	)

Constructor taking args. Initializes the parser with the given args.

Parameters

file	StreamingFile object, input file.
is_labelled	Whether examples are labelled or not.
size	Number of example objects to be stored in the parser at a time.

Definition at line 26 of file StreamingVwFeatures.cpp.

CStreamingVwFeatures	(	CStreamingVwCacheFile *	file,
		bool	is_labelled,
		int32_t	size
	)

Constructor used when initialized with a cache file.

Parameters

file	StreamingVwCacheFile object
is_labelled	Whether examples are labelled or not
size	Number of example objects to be stored in the parser at a time

Definition at line 34 of file StreamingVwFeatures.cpp.

~CStreamingVwFeatures ( )

Destructor.

Ends the parsing thread. (Waits for pthread_join to complete)

Definition at line 42 of file StreamingVwFeatures.cpp.

Member Function Documentation

void add_preprocessor ( CPreprocessor * p )

virtualinherited

add preprocessor

Parameters

p	preprocessor to set

Definition at line 85 of file Features.cpp.

void add_subset ( SGVector< index_t > subset )

virtualinherited

Adds a subset of indices on top of the current subsets (possibly subset of subset). Every call causes a new active index vector to be stored. Added subsets can be removed one-by-one. If this is not needed, add_subset_in_place() should be used (does not store intermediate index vectors)

Calls subset_changed_post() afterwards

Parameters

subset subset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 310 of file Features.cpp.

void add_subset_in_place ( SGVector< index_t > subset )

virtualinherited

Sets/changes latest added subset. This allows to add multiple subsets with in-place memory requirements. They cannot be removed one-by-one afterwards, only the latest active can. If this is needed, use add_subset(). If no subset is active, this just adds.

Calls subset_changed_post() afterwards

Parameters

subset subset of indices to replace the latest one with.

Definition at line 316 of file Features.cpp.

void add_to_dense_vec	(	float32_t	alpha,
		VwExample *&	ex,
		float32_t *	vec2,
		int32_t	vec2_len,
		bool	abs_val = `false`
	)

virtual

Add alpha*an example's feature vector to another dense vector. Takes the absolute value of current_vector if specified

Parameters

alpha	alpha
ex	example whose vector should be used
vec2	vector to add to
vec2_len	length of vector
abs_val	true if abs of example's vector should be taken

Definition at line 350 of file StreamingVwFeatures.cpp.

void add_to_dense_vec	(	float32_t	alpha,
		float32_t *	vec2,
		int32_t	vec2_len,
		bool	abs_val = `false`
	)

virtual

Add alpha*current_vector to another dense vector. Takes the absolute value of current_vector if specified

Parameters

alpha	alpha
vec2	vector to add to
vec2_len	length of vector
abs_val	true if abs of current_vector should be taken

Implements CStreamingDotFeatures.

Definition at line 370 of file StreamingVwFeatures.cpp.

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > * dict )

inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters

dict	dictionary of parameters to be built.

Definition at line 630 of file SGObject.cpp.

bool check_feature_compatibility ( CFeatures * f ) const

inherited

check feature compatibility

Parameters

f	features to check for compatibility

Returns: if features are compatible

Definition at line 283 of file Features.cpp.

void clean_preprocessors ( )

inherited

clears all preprocs

Definition at line 116 of file Features.cpp.

CSGObject * clone ( )

virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns: an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 747 of file SGObject.cpp.

CFeatures * copy_dimension_subset ( SGVector< index_t > dims )

virtualinherited

Creates a new CFeatures instance containing only the dimensions of the feature vector which are specified by the provided indices.

This method is needed for feature selection tasks NOT IMPLEMENTED!

Parameters

dims	indices of feature dimensions to copy

Returns: new CFeatures instance with copies of specified features

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 348 of file Features.cpp.

CFeatures * copy_subset ( SGVector< index_t > indices )

virtualinherited

Creates a new CFeatures instance containing copies of the elements which are specified by the provided indices.

This method is needed for a KernelMachine to store its model data. NOT IMPLEMENTED!

Parameters

indices indices of feature elements to copy

Returns: new CFeatures instance with copies of feature data

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 340 of file Features.cpp.

virtual CFeatures* create_merged_copy ( CList * others )

virtualinherited

Takes a list of feature instances and returns a new instance being a concatenation of a copy of this instace's data and the given instancess data. Note that the feature types have to be equal.

NOT IMPLEMENTED!

Parameters

others list of feature objects to append

Returns: new feature object which contains copy of data of this instance and given ones

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 235 of file Features.h.

virtual CFeatures* create_merged_copy ( CFeatures * other )

virtualinherited

Convenience method for method with same name and list as parameter.

NOT IMPLEMENTED!

Parameters

other feature object to append

Returns: new feature object which contains copy of data of this instance and of given one

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, and CCombinedFeatures.

Definition at line 249 of file Features.h.

CSGObject * deep_copy ( ) const

virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 231 of file SGObject.cpp.

void del_preprocessor ( int32_t num )

virtualinherited

delete preprocessor from list

Parameters

num	index of preprocessor in list

Definition at line 122 of file Features.cpp.

float32_t dense_dot	(	VwExample *&	ex,
		const float32_t *	vec2
	)

virtual

Dot product of an example with a vector

Parameters

ex	example, as VwExample
vec2	vector to take dot product with

Returns: dot product

Definition at line 309 of file StreamingVwFeatures.cpp.

float32_t dense_dot	(	const float32_t *	vec2,
		int32_t	vec2_len
	)

virtual

Dot product of current feature vector with a dense vector which stores weights in hashed indices

Parameters

vec2	dense weight vector
vec2_len	length of weight vector (not used)

Returns: dot product

Implements CStreamingDotFeatures.

Definition at line 320 of file StreamingVwFeatures.cpp.

float32_t dense_dot	(	SGSparseVector< float32_t > *	vec1,
		const float32_t *	vec2
	)

virtual

Dot product between a dense weight vector and a sparse feature vector. Assumes the features to belong to the constant namespace.

Parameters

vec1	sparse feature vector
vec2	weight vector

Returns: dot product between dense weights and a sparse feature vector

Definition at line 325 of file StreamingVwFeatures.cpp.

void dense_dot_range	(	float32_t *	output,
		float32_t *	alphas,
		float32_t *	vec,
		int32_t	dim,
		float32_t	b,
		int32_t	num_vec = `0`
	)

virtualinherited

Compute the dot product for all vectors. This function makes use of dense_dot alphas[i] * sparse[i]^T * w + b

Parameters

output	result for the given vector range
alphas	scalars to multiply with, may be NULL
vec	dense vector to compute dot product with
dim	length of the dense vector
b	bias
num_vec	number of vectors to operate on (indices 0 to num_vec-1)

If num_vec == 0 or left to its default value, the function attempts to return dot product for all vectors. However, the given output vector must be preallocated!

note that the result will be written to output[0...(num_vec-1)] except when num_vec = 0

Definition at line 30 of file StreamingDotFeatures.cpp.

float32_t dense_dot_truncated	(	const float32_t *	vec2,
		VwExample *&	ex,
		float32_t	gravity
	)

virtual

Calculate dot product of features with another vector, truncating the elements of that vector by magnitude 'gravity' to a minimum final magnitude of zero.

Parameters

vec2	vector to take dot product with
ex	example whose features have to be taken
gravity	value to use for truncating

Returns: dot product

Definition at line 334 of file StreamingVwFeatures.cpp.

float32_t dot ( CStreamingDotFeatures * df )

virtual

Dot product taken with another StreamingDotFeatures object.

Currently only works if it is a CStreamingVwFeatures object. It takes the dot product of the current_vectors of both objects.

Parameters

df	CStreamingDotFeatures object.

Returns: Dot product.

Implements CStreamingDotFeatures.

Definition at line 303 of file StreamingVwFeatures.cpp.

CFeatures * duplicate ( ) const

virtual

Duplicate this object

Returns: a copy of this object

Implements CFeatures.

Definition at line 49 of file StreamingVwFeatures.cpp.

void end_parser ( )

virtual

Ends the parsing thread.

Waits for the thread to join.

Implements CStreamingFeatures.

Definition at line 244 of file StreamingVwFeatures.cpp.

bool equals	(	CSGObject *	other,
		float64_t	accuracy = `0.0`,
		bool	tolerant = `false`
	)

virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

Returns: true if all parameters were equal, false if not

Definition at line 651 of file SGObject.cpp.

void expand_if_required	(	float32_t *&	vec,
		int32_t &	len
	)

virtual

Expand the vector passed so that it its length is equal to the dimensionality of the features. The previous values are kept intact through realloc, and the new ones are set to zero.

Parameters

vec	float32_t* vector
len	length of the vector

Reimplemented from CStreamingDotFeatures.

Definition at line 93 of file StreamingVwFeatures.cpp.

void expand_if_required	(	float64_t *&	vec,
		int32_t &	len
	)

virtual

Expand the vector passed so that it its length is equal to the dimensionality of the features. The previous values are kept intact through realloc, and the new ones are set to zero.

Parameters

vec	float64_t* vector
len	length of the vector

Reimplemented from CStreamingDotFeatures.

Definition at line 104 of file StreamingVwFeatures.cpp.

void free_feature_iterator ( void * iterator )

virtualinherited

clean up iterator call this function with the iterator returned by get_first_feature

Parameters

iterator as returned by get_first_feature

Definition at line 93 of file StreamingDotFeatures.cpp.

T get ( const Tag< T > & _tag ) const

inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters

_tag	name and type information of parameter

Returns: value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string & name ) const

inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters

name	name of the parameter

Returns: value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

int32_t get_cache_size ( ) const

inherited

get cache size

Returns: cache size

Definition at line 160 of file Features.cpp.

int32_t get_dim_feature_space ( ) const

virtual

obtain the dimensionality of the feature space

(not mix this up with the dimensionality of the input space, usually obtained via get_num_features())

Returns: dimensionality

Implements CStreamingDotFeatures.

Definition at line 298 of file StreamingVwFeatures.cpp.

CVwEnvironment * get_env ( )

virtual

Get the environment

Returns: environment

Definition at line 78 of file StreamingVwFeatures.cpp.

VwExample * get_example ( )

virtual

Returns the current example.

Returns: current example as VwExample*

Definition at line 269 of file StreamingVwFeatures.cpp.

EFeatureClass get_feature_class ( ) const

virtual

Return the feature class

Returns: C_STREAMING_VW

Implements CFeatures.

Definition at line 380 of file StreamingVwFeatures.cpp.

bool get_feature_class_compatibility ( EFeatureClass rhs ) const

virtualinherited

Given a class in right hand side, does this class support compatible computation?

for example, is this->dot(rhs_prt) valid, where rhs_prt is the class in right hand side

Parameters

rhs	the class in right hand side

Returns: whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 355 of file Features.cpp.

void * get_feature_iterator ( )

virtualinherited

iterate over the non-zero features

call get_feature_iterator first, followed by get_next_feature and free_feature_iterator to cleanup

Returns: feature iterator (to be passed to get_next_feature)

Definition at line 75 of file StreamingDotFeatures.cpp.

EFeatureType get_feature_type ( ) const

virtual

Return the feature type, depending on T.

Returns: Feature type as EFeatureType

Implements CFeatures.

Definition at line 136 of file StreamingVwFeatures.cpp.

SGIO * get_global_io ( )

inherited

get the io object

Returns: io object

Definition at line 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )

inherited

get the parallel object

Returns: parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )

inherited

get the version object

Returns: version object

Definition at line 323 of file SGObject.cpp.

bool get_has_labels ( )

virtualinherited

Return whether the examples are labelled or not.

Returns: true if labelled, else false

Definition at line 35 of file StreamingFeatures.cpp.

float64_t get_label ( )

virtual

Return the label of the current example as a float.

Examples must be labelled, otherwise an error occurs.

Returns: The label as a float64_t.

Implements CStreamingFeatures.

Definition at line 274 of file StreamingVwFeatures.cpp.

SGStringList< char > get_modelsel_names ( )

inherited

Returns: vector of names of all parameters which are registered for model selection

Definition at line 531 of file SGObject.cpp.

char * get_modsel_param_descr ( const char * param_name )

inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters

param_name name of the parameter

Returns: description of the parameter

Definition at line 555 of file SGObject.cpp.

index_t get_modsel_param_index ( const char * param_name )

inherited

Returns index of model selection parameter with provided index

Parameters

param_name name of model selection parameter

Returns: index of model selection parameter with provided name, -1 if there is no such

Definition at line 568 of file SGObject.cpp.

virtual const char* get_name ( ) const

virtual

Return the name.

Returns: StreamingVwFeatures

Implements CSGObject.

Definition at line 331 of file StreamingVwFeatures.h.

bool get_next_example ( )

virtual

Instructs the parser to return the next example.

This example is stored as the current_example in this object.

Returns: True on success, false if there are no more examples, or an error occurred.

Implements CStreamingFeatures.

Definition at line 249 of file StreamingVwFeatures.cpp.

bool get_next_feature	(	int32_t &	index,
		float32_t &	value,
		void *	iterator
	)

virtualinherited

iterate over the non-zero features

call this function with the iterator returned by get_first_feature and call free_feature_iterator to cleanup

Parameters

index	is returned by reference (-1 when not available)
value	is returned by reference
iterator	as returned by get_first_feature

Returns: true if a new non-zero feature got returned

Definition at line 87 of file StreamingDotFeatures.cpp.

int32_t get_nnz_features_for_vector ( )

virtual

get number of non-zero features in vector

Returns: number of non-zero features in vector

Reimplemented from CStreamingDotFeatures.

Definition at line 123 of file StreamingVwFeatures.cpp.

int32_t get_num_features ( )

virtual

Return the number of features in the current example.

Returns: number of features as int

Implements CStreamingFeatures.

Definition at line 375 of file StreamingVwFeatures.cpp.

int32_t get_num_preprocessed ( ) const

inherited

get the number of applied preprocs

Returns: number of applied preprocessors

Definition at line 103 of file Features.cpp.

int32_t get_num_preprocessors ( ) const

inherited

get number of preprocessors

Returns: number of preprocessors

Definition at line 155 of file Features.cpp.

int32_t get_num_vectors ( ) const

virtual

Return the number of vectors stored in this object.

Returns: 1 if current_example exists, else 0.

Implements CFeatures.

Definition at line 128 of file StreamingVwFeatures.cpp.

CPreprocessor * get_preprocessor ( int32_t num ) const

inherited

get specified preprocessor

Parameters

num	index of preprocessor in list

Definition at line 93 of file Features.cpp.

virtual CFeatures* get_streamed_features ( index_t num_elements )

virtualinherited

Returns a new CFeatures instance which contains num_elements elements from the underlying stream. Not SG_REF'ed

Parameters

num_elements num elements to save from stream

Returns: CFeatures object of underlying type, might be smaller than requested if the stream stopped. A warning is issued in this case.

NOT IMPLEMENTED!

Reimplemented in CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t >, and CStreamingDenseFeatures< float32_t >.

Definition at line 191 of file StreamingFeatures.h.

CSubsetStack * get_subset_stack ( )

virtualinherited

returns subset stack

Returns: subset stack

Definition at line 334 of file Features.cpp.

bool has ( const std::string & name ) const

inherited

Checks if object has a class parameter identified by a name.

Parameters

name	name of the parameter

Returns: true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > & tag ) const

inherited

Checks if object has a class parameter identified by a Tag.

Parameters

tag	tag of the parameter containing name and type information

Returns: true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

bool has ( const std::string & name ) const

inherited

Checks if a type exists for a class parameter identified by a name.

Parameters

name	name of the parameter

Returns: true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

bool has_property ( EFeatureProperty p ) const

inherited

check if features have given property

Parameters

p	feature property

Returns: if features have given property

Definition at line 295 of file Features.cpp.

bool is_generic ( EPrimitiveType * generic ) const

virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters

generic set to the type of the generic if returning TRUE

Returns: TRUE if a class template.

Definition at line 329 of file SGObject.cpp.

bool is_preprocessed ( int32_t num ) const

inherited

get whether specified preprocessor was already applied

Parameters

num	index of preprocessor in list

Definition at line 149 of file Features.cpp.

bool is_seekable ( )

virtualinherited

Whether the stream is seekable (to check if multiple epochs are possible), i.e., whether we can process examples in a batch fashion.

A stream can usually seekable when it comes from a file or when it comes from another conventional CFeatures object.

Returns: true if seekable, else false.

Definition at line 40 of file StreamingFeatures.cpp.

void list_feature_obj ( ) const

inherited

list feature object

Definition at line 171 of file Features.cpp.

void list_preprocessors ( )

inherited

print preprocessors

Definition at line 131 of file Features.cpp.

void load ( CFile * loader )

virtualinherited

load features from file

Parameters

loader File object via which data shall be loaded

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 269 of file Features.cpp.

bool load_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`
	)

virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters

file	where to load from
prefix	prefix for members

Returns: TRUE if done, otherwise FALSE

Definition at line 402 of file SGObject.cpp.

void load_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 459 of file SGObject.cpp.

void load_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 454 of file SGObject.cpp.

bool parameter_hash_changed ( )

virtualinherited

Returns: whether parameter combination has changed since last update

Definition at line 295 of file SGObject.cpp.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

Definition at line 507 of file SGObject.cpp.

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

Parameters

prefix prefix for members

Definition at line 341 of file SGObject.cpp.

float32_t real_weight	(	float32_t	w,
		float32_t	gravity
	)

virtual

Reduce element 'w' to max(w-gravity, 0)

Parameters

w	value to truncate
gravity	value to truncate using

Returns: truncated value

Definition at line 115 of file StreamingVwFeatures.cpp.

void register_param	(	Tag< T > &	_tag,
		const T &	value
	)

protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters

_tag	name and type information of parameter
value	value of the parameter

Definition at line 439 of file SGObject.h.

void register_param	(	const std::string &	name,
		const T &	value
	)

protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters

name	name of the parameter
value	value of the parameter along with type information

Definition at line 452 of file SGObject.h.

void release_example ( )

virtual

Release the current example, indicating to the parser that it has been processed by the learning algorithm.

The parser is then free to throw away that example.

Implements CStreamingFeatures.

Definition at line 281 of file StreamingVwFeatures.cpp.

void remove_all_subsets ( )

virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 328 of file Features.cpp.

void remove_subset ( )

virtualinherited

removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 322 of file Features.cpp.

void reset_stream ( )

virtual

Reset the file back to the first example. Only works for cache files.

Reimplemented from CStreamingFeatures.

Definition at line 64 of file StreamingVwFeatures.cpp.

bool reshape	(	int32_t	num_features,
		int32_t	num_vectors
	)

virtualinherited

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

Parameters

num_features	new number of features
num_vectors	new number of vectors

Returns: if reshaping was successful

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 165 of file Features.cpp.

void save ( CFile * writer )

virtualinherited

save features to file

Parameters

writer File object via which data shall be saved

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, and CSparseFeatures< T >.

Definition at line 276 of file Features.cpp.

bool save_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`
	)

virtualinherited

Save this object to file.

Parameters

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

Returns: TRUE if done, otherwise FALSE

Definition at line 347 of file SGObject.cpp.

void save_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 469 of file SGObject.cpp.

void save_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 464 of file SGObject.cpp.

void set	(	const Tag< T > &	_tag,
		const T &	value
	)

inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters

_tag	name and type information of parameter
value	value of the parameter

Definition at line 328 of file SGObject.h.

void set	(	const std::string &	name,
		const T &	value
	)

inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters

name	name of the parameter
value	value of the parameter along with type information

Definition at line 354 of file SGObject.h.

void set_env ( CVwEnvironment * vw_env )

virtual

Set the environment

Parameters

vw_env environment

Definition at line 83 of file StreamingVwFeatures.cpp.

void set_generic ( )

inherited

Definition at line 74 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 144 of file SGObject.cpp.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO * io )

inherited

set the io object

Parameters

io	io object to use

Definition at line 261 of file SGObject.cpp.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

Parameters

parallel parallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version * version )

inherited

set the version object

Parameters

version version object to use

Definition at line 316 of file SGObject.cpp.

void set_preprocessed ( int32_t num )

inherited

set applied flag for preprocessor

Parameters

num	index of preprocessor in list

Definition at line 143 of file Features.cpp.

void set_property ( EFeatureProperty p )

inherited

set property

Parameters

p	kernel property to set

Definition at line 300 of file Features.cpp.

void set_read_functions ( )

inherited

Set the vector reading functions.

The functions are implemented specific to the type in the derived class.

Definition at line 29 of file StreamingFeatures.cpp.

void set_vector_and_label_reader ( )

virtual

Sets the read function (in case the examples are labelled) to get_*_vector_and_label from CStreamingFile.

The exact function depends on type T.

The parser uses the function set by this while reading labelled examples.

Implements CStreamingFeatures.

Definition at line 59 of file StreamingVwFeatures.cpp.

void set_vector_reader ( )

virtual

Sets the read function (in case the examples are unlabelled) to get_*_vector() from CStreamingFile.

The exact function depends on type T.

The parser uses the function set by this while reading unlabelled examples.

Implements CStreamingFeatures.

Definition at line 54 of file StreamingVwFeatures.cpp.

CSGObject * shallow_copy ( ) const

virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 225 of file SGObject.cpp.

virtual CFeatures* shallow_subset_copy ( )

virtualinherited

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 336 of file Features.h.

void start_parser ( )

virtual

Starts the parsing thread.

To be called before trying to use any feature vectors from this object.

Implements CStreamingFeatures.

Definition at line 238 of file StreamingVwFeatures.cpp.

virtual void subset_changed_post ( )

virtualinherited

method may be overwritten to update things that depend on subset

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 293 of file Features.h.

virtual bool support_compatible_class ( ) const

virtualinherited

does this class support compatible computation bewteen difference classes? for example, this->dot(rhs_prt), can rhs_prt be an instance of a difference class?

Returns: whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 323 of file Features.h.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 336 of file SGObject.cpp.

void unset_property ( EFeatureProperty p )

inherited

unset property

Parameters

p	kernel property to unset

Definition at line 305 of file Features.cpp.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

VwExample* current_example

protected

Example currently being processed.

Definition at line 391 of file StreamingVwFeatures.h.

float64_t current_label

protected

The current example's label.

Definition at line 382 of file StreamingVwFeatures.h.

int32_t current_length

protected

Number of features in current example.

Definition at line 385 of file StreamingVwFeatures.h.

CVwEnvironment* env

protected

Environment for VW.

Definition at line 388 of file StreamingVwFeatures.h.

vw_size_t example_count

protected

Number of examples processed at a point of time.

Definition at line 379 of file StreamingVwFeatures.h.

bool has_labels

protectedinherited

Whether examples are labelled or not.

Definition at line 201 of file StreamingFeatures.h.

SGIO* io

inherited

io

Definition at line 537 of file SGObject.h.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

Definition at line 552 of file SGObject.h.

uint32_t m_hash

inherited

Hash of parameter values

Definition at line 555 of file SGObject.h.

Parameter* m_model_selection_parameters

inherited

model selection parameters

Definition at line 549 of file SGObject.h.

Parameter* m_parameters

inherited

parameters

Definition at line 546 of file SGObject.h.

CSubsetStack* m_subset_stack

protectedinherited

subset used for index transformations

Definition at line 361 of file Features.h.

Parallel* parallel

inherited

parallel

Definition at line 540 of file SGObject.h.

CInputParser<VwExample> parser

protected

The parser object, which reads from input and returns parsed example objects.

Definition at line 376 of file StreamingVwFeatures.h.

bool seekable

protectedinherited

Whether the stream is seekable.

Definition at line 207 of file StreamingFeatures.h.

Version* version

inherited

version

Definition at line 543 of file SGObject.h.

CStreamingFile* working_file

protectedinherited

The StreamingFile object to read from.

Definition at line 204 of file StreamingFeatures.h.

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

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation