SHOGUN
v3.2.0
|
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 39 of file VwEnvironment.h.
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="", 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) |
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) |
virtual bool | update_parameter_hash () |
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0) |
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 |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual TParameter * | migrate (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) |
CVwEnvironment | ( | ) |
Default constructor Should initialize with reasonable default values
Definition at line 19 of file VwEnvironment.cpp.
|
virtual |
Destructor
Definition at line 51 of file VwEnvironment.h.
|
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.
dict | dictionary of parameters to be built. |
Definition at line 1156 of file SGObject.cpp.
|
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.
Definition at line 1273 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 126 of file SGObject.h.
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.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
Definition at line 1177 of file SGObject.cpp.
|
inherited |
|
inherited |
|
inherited |
vw_size_t get_mask | ( | ) |
float64_t get_max_label | ( | ) |
float64_t get_min_label | ( | ) |
|
inherited |
Definition at line 1060 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1084 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1097 of file SGObject.cpp.
|
virtual |
Return the name of the object
Implements CSGObject.
Definition at line 114 of file VwEnvironment.h.
vw_size_t get_num_bits | ( | ) |
Return number of bits used for weight vector
Definition at line 63 of file VwEnvironment.h.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 228 of file SGObject.cpp.
vw_size_t length | ( | ) |
Return length of weight vector
Definition at line 99 of file VwEnvironment.h.
|
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)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 633 of file SGObject.cpp.
|
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
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 |
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
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) |
Definition at line 305 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CWeightedDegreePositionStringKernel, CKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 989 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 984 of file SGObject.cpp.
|
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
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 671 of file SGObject.cpp.
|
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
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 878 of file SGObject.cpp.
vw_size_t num_threads | ( | ) |
Return number of threads used for learning
Definition at line 93 of file VwEnvironment.h.
|
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)
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 818 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1036 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 240 of file SGObject.cpp.
|
virtualinherited |
Save this object to file.
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) |
Definition at line 246 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 999 of file SGObject.cpp.
|
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.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 994 of file SGObject.cpp.
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 180 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 215 of file SGObject.cpp.
void set_mask | ( | vw_size_t | m | ) |
Set mask used while accessing features
m | mask |
Definition at line 69 of file VwEnvironment.h.
void set_num_bits | ( | vw_size_t | bits | ) |
Set number of bits used for the weight vector
bits | number of bits |
Definition at line 57 of file VwEnvironment.h.
void set_stride | ( | vw_size_t | new_stride | ) |
Set a new stride value. Also changes thread_mask.
new_stride | new value of stride |
Definition at line 69 of file VwEnvironment.cpp.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 117 of file SGObject.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 235 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 187 of file SGObject.cpp.
bool adaptive |
Whether adaptive learning is used.
Definition at line 145 of file VwEnvironment.h.
float32_t eta |
Learning rate.
Definition at line 140 of file VwEnvironment.h.
float32_t eta_decay_rate |
Decay rate of eta per pass.
Definition at line 142 of file VwEnvironment.h.
bool exact_adaptive_norm |
Whether exact norm is used for adaptive learning.
Definition at line 147 of file VwEnvironment.h.
int64_t example_number |
Example number.
Definition at line 167 of file VwEnvironment.h.
bool ignore[256] |
Which namespaces to ignore.
Definition at line 191 of file VwEnvironment.h.
bool ignore_some |
Whether some namespaces are ignored.
Definition at line 189 of file VwEnvironment.h.
float64_t initial_t |
Initial value of t.
Definition at line 162 of file VwEnvironment.h.
float32_t initial_weight |
Initial value of all elements in weight vector.
Definition at line 154 of file VwEnvironment.h.
|
inherited |
io
Definition at line 473 of file SGObject.h.
float32_t l1_regularization |
Level of L1 regularization.
Definition at line 149 of file VwEnvironment.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 488 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 494 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 485 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 491 of file SGObject.h.
|
inherited |
parameters
Definition at line 482 of file SGObject.h.
vw_size_t mask |
Mask used for hashing.
Definition at line 128 of file VwEnvironment.h.
float64_t max_label |
Largest label seen.
Definition at line 137 of file VwEnvironment.h.
float64_t min_label |
Smallest label seen.
Definition at line 135 of file VwEnvironment.h.
vw_size_t ngram |
ngrams to generate
Definition at line 184 of file VwEnvironment.h.
vw_size_t num_bits |
log_2 of the number of features
Definition at line 124 of file VwEnvironment.h.
vw_size_t num_passes |
Number of passes.
Definition at line 181 of file VwEnvironment.h.
DynArray<char*> pairs |
Pairs of features to cross for quadratic updates.
Definition at line 194 of file VwEnvironment.h.
|
inherited |
parallel
Definition at line 476 of file SGObject.h.
vw_size_t passes_complete |
Number of passes complete.
Definition at line 179 of file VwEnvironment.h.
float32_t power_t |
t power value while updating
Definition at line 164 of file VwEnvironment.h.
bool random_weights |
Whether to use random weights.
Definition at line 152 of file VwEnvironment.h.
vw_size_t skips |
Skips in ngrams.
Definition at line 186 of file VwEnvironment.h.
vw_size_t stride |
Number of elements in weight vector per feature.
Definition at line 132 of file VwEnvironment.h.
float64_t sum_loss |
Sum of losses.
Definition at line 177 of file VwEnvironment.h.
Value of t.
Definition at line 160 of file VwEnvironment.h.
vw_size_t thread_bits |
log_2 of the number of threads
Definition at line 126 of file VwEnvironment.h.
vw_size_t thread_mask |
Mask used by regressor for learning.
Definition at line 130 of file VwEnvironment.h.
vw_size_t total_features |
Total number of features.
Definition at line 175 of file VwEnvironment.h.
float32_t update_sum |
Sum of updates.
Definition at line 157 of file VwEnvironment.h.
vw_size_t v_length |
Length of version string.
Definition at line 199 of file VwEnvironment.h.
|
inherited |
version
Definition at line 479 of file SGObject.h.
const char* vw_version |
VW version.
Definition at line 197 of file VwEnvironment.h.
float64_t weighted_examples |
Weighted examples.
Definition at line 169 of file VwEnvironment.h.
float64_t weighted_labels |
Weighted labels.
Definition at line 173 of file VwEnvironment.h.
float64_t weighted_unlabeled_examples |
Weighted unlabelled examples.
Definition at line 171 of file VwEnvironment.h.