Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

CStreamingVwFeatures Class Reference


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 39 of file StreamingVwFeatures.h.

Inheritance diagram for CStreamingVwFeatures:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CStreamingVwFeatures ()
 CStreamingVwFeatures (CStreamingVwFile *file, bool is_labelled, int32_t size)
 CStreamingVwFeatures (CStreamingVwCacheFile *file, bool is_labelled, int32_t size)
 ~CStreamingVwFeatures ()
CFeaturesduplicate () 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 CVwEnvironmentget_env ()
virtual void set_env (CVwEnvironment *vw_env)
virtual bool get_next_example ()
virtual VwExampleget_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 int32_t get_size () 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 CFeaturesget_streamed_features (index_t num_elements)
virtual int32_t add_preprocessor (CPreprocessor *p)
 set preprocessor
virtual CPreprocessordel_preprocessor (int32_t num)
 del current preprocessor
CPreprocessorget_preprocessor (int32_t num) const
 get current preprocessor
void set_preprocessed (int32_t num)
bool is_preprocessed (int32_t num) const
int32_t get_num_preprocessed () const
 get whether specified preprocessor (or all if num=1) was/were already applied
int32_t get_num_preprocessors () const
void clean_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 CFeaturescreate_merged_copy (CFeatures *other)
virtual void add_subset (SGVector< index_t > subset)
virtual void remove_subset ()
virtual void remove_all_subsets ()
virtual CSubsetStackget_subset_stack ()
virtual void subset_changed_post ()
virtual CFeaturescopy_subset (SGVector< index_t > indices)
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_copy () const
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
void set_generic ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
void map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos)
void set_global_io (SGIO *io)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
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)
virtual bool update_parameter_hash ()

Protected Attributes

CInputParser< VwExampleparser
 The parser object, which reads from input and returns parsed example objects.
vw_size_t example_count
 Number of examples processed at a point of time.
float64_t current_label
 The current example's label.
int32_t current_length
 Number of features in current example.
CVwEnvironmentenv
 Environment for VW.
VwExamplecurrent_example
 Example currently being processed.
float32_t combined_weight
 feature weighting in combined dot features
bool has_labels
 Whether examples are labelled or not.
CStreamingFileworking_file
 The StreamingFile object to read from.
bool seekable
 Whether the stream is seekable.
CSubsetStackm_subset_stack

Constructor & Destructor Documentation

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.

Destructor.

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

Definition at line 42 of file StreamingVwFeatures.cpp.


Member Function Documentation

int32_t add_preprocessor ( CPreprocessor p  )  [virtual, inherited]

set preprocessor

add preprocessor

Parameters:
p preprocessor to set
Returns:
something inty

Definition at line 81 of file Features.cpp.

void add_subset ( SGVector< index_t subset  )  [virtual, inherited]

adds a subset of indices on top of the current subsets (possibly subset o subset. Calls subset_changed_post() afterwards

Parameters:
subset subset of indices to add

Reimplemented in CCombinedFeatures.

Definition at line 351 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_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 1201 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 326 of file Features.cpp.

void clean_preprocessors (  )  [inherited]

clears all preprocs

Definition at line 137 of file Features.cpp.

CFeatures * copy_subset ( SGVector< index_t indices  )  [virtual, inherited]

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 CCombinedFeatures, CDenseFeatures< ST >, CSparseFeatures< ST >, CStringFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 374 of file Features.cpp.

virtual CFeatures* create_merged_copy ( CFeatures other  )  [virtual, inherited]

Takes another feature instance and returns a new instance which is a concatenation of a copy if this instace's data and the given instance's data. Note that the feature types have to be equal.

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 CCombinedFeatures, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 234 of file Features.h.

virtual CSGObject* deep_copy (  )  const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

CPreprocessor * del_preprocessor ( int32_t  num  )  [virtual, inherited]

del current preprocessor

delete preprocessor from list caller has to clean up returned preproc

Parameters:
num index of preprocessor in list

Definition at line 143 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 
) [virtual, inherited]

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 48 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.

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 89 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 100 of file StreamingVwFeatures.cpp.

void free_feature_iterator ( void *  iterator  )  [virtual, inherited]

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.

int32_t get_cache_size (  )  const [inherited]

get cache size

Returns:
cache size

Definition at line 203 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 77 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.

void * get_feature_iterator (  )  [virtual, inherited]

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 137 of file StreamingVwFeatures.cpp.

SGIO * get_global_io (  )  [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel (  )  [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version (  )  [inherited]

get the version object

Returns:
version object

Definition at line 272 of file SGObject.cpp.

bool get_has_labels (  )  [virtual, inherited]

Return whether the examples are labelled or not.

Returns:
true if labelled, else false

Definition at line 34 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 1108 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 1132 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 1145 of file SGObject.cpp.

virtual const char* get_name (  )  const [virtual]

Return the name.

Returns:
StreamingVwFeatures

Implements CSGObject.

Definition at line 329 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 
) [virtual, inherited]

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 119 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 whether specified preprocessor (or all if num=1) was/were already applied

get the number of applied preprocs

Returns:
number of applied preprocessors

Definition at line 123 of file Features.cpp.

int32_t get_num_preprocessors (  )  const [inherited]

get number of preprocessors

Returns:
number of preprocessors

Definition at line 198 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 124 of file StreamingVwFeatures.cpp.

CPreprocessor * get_preprocessor ( int32_t  num  )  const [inherited]

get current preprocessor

get specified preprocessor

Parameters:
num index of preprocessor in list

Definition at line 111 of file Features.cpp.

int32_t get_size (  )  const [virtual]

Return the size of one T object.

Returns:
Size of T.

Implements CFeatures.

Definition at line 132 of file StreamingVwFeatures.cpp.

virtual CFeatures* get_streamed_features ( index_t  num_elements  )  [virtual, inherited]

Returns a CFeatures instance which contains num_elements elements from the underlying stream

Parameters:
num_elements num elements to save from stream
Returns:
CFeatures object of underlying type, NULL if not enough data

NOT IMPLEMENTED!

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

Definition at line 188 of file StreamingFeatures.h.

CSubsetStack * get_subset_stack (  )  [virtual, inherited]

returns subset stack

Returns:
subset stack

Definition at line 369 of file Features.cpp.

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 336 of file Features.cpp.

bool is_generic ( EPrimitiveType *  generic  )  const [virtual, inherited]

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 278 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 193 of file Features.cpp.

bool is_seekable (  )  [virtual, inherited]

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 39 of file StreamingFeatures.cpp.

void list_feature_obj (  )  const [inherited]

list feature object

Definition at line 214 of file Features.cpp.

void load ( CFile loader  )  [virtual, inherited]
DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
) [inherited]

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters:
file_version parameter version of the file
current_version version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
file file to load from
prefix prefix for members
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 679 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
) [inherited]

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters:
param_info information of parameter
file_version parameter version of the file, must be <= provided parameter version
file file to load from
prefix prefix for members
Returns:
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

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
param_version (optional) a parameter version different to (this is mainly for testing, better do not use)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 354 of file SGObject.cpp.

void load_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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 occurres.

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

Definition at line 1033 of file SGObject.cpp.

void load_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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 occurres.

Definition at line 1028 of file SGObject.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
) [inherited]

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters:
param_base set of TParameter instances that are mapped to the provided target parameter infos
base_version version of the parameter base
target_param_infos set of SGParamInfo instances that specify the target parameter base

Definition at line 717 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
) [protected, virtual, inherited]

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters:
param_base set of TParameter instances to use for migration
target parameter info for the resulting TParameter
Returns:
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 923 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
) [protected, virtual, inherited]

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters:
param_base set of TParameter instances to use for migration
target parameter info for the resulting TParameter
replacement (used as output) here the TParameter instance which is returned by migration is created into
to_migrate the only source that is used for migration
old_name with this parameter, a name change may be specified

Definition at line 864 of file SGObject.cpp.

void print_modsel_params (  )  [inherited]

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

void print_serializable ( const char *  prefix = ""  )  [virtual, inherited]

prints registered parameters out

Parameters:
prefix prefix for members

Definition at line 290 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 111 of file StreamingVwFeatures.cpp.

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 (  )  [virtual, inherited]

removes all subsets Calls subset_changed_post() afterwards

Reimplemented in CCombinedFeatures.

Definition at line 363 of file Features.cpp.

void remove_subset (  )  [virtual, inherited]

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

Reimplemented in CCombinedFeatures.

Definition at line 357 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 63 of file StreamingVwFeatures.cpp.

bool reshape ( int32_t  num_features,
int32_t  num_vectors 
) [virtual, inherited]

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 208 of file Features.cpp.

void save ( CFile writer  )  [virtual, inherited]
bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

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
param_version (optional) a parameter version different to (this is mainly for testing, better do not use)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 296 of file SGObject.cpp.

void save_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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 occurres.

Reimplemented in CKernel.

Definition at line 1043 of file SGObject.cpp.

void save_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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 occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

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< floatmax_t > (  )  [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 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 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 188 of file Features.cpp.

void set_property ( EFeatureProperty  p  )  [inherited]

set property

Parameters:
p kernel property to set

Definition at line 341 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 28 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 58 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 53 of file StreamingVwFeatures.cpp.

virtual CSGObject* shallow_copy (  )  const [virtual, inherited]

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

Reimplemented in CGaussianKernel.

Definition at line 122 of file SGObject.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 (  )  [virtual, inherited]

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 262 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 285 of file SGObject.cpp.

void unset_property ( EFeatureProperty  p  )  [inherited]

unset property

Parameters:
p kernel property to unset

Definition at line 346 of file Features.cpp.

bool update_parameter_hash (  )  [protected, virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 237 of file SGObject.cpp.


Member Data Documentation

float32_t combined_weight [protected, inherited]

feature weighting in combined dot features

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

Definition at line 186 of file StreamingDotFeatures.h.

VwExample* current_example [protected]

Example currently being processed.

Definition at line 396 of file StreamingVwFeatures.h.

float64_t current_label [protected]

The current example's label.

Definition at line 387 of file StreamingVwFeatures.h.

int32_t current_length [protected]

Number of features in current example.

Definition at line 390 of file StreamingVwFeatures.h.

CVwEnvironment* env [protected]

Environment for VW.

Definition at line 393 of file StreamingVwFeatures.h.

vw_size_t example_count [protected]

Number of examples processed at a point of time.

Definition at line 384 of file StreamingVwFeatures.h.

bool has_labels [protected, inherited]

Whether examples are labelled or not.

Reimplemented in CStreamingStringFeatures< T >.

Definition at line 198 of file StreamingFeatures.h.

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

model selection parameters

Definition at line 474 of file SGObject.h.

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 471 of file SGObject.h.

CSubsetStack* m_subset_stack [protected, inherited]

subset used for index transformations

Definition at line 296 of file Features.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

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

Definition at line 381 of file StreamingVwFeatures.h.

bool seekable [protected, inherited]

Whether the stream is seekable.

Definition at line 204 of file StreamingFeatures.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.

CStreamingFile* working_file [protected, inherited]

The StreamingFile object to read from.

Reimplemented in CStreamingStringFeatures< T >.

Definition at line 201 of file StreamingFeatures.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation