SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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:
Inheritance graph
[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 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::get_version_parameter())
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_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_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
virtual void update_parameter_hash ()
virtual bool parameter_hash_changed ()
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
virtual CSGObjectclone ()

Public Attributes

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

Constructor & Destructor Documentation

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 1243 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 1360 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 200 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 1264 of file SGObject.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 237 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 278 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 291 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 1135 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 1159 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 1172 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 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 297 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.

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_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 704 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_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 545 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 374 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 1062 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 1057 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_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 742 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

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_baseset of TParameter instances to use for migration
targetparameter 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 949 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.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 889 of file SGObject.cpp.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 263 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1111 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 309 of file SGObject.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 315 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 1072 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 1067 of file SGObject.cpp.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 42 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 230 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 243 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 284 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 194 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 304 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 250 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 496 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 511 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 517 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 508 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 514 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 505 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 499 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.

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 502 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