SHOGUN  4.1.0
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CDeepAutoencoder类 参考

详细描述

Represents a muti-layer autoencoder.

A deep autoencoder consists of an input layer, multiple encoding layers, and multiple decoding layers. It can be pre-trained as a stack of single layer autoencoders. Fine-tuning can performed on the entire autoencoder in an unsupervised manner using train(), or in a supervised manner using convert_to_neural_network().

This class supports training normal deep autoencoders and denoising autoencoders [Vincent, 2008]. To use denoising autoencoders set noise_type and noise_parameter to specify the type and strength of the noise (pt_noise_type and pt_noise_parameter for pre-training).

NOTE: LBFGS does not work properly with denoising autoencoders due to their stochastic nature. Use gradient descent instead.

Deep contractive autoencoders [Rifai, 2011] are also supported. To use them, call set_contraction_coefficient() (or use pt_contraction_coefficient for pre-training). Denoising can also be used with contractive autoencoders through noise_type and noise_parameter.

Deep convolutional autoencoders [J Masci, 2011] are also supported. Simply build the autoencoder using CNeuralConvolutionalLayer objects.

NOTE: Contractive convolutional autoencoders are not supported.

If the autoencoder has N layers, encoding layers will be the layers following the input layer up to and including layer (N-1)/2. The rest of the layers are called the decoding layers. Note that the number of encoding layers is the same as the number of decoding layers.

The layers of the autoencoder must be symmetric in the number of neurons about the last encoding layer, that is, layer i must have the same number of neurons as layer N-i-1. For example, a valid structure could be something like: 500->250->100->250->500.

When finetuning the autoencoder in a unsupervised manner, denoising and contraction can also be used through set_contraction_coefficient() and noise_type and noise_parameter. See CAutoencoder for more details.

在文件 DeepAutoencoder.h87 行定义.

类 CDeepAutoencoder 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CDeepAutoencoder ()
 
 CDeepAutoencoder (CDynamicObjectArray *layers, float64_t sigma=0.01)
 
virtual ~CDeepAutoencoder ()
 
virtual void pre_train (CFeatures *data)
 
virtual CDenseFeatures
< float64_t > * 
transform (CDenseFeatures< float64_t > *data)
 
virtual CDenseFeatures
< float64_t > * 
reconstruct (CDenseFeatures< float64_t > *data)
 
virtual CNeuralNetworkconvert_to_neural_network (CNeuralLayer *output_layer=NULL, float64_t sigma=0.01)
 
virtual void set_contraction_coefficient (float64_t coeff)
 
virtual const char * get_name () const
 
virtual bool train (CFeatures *data)
 
virtual void set_layers (CDynamicObjectArray *layers)
 
virtual void connect (int32_t i, int32_t j)
 
virtual void quick_connect ()
 
virtual void disconnect (int32_t i, int32_t j)
 
virtual void disconnect_all ()
 
virtual void initialize_neural_network (float64_t sigma=0.01f)
 
virtual CBinaryLabelsapply_binary (CFeatures *data)
 
virtual CRegressionLabelsapply_regression (CFeatures *data)
 
virtual CMulticlassLabelsapply_multiclass (CFeatures *data)
 
virtual void set_labels (CLabels *lab)
 
virtual EMachineType get_classifier_type ()
 
virtual EProblemType get_machine_problem_type () const
 
virtual float64_t check_gradients (float64_t approx_epsilon=1.0e-3, float64_t s=1.0e-9)
 
SGVector< float64_t > * get_layer_parameters (int32_t i)
 
int32_t get_num_parameters ()
 
SGVector< float64_tget_parameters ()
 
int32_t get_num_inputs ()
 
int32_t get_num_outputs ()
 
CDynamicObjectArrayget_layers ()
 
virtual CLabelsapply (CFeatures *data=NULL)
 
virtual CStructuredLabelsapply_structured (CFeatures *data=NULL)
 
virtual CLatentLabelsapply_latent (CFeatures *data=NULL)
 
virtual CLabelsget_labels ()
 
void set_max_train_time (float64_t t)
 
float64_t get_max_train_time ()
 
void set_solver_type (ESolverType st)
 
ESolverType get_solver_type ()
 
virtual void set_store_model_features (bool store_model)
 
virtual bool train_locked (SGVector< index_t > indices)
 
virtual float64_t apply_one (int32_t i)
 
virtual CLabelsapply_locked (SGVector< index_t > indices)
 
virtual CBinaryLabelsapply_locked_binary (SGVector< index_t > indices)
 
virtual CRegressionLabelsapply_locked_regression (SGVector< index_t > indices)
 
virtual CMulticlassLabelsapply_locked_multiclass (SGVector< index_t > indices)
 
virtual CStructuredLabelsapply_locked_structured (SGVector< index_t > indices)
 
virtual CLatentLabelsapply_locked_latent (SGVector< index_t > indices)
 
virtual void data_lock (CLabels *labs, CFeatures *features)
 
virtual void post_lock (CLabels *labs, CFeatures *features)
 
virtual void data_unlock ()
 
virtual bool supports_locking () const
 
bool is_data_locked () const
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
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 属性

SGVector< int32_t > pt_noise_type
 
SGVector< float64_tpt_noise_parameter
 
SGVector< float64_tpt_contraction_coefficient
 
SGVector< int32_t > pt_optimization_method
 
SGVector< float64_tpt_l2_coefficient
 
SGVector< float64_tpt_l1_coefficient
 
SGVector< float64_tpt_epsilon
 
SGVector< int32_t > pt_max_num_epochs
 
SGVector< int32_t > pt_gd_mini_batch_size
 
SGVector< float64_tpt_gd_learning_rate
 
SGVector< float64_tpt_gd_learning_rate_decay
 
SGVector< float64_tpt_gd_momentum
 
SGVector< float64_tpt_gd_error_damping_coeff
 
EAENoiseType noise_type
 
float64_t noise_parameter
 
ENNOptimizationMethod optimization_method
 
float64_t l2_coefficient
 
float64_t l1_coefficient
 
float64_t dropout_hidden
 
float64_t dropout_input
 
float64_t max_norm
 
float64_t epsilon
 
int32_t max_num_epochs
 
int32_t gd_mini_batch_size
 
float64_t gd_learning_rate
 
float64_t gd_learning_rate_decay
 
float64_t gd_momentum
 
float64_t gd_error_damping_coeff
 
SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

virtual float64_t compute_error (SGMatrix< float64_t > targets)
 
virtual float64_t compute_error (SGMatrix< float64_t > inputs, SGMatrix< float64_t > targets)
 
virtual bool train_machine (CFeatures *data=NULL)
 
virtual bool train_gradient_descent (SGMatrix< float64_t > inputs, SGMatrix< float64_t > targets)
 
virtual bool train_lbfgs (SGMatrix< float64_t > inputs, SGMatrix< float64_t > targets)
 
virtual SGMatrix< float64_tforward_propagate (CFeatures *data, int32_t j=-1)
 
virtual SGMatrix< float64_tforward_propagate (SGMatrix< float64_t > inputs, int32_t j=-1)
 
virtual void set_batch_size (int32_t batch_size)
 
virtual float64_t compute_gradients (SGMatrix< float64_t > inputs, SGMatrix< float64_t > targets, SGVector< float64_t > gradients)
 
virtual bool is_label_valid (CLabels *lab) const
 
CNeuralLayerget_layer (int32_t i)
 
SGMatrix< float64_tfeatures_to_matrix (CFeatures *features)
 
SGMatrix< float64_tlabels_to_matrix (CLabels *labs)
 
virtual void store_model_features ()
 
virtual bool train_require_labels () const
 
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)
 

Protected 属性

float64_t m_sigma
 
float64_t m_contraction_coefficient
 
int32_t m_num_inputs
 
int32_t m_num_layers
 
CDynamicObjectArraym_layers
 
SGMatrix< bool > m_adj_matrix
 
int32_t m_total_num_parameters
 
SGVector< float64_tm_params
 
SGVector< bool > m_param_regularizable
 
SGVector< int32_t > m_index_offsets
 
int32_t m_batch_size
 
bool m_is_training
 
float64_t m_max_train_time
 
CLabelsm_labels
 
ESolverType m_solver_type
 
bool m_store_model_features
 
bool m_data_locked
 

构造及析构函数说明

default constructor

在文件 DeepAutoencoder.cpp47 行定义.

CDeepAutoencoder ( CDynamicObjectArray layers,
float64_t  sigma = 0.01 
)

Constructs and initializes an autoencoder

参数
layersAn array of CNeuralLayer objects specifying the layers of the autoencoder
sigmaStandard deviation of the gaussian used to initialize the weights

在文件 DeepAutoencoder.cpp52 行定义.

virtual ~CDeepAutoencoder ( )
virtual

在文件 DeepAutoencoder.h102 行定义.

成员函数说明

CLabels * apply ( CFeatures data = NULL)
virtualinherited

apply machine to data if data is not specified apply to the current features

参数
data(test)data to be classified
返回
classified labels

在文件 Machine.cpp152 行定义.

CBinaryLabels * apply_binary ( CFeatures data)
virtualinherited

apply machine to data in means of binary classification problem

重载 CMachine .

在文件 NeuralNetwork.cpp158 行定义.

CLatentLabels * apply_latent ( CFeatures data = NULL)
virtualinherited

apply machine to data in means of latent problem

CLinearLatentMachine 重载.

在文件 Machine.cpp232 行定义.

CLabels * apply_locked ( SGVector< index_t indices)
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked

参数
indicesindex vector (of locked features) that is predicted

在文件 Machine.cpp187 行定义.

CBinaryLabels * apply_locked_binary ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for binary problems

CKernelMachine , 以及 CMultitaskLinearMachine 重载.

在文件 Machine.cpp238 行定义.

CLatentLabels * apply_locked_latent ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for latent problems

在文件 Machine.cpp266 行定义.

CMulticlassLabels * apply_locked_multiclass ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for multiclass problems

在文件 Machine.cpp252 行定义.

CRegressionLabels * apply_locked_regression ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for regression problems

CKernelMachine 重载.

在文件 Machine.cpp245 行定义.

CStructuredLabels * apply_locked_structured ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for structured problems

在文件 Machine.cpp259 行定义.

CMulticlassLabels * apply_multiclass ( CFeatures data)
virtualinherited

apply machine to data in means of multiclass classification problem

重载 CMachine .

在文件 NeuralNetwork.cpp199 行定义.

virtual float64_t apply_one ( int32_t  i)
virtualinherited
CRegressionLabels * apply_regression ( CFeatures data)
virtualinherited

apply machine to data in means of regression problem

重载 CMachine .

在文件 NeuralNetwork.cpp187 行定义.

CStructuredLabels * apply_structured ( CFeatures data = NULL)
virtualinherited

apply machine to data in means of SO classification problem

CLinearStructuredOutputMachine 重载.

在文件 Machine.cpp226 行定义.

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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp597 行定义.

float64_t check_gradients ( float64_t  approx_epsilon = 1.0e-3,
float64_t  s = 1.0e-9 
)
virtualinherited

Checks if the gradients computed using backpropagation are correct by comparing them with gradients computed using numerical approximation. Used for testing purposes only.

Gradients are numerically approximated according to:

\[ c = max(\epsilon x, s) \]

\[ f'(x) = \frac{f(x + c)-f(x - c)}{2c} \]

参数
approx_epsilonConstant used during gradient approximation
sSome small value, used to prevent division by zero
返回
Average difference between numerical gradients and backpropagation gradients

在文件 NeuralNetwork.cpp554 行定义.

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.

返回
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

在文件 SGObject.cpp714 行定义.

float64_t compute_error ( SGMatrix< float64_t targets)
protectedvirtual

Computes the error between the output layer's activations and the given target activations.

参数
targetsdesired values for the network's output, matrix of size num_neurons_output_layer*batch_size

重载 CAutoencoder .

在文件 DeepAutoencoder.cpp201 行定义.

float64_t compute_error ( SGMatrix< float64_t inputs,
SGMatrix< float64_t targets 
)
protectedvirtualinherited

Forward propagates the inputs and computes the error between the output layer's activations and the given target activations.

参数
inputsinputs to the network, a matrix of size m_num_inputs*m_batch_size
targetsdesired values for the network's output, matrix of size num_neurons_output_layer*batch_size

在文件 NeuralNetwork.cpp546 行定义.

float64_t compute_gradients ( SGMatrix< float64_t inputs,
SGMatrix< float64_t targets,
SGVector< float64_t gradients 
)
protectedvirtualinherited

Applies backpropagation to compute the gradients of the error with repsect to every parameter in the network.

参数
inputsinputs to the network, a matrix of size m_num_inputs*m_batch_size
targetsdesired values for the output layer's activations. matrix of size m_layers[m_num_layers-1].get_num_neurons()*m_batch_size
gradientsarray to be filled with gradient values.
返回
error between the targets and the activations of the last layer

在文件 NeuralNetwork.cpp467 行定义.

void connect ( int32_t  i,
int32_t  j 
)
virtualinherited

Connects layer i as input to layer j. In order for forward and backpropagation to work correctly, i must be less that j

在文件 NeuralNetwork.cpp75 行定义.

CNeuralNetwork * convert_to_neural_network ( CNeuralLayer output_layer = NULL,
float64_t  sigma = 0.01 
)
virtual

Converts the autoencoder into a neural network for supervised finetuning.

The neural network is formed using the input layer and the encoding layers. If specified, another output layer will added on top of those layers

参数
output_layerIf specified, this layer will be added on top of the last encoding layer
sigmaStandard deviation used to initialize the parameters of the output layer

在文件 DeepAutoencoder.cpp171 行定义.

void data_lock ( CLabels labs,
CFeatures features 
)
virtualinherited

Locks the machine on given labels and data. After this call, only train_locked and apply_locked may be called

Only possible if supports_locking() returns true

参数
labslabels used for locking
featuresfeatures used for locking

CKernelMachine 重载.

在文件 Machine.cpp112 行定义.

void data_unlock ( )
virtualinherited

Unlocks a locked machine and restores previous state

CKernelMachine 重载.

在文件 Machine.cpp143 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp198 行定义.

void disconnect ( int32_t  i,
int32_t  j 
)
virtualinherited

Disconnects layer i from layer j

在文件 NeuralNetwork.cpp88 行定义.

void disconnect_all ( )
virtualinherited

Removes all connections in the network

在文件 NeuralNetwork.cpp93 行定义.

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp618 行定义.

SGMatrix< float64_t > features_to_matrix ( CFeatures features)
protectedinherited

Ensures the given features are suitable for use with the network and returns their feature matrix

在文件 NeuralNetwork.cpp614 行定义.

SGMatrix< float64_t > forward_propagate ( CFeatures data,
int32_t  j = -1 
)
protectedvirtualinherited

Applies forward propagation, computes the activations of each layer up to layer j

参数
datainput features
jlayer index at which the propagation should stop. If -1, the propagation continues up to the last layer
返回
activations of the last layer

在文件 NeuralNetwork.cpp439 行定义.

SGMatrix< float64_t > forward_propagate ( SGMatrix< float64_t inputs,
int32_t  j = -1 
)
protectedvirtualinherited

Applies forward propagation, computes the activations of each layer up to layer j

参数
inputsinputs to the network, a matrix of size m_num_inputs*m_batch_size
jlayer index at which the propagation should stop. If -1, the propagation continues up to the last layer
返回
activations of the last layer

在文件 NeuralNetwork.cpp446 行定义.

virtual EMachineType get_classifier_type ( )
virtualinherited

get classifier type

返回
classifier type CT_NEURALNETWORK

重载 CMachine .

在文件 NeuralNetwork.h188 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp290 行定义.

CLabels * get_labels ( )
virtualinherited

get labels

返回
labels

在文件 Machine.cpp76 行定义.

CNeuralLayer * get_layer ( int32_t  i)
protectedinherited

returns a pointer to layer i in the network

在文件 NeuralNetwork.cpp723 行定义.

SGVector< float64_t > * get_layer_parameters ( int32_t  i)
inherited

returns a copy of a layer's parameters array

参数
iindex of the layer

在文件 NeuralNetwork.cpp712 行定义.

CDynamicObjectArray * get_layers ( )
inherited

Returns an array holding the network's layers

在文件 NeuralNetwork.cpp744 行定义.

EProblemType get_machine_problem_type ( ) const
virtualinherited

returns type of problem machine solves

重载 CMachine .

在文件 NeuralNetwork.cpp675 行定义.

float64_t get_max_train_time ( )
inherited

get maximum training time

返回
maximum training time

在文件 Machine.cpp87 行定义.

SGStringList< char > get_modelsel_names ( )
inherited
返回
vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp498 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp522 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp535 行定义.

virtual const char* get_name ( ) const
virtual

Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.

返回
name of the SGSerializable

重载 CAutoencoder .

在文件 DeepAutoencoder.h172 行定义.

int32_t get_num_inputs ( )
inherited

returns the number of inputs the network takes

在文件 NeuralNetwork.h224 行定义.

int32_t get_num_outputs ( )
inherited

returns the number of neurons in the output layer

在文件 NeuralNetwork.cpp739 行定义.

int32_t get_num_parameters ( )
inherited

returns the totat number of parameters in the network

在文件 NeuralNetwork.h218 行定义.

SGVector<float64_t> get_parameters ( )
inherited

return the network's parameter array

在文件 NeuralNetwork.h221 行定义.

ESolverType get_solver_type ( )
inherited

get solver type

返回
solver

在文件 Machine.cpp102 行定义.

void initialize_neural_network ( float64_t  sigma = 0.01f)
virtualinherited

Initializes the network

参数
sigmastandard deviation of the gaussian used to randomly initialize the parameters

在文件 NeuralNetwork.cpp98 行定义.

bool is_data_locked ( ) const
inherited
返回
whether this machine is locked

在文件 Machine.h296 行定义.

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.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp296 行定义.

bool is_label_valid ( CLabels lab) const
protectedvirtualinherited

check whether the labels is valid.

Subclasses can override this to implement their check of label types.

参数
labthe labels being checked, guaranteed to be non-NULL

重载 CMachine .

在文件 NeuralNetwork.cpp689 行定义.

SGMatrix< float64_t > labels_to_matrix ( CLabels labs)
protectedinherited

converts the given labels into a matrix suitable for use with network

返回
matrix of size get_num_outputs()*num_labels

在文件 NeuralNetwork.cpp630 行定义.

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!

参数
filewhere to load from
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp369 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp426 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp421 行定义.

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

在文件 SGObject.cpp262 行定义.

virtual void post_lock ( CLabels labs,
CFeatures features 
)
virtualinherited

post lock

CMultitaskLinearMachine 重载.

在文件 Machine.h287 行定义.

void pre_train ( CFeatures data)
virtual

Pre-trains the deep autoencoder as a stack of autoencoders

If the deep autoencoder has N layers, it is treated as a stack of (N-1)/2 single layer autoencoders. For all \( 1<i<(N-1)/2 \) an autoencoder is formed using layer i-1 as an input layer, layer i as encoding layer, and layer N-i as decoding layer.

For example, if the deep autoencoder has layers L0->L1->L2->L3->L4, two autoencoders will be formed: L0->L1->L4 and L1->L2->L3.

Training parameters for each autoencoder can be set using the pt_* public fields, i.e pt_optimization_method and pt_contraction_coefficient. Each of those fields is a vector of length (N-1)/2, where the first element sets the parameter for the first autoencoder, the second element set the parameter for the second autoencoder and so on. When required, the parameter can be set for all autoencoders using the SGVector::set_const() method.

参数
dataTraining examples

在文件 DeepAutoencoder.cpp80 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp308 行定义.

void quick_connect ( )
virtualinherited

Connects each layer to the layer after it. That is, connects layer i to as input to layer i+1 for all i.

在文件 NeuralNetwork.cpp81 行定义.

CDenseFeatures< float64_t > * reconstruct ( CDenseFeatures< float64_t > *  data)
virtual

Forward propagates the data through the autoencoder and returns the activations of the last layer

参数
dataInput features
返回
Reconstructed features

重载 CAutoencoder .

在文件 DeepAutoencoder.cpp164 行定义.

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

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp314 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel 重载.

在文件 SGObject.cpp436 行定义.

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.

异常
ShogunExceptionwill be thrown if an error occurs.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp431 行定义.

void set_batch_size ( int32_t  batch_size)
protectedvirtualinherited

Sets the batch size (the number of train/test cases) the network is expected to deal with. Allocates memory for the activations, local gradients, input gradients if necessary (if the batch size is different from it's previous value)

参数
batch_sizenumber of train/test cases the network is expected to deal with.

在文件 NeuralNetwork.cpp604 行定义.

void set_contraction_coefficient ( float64_t  coeff)
virtual

Sets the contraction coefficient

For contractive autoencoders [Rifai, 2011], a term:

\[ \frac{\lambda}{N} \sum_{k=0}^{N-1} \left \| J(x_k) \right \|^2_F \]

is added to the error, where \( \left \| J(x_k)) \right \|^2_F \) is the Frobenius norm of the Jacobian of the activations of the each encoding layer with respect to its inputs, \( N \) is the batch size, and \( \lambda \) is the contraction coefficient.

参数
coeffContraction coefficient

重载 CAutoencoder .

在文件 DeepAutoencoder.cpp214 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp228 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp241 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp283 行定义.

void set_labels ( CLabels lab)
virtualinherited

set labels

参数
lablabels

重载 CMachine .

在文件 NeuralNetwork.cpp696 行定义.

void set_layers ( CDynamicObjectArray layers)
virtualinherited

Sets the layers of the network

参数
layersAn array of CNeuralLayer objects specifying the layers of the network. Must contain at least one input layer. The last layer in the array is treated as the output layer

在文件 NeuralNetwork.cpp55 行定义.

void set_max_train_time ( float64_t  t)
inherited

set maximum training time

参数
tmaximimum training time

在文件 Machine.cpp82 行定义.

void set_solver_type ( ESolverType  st)
inherited

set solver type

参数
stsolver type

在文件 Machine.cpp97 行定义.

void set_store_model_features ( bool  store_model)
virtualinherited

Setter for store-model-features-after-training flag

参数
store_modelwhether model should be stored after training

在文件 Machine.cpp107 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

CGaussianKernel 重载.

在文件 SGObject.cpp192 行定义.

virtual void store_model_features ( )
protectedvirtualinherited

Stores feature data of underlying model. After this method has been called, it is possible to change the machine's feature data and call apply(), which is then performed on the training feature data that is part of the machine's model.

Base method, has to be implemented in order to allow cross-validation and model selection.

NOT IMPLEMENTED! Has to be done in subclasses

CKernelMachine, CKNN, CLinearMulticlassMachine, CTreeMachine< T >, CTreeMachine< ConditionalProbabilityTreeNodeData >, CTreeMachine< RelaxedTreeNodeData >, CTreeMachine< id3TreeNodeData >, CTreeMachine< VwConditionalProbabilityTreeNodeData >, CTreeMachine< CARTreeNodeData >, CTreeMachine< C45TreeNodeData >, CTreeMachine< CHAIDTreeNodeData >, CTreeMachine< NbodyTreeNodeData >, CLinearMachine, CGaussianProcessMachine, CHierarchical, CDistanceMachine, CKernelMulticlassMachine , 以及 CLinearStructuredOutputMachine 重载.

在文件 Machine.h335 行定义.

virtual bool supports_locking ( ) const
virtualinherited
返回
whether this machine supports locking

CKernelMachine , 以及 CMultitaskLinearMachine 重载.

在文件 Machine.h293 行定义.

bool train ( CFeatures data)
virtualinherited

Trains the autoencoder

参数
dataTraining examples
返回
True if training succeeded, false otherwise

重载 CMachine .

在文件 Autoencoder.cpp96 行定义.

bool train_gradient_descent ( SGMatrix< float64_t inputs,
SGMatrix< float64_t targets 
)
protectedvirtualinherited

trains the network using gradient descent

在文件 NeuralNetwork.cpp261 行定义.

bool train_lbfgs ( SGMatrix< float64_t inputs,
SGMatrix< float64_t targets 
)
protectedvirtualinherited

trains the network using L-BFGS

在文件 NeuralNetwork.cpp357 行定义.

virtual bool train_locked ( SGVector< index_t indices)
virtualinherited

Trains a locked machine on a set of indices. Error if machine is not locked

NOT IMPLEMENTED

参数
indicesindex vector (of locked features) that is used for training
返回
whether training was successful

CKernelMachine , 以及 CMultitaskLinearMachine 重载.

在文件 Machine.h239 行定义.

bool train_machine ( CFeatures data = NULL)
protectedvirtualinherited

trains the network

重载 CMachine .

在文件 NeuralNetwork.cpp229 行定义.

virtual bool train_require_labels ( ) const
protectedvirtualinherited

returns whether machine require labels for training

COnlineLinearMachine, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree , 以及 CLibSVMOneClass 重载.

在文件 Machine.h354 行定义.

CDenseFeatures< float64_t > * transform ( CDenseFeatures< float64_t > *  data)
virtual

Forward propagates the data through the autoencoder and returns the activations of the last encoding layer (layer (N-1)/2)

参数
dataInput features
返回
Transformed features

重载 CAutoencoder .

在文件 DeepAutoencoder.cpp157 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp248 行定义.

类成员变量说明

float64_t dropout_hidden
inherited

Probabilty that a hidden layer neuron will be dropped out When using this, the recommended value is 0.5

default value 0.0 (no dropout)

For more details on dropout, see paper [Hinton, 2012]

在文件 NeuralNetwork.h375 行定义.

float64_t dropout_input
inherited

Probabilty that a input layer neuron will be dropped out When using this, a good value might be 0.2

default value 0.0 (no dropout)

For more details on dropout, see this paper [Hinton, 2012]

在文件 NeuralNetwork.h385 行定义.

float64_t epsilon
inherited

convergence criteria training stops when (E'- E)/E < epsilon where E is the error at the current iterations and E' is the error at the previous iteration default value is 1.0e-5

在文件 NeuralNetwork.h400 行定义.

float64_t gd_error_damping_coeff
inherited

Used to damp the error fluctuations when stochastic gradient descent is used. damping is done according to: error_damped(i) = c*error(i) + (1-c)*error_damped(i-1) where c is the damping coefficient

If -1, the damping coefficient is automatically computed according to: c = 0.99*gd_mini_batch_size/training_set_size + 1e-2;

default value is -1

在文件 NeuralNetwork.h444 行定义.

float64_t gd_learning_rate
inherited

gradient descent learning rate, defualt value 0.1

在文件 NeuralNetwork.h415 行定义.

float64_t gd_learning_rate_decay
inherited

gradient descent learning rate decay learning rate is updated at each iteration i according to: alpha(i)=decay*alpha(i-1) default value is 1.0 (no decay)

在文件 NeuralNetwork.h422 行定义.

int32_t gd_mini_batch_size
inherited

size of the mini-batch used during gradient descent training, if 0 full-batch training is performed default value is 0

在文件 NeuralNetwork.h412 行定义.

float64_t gd_momentum
inherited

gradient descent momentum multiplier

default value is 0.9

For more details on momentum, see this paper [Sutskever, 2013]

在文件 NeuralNetwork.h432 行定义.

SGIO* io
inherited

io

在文件 SGObject.h369 行定义.

float64_t l1_coefficient
inherited

L1 Regularization coeff, default value is 0.0

在文件 NeuralNetwork.h365 行定义.

float64_t l2_coefficient
inherited

L2 Regularization coeff, default value is 0.0

在文件 NeuralNetwork.h362 行定义.

SGMatrix<bool> m_adj_matrix
protectedinherited

Describes the connections in the network: if there's a connection from layer i to layer j then m_adj_matrix(i,j) = 1.

在文件 NeuralNetwork.h458 行定义.

int32_t m_batch_size
protectedinherited

number of train/test cases the network is expected to deal with. Default value is 1

在文件 NeuralNetwork.h480 行定义.

float64_t m_contraction_coefficient
protectedinherited

For contractive autoencoders [Rifai, 2011], a term:

\[ \frac{\lambda}{N} \sum_{k=0}^{N-1} \left \| J(x_k) \right \|^2_F \]

is added to the error, where \( \left \| J(x_k)) \right \|^2_F \) is the Frobenius norm of the Jacobian of the activations of the hidden layer with respect to its inputs, \( N \) is the batch size, and \( \lambda \) is the contraction coefficient.

Default value is 0.0.

在文件 Autoencoder.h210 行定义.

bool m_data_locked
protectedinherited

whether data is locked

在文件 Machine.h370 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h387 行定义.

SGVector<int32_t> m_index_offsets
protectedinherited

offsets specifying where each layer's parameters and parameter gradients are stored, i.e layer i's parameters are stored at m_params + m_index_offsets[i]

在文件 NeuralNetwork.h475 行定义.

bool m_is_training
protectedinherited

True if the network is currently being trained initial value is false

在文件 NeuralNetwork.h485 行定义.

CLabels* m_labels
protectedinherited

labels

在文件 Machine.h361 行定义.

CDynamicObjectArray* m_layers
protectedinherited

network's layers

在文件 NeuralNetwork.h453 行定义.

float64_t m_max_train_time
protectedinherited

maximum training time

在文件 Machine.h358 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h381 行定义.

int32_t m_num_inputs
protectedinherited

number of neurons in the input layer

在文件 NeuralNetwork.h447 行定义.

int32_t m_num_layers
protectedinherited

number of layer

在文件 NeuralNetwork.h450 行定义.

SGVector<bool> m_param_regularizable
protectedinherited

Array that specifies which parameters are to be regularized. This is used to turn off regularization for bias parameters

在文件 NeuralNetwork.h469 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h378 行定义.

SGVector<float64_t> m_params
protectedinherited

array where all the parameters of the network are stored

在文件 NeuralNetwork.h464 行定义.

float64_t m_sigma
protected

Standard deviation of the gaussian used to initialize the parameters

在文件 DeepAutoencoder.h260 行定义.

ESolverType m_solver_type
protectedinherited

solver type

在文件 Machine.h364 行定义.

bool m_store_model_features
protectedinherited

whether model features should be stored after training

在文件 Machine.h367 行定义.

int32_t m_total_num_parameters
protectedinherited

total number of parameters in the network

在文件 NeuralNetwork.h461 行定义.

float64_t max_norm
inherited

Maximum allowable L2 norm for a neurons weights When using this, a good value might be 15

default value -1 (max-norm regularization disabled)

在文件 NeuralNetwork.h392 行定义.

int32_t max_num_epochs
inherited

maximum number of iterations over the training set. If 0, training will continue until convergence. defualt value is 0

在文件 NeuralNetwork.h406 行定义.

float64_t noise_parameter
inherited

Controls the strength of the noise, depending on noise_type

在文件 Autoencoder.h198 行定义.

EAENoiseType noise_type
inherited

Noise type for denoising autoencoders.

If set to AENT_DROPOUT, inputs are randomly set to zero during each iteration of training with probability noise_parameter.

If set to AENT_GAUSSIAN, gaussian noise with zero mean and noise_parameter standard deviation is added to the inputs.

Default value is AENT_NONE

在文件 Autoencoder.h195 行定义.

ENNOptimizationMethod optimization_method
inherited

Optimization method, default is NNOM_LBFGS

在文件 NeuralNetwork.h359 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h372 行定义.

SGVector<float64_t> pt_contraction_coefficient

Contraction coefficient (see CAutoencoder::set_contraction_coefficient()) for pre-training each encoding layer Default value is 0.0 for all layers

在文件 DeepAutoencoder.h205 行定义.

SGVector<float64_t> pt_epsilon

CAutoencoder::epsilon for pre-training each encoding layer Default value is 1.0e-5 for all layers

在文件 DeepAutoencoder.h225 行定义.

SGVector<float64_t> pt_gd_error_damping_coeff

CAutoencoder::gd_error_damping_coeff for pre-training each encoding layer Default value is -1 for all layers

在文件 DeepAutoencoder.h255 行定义.

SGVector<float64_t> pt_gd_learning_rate

CAutoencoder::gd_learning_rate for pre-training each encoding layer Default value is 0.1 for all layers

在文件 DeepAutoencoder.h240 行定义.

SGVector<float64_t> pt_gd_learning_rate_decay

CAutoencoder::gd_learning_rate_decay for pre-training each encoding layer Default value is 1.0 for all layers

在文件 DeepAutoencoder.h245 行定义.

SGVector<int32_t> pt_gd_mini_batch_size

CAutoencoder::gd_mini_batch_size for pre-training each encoding layer Default value is 0 for all layers

在文件 DeepAutoencoder.h235 行定义.

SGVector<float64_t> pt_gd_momentum

CAutoencoder::gd_momentum for pre-training each encoding layer Default value is 0.9 for all layers

在文件 DeepAutoencoder.h250 行定义.

SGVector<float64_t> pt_l1_coefficient

CAutoencoder::l1_coefficient for pre-training each encoding layer Default value is 0.0 for all layers

在文件 DeepAutoencoder.h220 行定义.

SGVector<float64_t> pt_l2_coefficient

CAutoencoder::l2_coefficient for pre-training each encoding layer Default value is 0.0 for all layers

在文件 DeepAutoencoder.h215 行定义.

SGVector<int32_t> pt_max_num_epochs

CAutoencoder::max_num_epochs for pre-training each encoding layer Default value is 0 for all layers

在文件 DeepAutoencoder.h230 行定义.

SGVector<float64_t> pt_noise_parameter

CAutoencoder::noise_parameter for pre-training each encoding layer Default value is 0.0 for all layers

在文件 DeepAutoencoder.h199 行定义.

SGVector<int32_t> pt_noise_type

CAutoencoder::noise_type for pre-training each encoding layer Default value is AENT_NONE for all layers

在文件 DeepAutoencoder.h194 行定义.

SGVector<int32_t> pt_optimization_method

CAutoencoder::optimization_method for pre-training each encoding layer Default value is NNOM_LBFGS for all layers

在文件 DeepAutoencoder.h210 行定义.

Version* version
inherited

version

在文件 SGObject.h375 行定义.


该类的文档由以下文件生成:

SHOGUN 机器学习工具包 - 项目文档