SHOGUN
4.0.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.
在文件 VwEnvironment.h 第 41 行定义.
Public 成员函数 | |
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 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 属性 | |
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. 更多... | |
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 成员函数 | |
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
在文件 VwEnvironment.cpp 第 19 行定义.
|
virtual |
Destructor
在文件 VwEnvironment.h 第 53 行定义.
|
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. |
在文件 SGObject.cpp 第 1243 行定义.
|
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.
在文件 SGObject.cpp 第 1360 行定义.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 200 行定义.
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) |
tolerant | allows linient check on float equality (within accuracy) |
在文件 SGObject.cpp 第 1264 行定义.
|
inherited |
|
inherited |
|
inherited |
vw_size_t get_mask | ( | ) |
float64_t get_max_label | ( | ) |
float64_t get_min_label | ( | ) |
|
inherited |
在文件 SGObject.cpp 第 1135 行定义.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
在文件 SGObject.cpp 第 1159 行定义.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
在文件 SGObject.cpp 第 1172 行定义.
|
virtual |
vw_size_t get_num_bits | ( | ) |
|
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 |
在文件 SGObject.cpp 第 297 行定义.
vw_size_t length | ( | ) |
|
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 |
在文件 SGObject.cpp 第 704 行定义.
|
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 |
在文件 SGObject.cpp 第 545 行定义.
|
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) |
在文件 SGObject.cpp 第 374 行定义.
|
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 occurs. |
被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.
在文件 SGObject.cpp 第 1062 行定义.
|
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 occurs. |
被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 1057 行定义.
|
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 |
在文件 SGObject.cpp 第 742 行定义.
|
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 |
在文件 SGObject.cpp 第 949 行定义.
vw_size_t num_threads | ( | ) |
|
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 |
在文件 SGObject.cpp 第 889 行定义.
|
virtualinherited |
在文件 SGObject.cpp 第 263 行定义.
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 1111 行定义.
|
virtualinherited |
|
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) |
在文件 SGObject.cpp 第 315 行定义.
|
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 occurs. |
被 CKernel 重载.
在文件 SGObject.cpp 第 1072 行定义.
|
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 occurs. |
被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 1067 行定义.
|
inherited |
在文件 SGObject.cpp 第 42 行定义.
|
inherited |
在文件 SGObject.cpp 第 47 行定义.
|
inherited |
在文件 SGObject.cpp 第 52 行定义.
|
inherited |
在文件 SGObject.cpp 第 57 行定义.
|
inherited |
在文件 SGObject.cpp 第 62 行定义.
|
inherited |
在文件 SGObject.cpp 第 67 行定义.
|
inherited |
在文件 SGObject.cpp 第 72 行定义.
|
inherited |
在文件 SGObject.cpp 第 77 行定义.
|
inherited |
在文件 SGObject.cpp 第 82 行定义.
|
inherited |
在文件 SGObject.cpp 第 87 行定义.
|
inherited |
在文件 SGObject.cpp 第 92 行定义.
|
inherited |
在文件 SGObject.cpp 第 97 行定义.
|
inherited |
在文件 SGObject.cpp 第 102 行定义.
|
inherited |
在文件 SGObject.cpp 第 107 行定义.
|
inherited |
在文件 SGObject.cpp 第 112 行定义.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
|
inherited |
void set_mask | ( | vw_size_t | m | ) |
void set_num_bits | ( | vw_size_t | bits | ) |
void set_stride | ( | vw_size_t | new_stride | ) |
Set a new stride value. Also changes thread_mask.
new_stride | new value of stride |
在文件 VwEnvironment.cpp 第 69 行定义.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
被 CGaussianKernel 重载.
在文件 SGObject.cpp 第 194 行定义.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 304 行定义.
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 250 行定义.
bool adaptive |
Whether adaptive learning is used.
在文件 VwEnvironment.h 第 147 行定义.
float32_t eta |
Learning rate.
在文件 VwEnvironment.h 第 142 行定义.
float32_t eta_decay_rate |
Decay rate of eta per pass.
在文件 VwEnvironment.h 第 144 行定义.
bool exact_adaptive_norm |
Whether exact norm is used for adaptive learning.
在文件 VwEnvironment.h 第 149 行定义.
int64_t example_number |
Example number.
在文件 VwEnvironment.h 第 169 行定义.
bool ignore[256] |
Which namespaces to ignore.
在文件 VwEnvironment.h 第 193 行定义.
bool ignore_some |
Whether some namespaces are ignored.
在文件 VwEnvironment.h 第 191 行定义.
float64_t initial_t |
Initial value of t.
在文件 VwEnvironment.h 第 164 行定义.
float32_t initial_weight |
Initial value of all elements in weight vector.
在文件 VwEnvironment.h 第 156 行定义.
|
inherited |
io
在文件 SGObject.h 第 496 行定义.
float32_t l1_regularization |
Level of L1 regularization.
在文件 VwEnvironment.h 第 151 行定义.
|
inherited |
parameters wrt which we can compute gradients
在文件 SGObject.h 第 511 行定义.
|
inherited |
Hash of parameter values
在文件 SGObject.h 第 517 行定义.
|
inherited |
model selection parameters
在文件 SGObject.h 第 508 行定义.
|
inherited |
map for different parameter versions
在文件 SGObject.h 第 514 行定义.
|
inherited |
parameters
在文件 SGObject.h 第 505 行定义.
vw_size_t mask |
Mask used for hashing.
在文件 VwEnvironment.h 第 130 行定义.
float64_t max_label |
Largest label seen.
在文件 VwEnvironment.h 第 139 行定义.
float64_t min_label |
Smallest label seen.
在文件 VwEnvironment.h 第 137 行定义.
vw_size_t ngram |
ngrams to generate
在文件 VwEnvironment.h 第 186 行定义.
vw_size_t num_bits |
log_2 of the number of features
在文件 VwEnvironment.h 第 126 行定义.
vw_size_t num_passes |
Number of passes.
在文件 VwEnvironment.h 第 183 行定义.
DynArray<char*> pairs |
Pairs of features to cross for quadratic updates.
在文件 VwEnvironment.h 第 196 行定义.
|
inherited |
parallel
在文件 SGObject.h 第 499 行定义.
vw_size_t passes_complete |
Number of passes complete.
在文件 VwEnvironment.h 第 181 行定义.
float32_t power_t |
t power value while updating
在文件 VwEnvironment.h 第 166 行定义.
bool random_weights |
Whether to use random weights.
在文件 VwEnvironment.h 第 154 行定义.
vw_size_t skips |
Skips in ngrams.
在文件 VwEnvironment.h 第 188 行定义.
vw_size_t stride |
Number of elements in weight vector per feature.
在文件 VwEnvironment.h 第 134 行定义.
float64_t sum_loss |
Sum of losses.
在文件 VwEnvironment.h 第 179 行定义.
Value of t.
在文件 VwEnvironment.h 第 162 行定义.
vw_size_t thread_bits |
log_2 of the number of threads
在文件 VwEnvironment.h 第 128 行定义.
vw_size_t thread_mask |
Mask used by regressor for learning.
在文件 VwEnvironment.h 第 132 行定义.
vw_size_t total_features |
Total number of features.
在文件 VwEnvironment.h 第 177 行定义.
float32_t update_sum |
Sum of updates.
在文件 VwEnvironment.h 第 159 行定义.
vw_size_t v_length |
Length of version string.
在文件 VwEnvironment.h 第 201 行定义.
|
inherited |
version
在文件 SGObject.h 第 502 行定义.
const char* vw_version |
VW version.
在文件 VwEnvironment.h 第 199 行定义.
float64_t weighted_examples |
Weighted examples.
在文件 VwEnvironment.h 第 171 行定义.
float64_t weighted_labels |
Weighted labels.
在文件 VwEnvironment.h 第 175 行定义.
float64_t weighted_unlabeled_examples |
Weighted unlabelled examples.
在文件 VwEnvironment.h 第 173 行定义.