SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
CVwEnvironment Class Reference

Detailed Description

Class CVwEnvironment is the environment used by VW.

Contains global constants and settings which change the behaviour of Vowpal Wabbit.

It is used while parsing input, and also while learning.

One CVwEnvironment object should be bound to the CStreamingVwFile or CStreamingVwCacheFile, and the pointer to it propagated upwards to CStreamingVwFeatures and finally to CVowpalWabbit.

Definition at line 41 of file VwEnvironment.h.

Inheritance diagram for CVwEnvironment:
[legend]

Public Member Functions

 CVwEnvironment ()
 
virtual ~CVwEnvironment ()
 
void set_num_bits (vw_size_t bits)
 
vw_size_t get_num_bits ()
 
void set_mask (vw_size_t m)
 
vw_size_t get_mask ()
 
float64_t get_min_label ()
 
float64_t get_max_label ()
 
vw_size_t num_threads ()
 
vw_size_t length ()
 
void set_stride (vw_size_t new_stride)
 
virtual const char * get_name () const
 
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

vw_size_t num_bits
 log_2 of the number of features More...
 
vw_size_t thread_bits
 log_2 of the number of threads More...
 
vw_size_t mask
 Mask used for hashing. More...
 
vw_size_t thread_mask
 Mask used by regressor for learning. More...
 
vw_size_t stride
 Number of elements in weight vector per feature. More...
 
float64_t min_label
 Smallest label seen. More...
 
float64_t max_label
 Largest label seen. More...
 
float32_t eta
 Learning rate. More...
 
float32_t eta_decay_rate
 Decay rate of eta per pass. More...
 
bool adaptive
 Whether adaptive learning is used. More...
 
bool exact_adaptive_norm
 Whether exact norm is used for adaptive learning. More...
 
float32_t l1_regularization
 Level of L1 regularization. More...
 
bool random_weights
 Whether to use random weights. More...
 
float32_t initial_weight
 Initial value of all elements in weight vector. More...
 
float32_t update_sum
 Sum of updates. More...
 
float32_t t
 Value of t. More...
 
float64_t initial_t
 Initial value of t. More...
 
float32_t power_t
 t power value while updating More...
 
int64_t example_number
 Example number. More...
 
float64_t weighted_examples
 Weighted examples. More...
 
float64_t weighted_unlabeled_examples
 Weighted unlabelled examples. More...
 
float64_t weighted_labels
 Weighted labels. More...
 
vw_size_t total_features
 Total number of features. More...
 
float64_t sum_loss
 Sum of losses. More...
 
vw_size_t passes_complete
 Number of passes complete. More...
 
vw_size_t num_passes
 Number of passes. More...
 
vw_size_t ngram
 ngrams to generate More...
 
vw_size_t skips
 Skips in ngrams. More...
 
bool ignore_some
 Whether some namespaces are ignored. More...
 
bool ignore [256]
 Which namespaces to ignore. More...
 
DynArray< char * > pairs
 Pairs of features to cross for quadratic updates. More...
 
const char * vw_version
 VW version. More...
 
vw_size_t v_length
 Length of version string. More...
 
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)
 

Constructor & Destructor Documentation

CVwEnvironment ( )

Default constructor Should initialize with reasonable default values

Definition at line 19 of file VwEnvironment.cpp.

virtual ~CVwEnvironment ( )
virtual

Destructor

Definition at line 53 of file VwEnvironment.h.

Member Function Documentation

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
dictdictionary of parameters to be built.

Definition at line 630 of file SGObject.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.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 231 of file SGObject.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
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows 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.

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
_tagname 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
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

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.

vw_size_t get_mask ( )

Return the mask used

Returns
mask

Definition at line 77 of file VwEnvironment.h.

float64_t get_max_label ( )

Return maximum label encountered

Returns
max label

Definition at line 89 of file VwEnvironment.h.

float64_t get_min_label ( )

Return minimum label encountered

Returns
min label

Definition at line 83 of file VwEnvironment.h.

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_namename 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_namename 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 of the object

Returns
VwEnvironment

Implements CSGObject.

Definition at line 116 of file VwEnvironment.h.

vw_size_t get_num_bits ( )

Return number of bits used for weight vector

Returns
number of bits

Definition at line 65 of file VwEnvironment.h.

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

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

Parameters
namename 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
tagtag 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
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

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
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 329 of file SGObject.cpp.

vw_size_t length ( )

Return length of weight vector

Returns
length of weight vector

Definition at line 101 of file VwEnvironment.h.

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
filewhere to load from
prefixprefix 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
ShogunExceptionwill 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
ShogunExceptionwill 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.

vw_size_t num_threads ( )

Return number of threads used for learning

Returns
number of threads

Definition at line 95 of file VwEnvironment.h.

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
prefixprefix for members

Definition at line 341 of file SGObject.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
_tagname and type information of parameter
valuevalue 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
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 452 of file SGObject.h.

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

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix 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
ShogunExceptionwill 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
ShogunExceptionwill 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
_tagname and type information of parameter
valuevalue 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
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 354 of file SGObject.h.

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
ioio object to use

Definition at line 261 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 316 of file SGObject.cpp.

void set_mask ( vw_size_t  m)

Set mask used while accessing features

Parameters
mmask

Definition at line 71 of file VwEnvironment.h.

void set_num_bits ( vw_size_t  bits)

Set number of bits used for the weight vector

Parameters
bitsnumber of bits

Definition at line 59 of file VwEnvironment.h.

void set_stride ( vw_size_t  new_stride)

Set a new stride value. Also changes thread_mask.

Parameters
new_stridenew value of stride

Definition at line 69 of file VwEnvironment.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.

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 update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

bool adaptive

Whether adaptive learning is used.

Definition at line 147 of file VwEnvironment.h.

float32_t eta

Learning rate.

Definition at line 142 of file VwEnvironment.h.

float32_t eta_decay_rate

Decay rate of eta per pass.

Definition at line 144 of file VwEnvironment.h.

bool exact_adaptive_norm

Whether exact norm is used for adaptive learning.

Definition at line 149 of file VwEnvironment.h.

int64_t example_number

Example number.

Definition at line 169 of file VwEnvironment.h.

bool ignore[256]

Which namespaces to ignore.

Definition at line 193 of file VwEnvironment.h.

bool ignore_some

Whether some namespaces are ignored.

Definition at line 191 of file VwEnvironment.h.

float64_t initial_t

Initial value of t.

Definition at line 164 of file VwEnvironment.h.

float32_t initial_weight

Initial value of all elements in weight vector.

Definition at line 156 of file VwEnvironment.h.

SGIO* io
inherited

io

Definition at line 537 of file SGObject.h.

float32_t l1_regularization

Level of L1 regularization.

Definition at line 151 of file VwEnvironment.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.

vw_size_t mask

Mask used for hashing.

Definition at line 130 of file VwEnvironment.h.

float64_t max_label

Largest label seen.

Definition at line 139 of file VwEnvironment.h.

float64_t min_label

Smallest label seen.

Definition at line 137 of file VwEnvironment.h.

vw_size_t ngram

ngrams to generate

Definition at line 186 of file VwEnvironment.h.

vw_size_t num_bits

log_2 of the number of features

Definition at line 126 of file VwEnvironment.h.

vw_size_t num_passes

Number of passes.

Definition at line 183 of file VwEnvironment.h.

DynArray<char*> pairs

Pairs of features to cross for quadratic updates.

Definition at line 196 of file VwEnvironment.h.

Parallel* parallel
inherited

parallel

Definition at line 540 of file SGObject.h.

vw_size_t passes_complete

Number of passes complete.

Definition at line 181 of file VwEnvironment.h.

float32_t power_t

t power value while updating

Definition at line 166 of file VwEnvironment.h.

bool random_weights

Whether to use random weights.

Definition at line 154 of file VwEnvironment.h.

vw_size_t skips

Skips in ngrams.

Definition at line 188 of file VwEnvironment.h.

vw_size_t stride

Number of elements in weight vector per feature.

Definition at line 134 of file VwEnvironment.h.

float64_t sum_loss

Sum of losses.

Definition at line 179 of file VwEnvironment.h.

float32_t t

Value of t.

Definition at line 162 of file VwEnvironment.h.

vw_size_t thread_bits

log_2 of the number of threads

Definition at line 128 of file VwEnvironment.h.

vw_size_t thread_mask

Mask used by regressor for learning.

Definition at line 132 of file VwEnvironment.h.

vw_size_t total_features

Total number of features.

Definition at line 177 of file VwEnvironment.h.

float32_t update_sum

Sum of updates.

Definition at line 159 of file VwEnvironment.h.

vw_size_t v_length

Length of version string.

Definition at line 201 of file VwEnvironment.h.

Version* version
inherited

version

Definition at line 543 of file SGObject.h.

const char* vw_version

VW version.

Definition at line 199 of file VwEnvironment.h.

float64_t weighted_examples

Weighted examples.

Definition at line 171 of file VwEnvironment.h.

float64_t weighted_labels

Weighted labels.

Definition at line 175 of file VwEnvironment.h.

float64_t weighted_unlabeled_examples

Weighted unlabelled examples.

Definition at line 173 of file VwEnvironment.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation