|
SHOGUN
4.1.0
|
KMeans clustering, partitions the data into k (a-priori specified) clusters.
It minimizes
\[ \sum_{i=1}^k\sum_{x_j\in S_i} (x_j-\mu_i)^2 \]
where \(\mu_i\) are the cluster centers and \(S_i,\;i=1,\dots,k\) are the index sets of the clusters.
Beware that this algorithm obtains only a local optimum.
The option of using mini-batch based training was added to this class. See EKMeansMethod
cf. http://en.wikipedia.org/wiki/K-means_algorithm cf. http://en.wikipedia.org/wiki/Lloyd's_algorithm
Public 属性 | |
| SGIO * | io |
| Parallel * | parallel |
| Version * | version |
| Parameter * | m_parameters |
| Parameter * | m_model_selection_parameters |
| Parameter * | m_gradient_parameters |
| uint32_t | m_hash |
Protected 成员函数 | |
| virtual bool | is_label_valid (CLabels *lab) 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 成员函数 | |
| static void * | run_distance_thread_lhs (void *p) |
| static void * | run_distance_thread_rhs (void *p) |
Protected 属性 | |
| CDistance * | distance |
| float64_t | m_max_train_time |
| CLabels * | m_labels |
| ESolverType | m_solver_type |
| bool | m_store_model_features |
| bool | m_data_locked |
| CKMeans | ( | ) |
default constructor
在文件 KMeans.cpp 第 29 行定义.
| CKMeans | ( | int32_t | k, |
| CDistance * | d, | ||
| EKMeansMethod | f | ||
| ) |
| CKMeans | ( | int32_t | k, |
| CDistance * | d, | ||
| bool | kmeanspp = false, |
||
| EKMeansMethod | f = KMM_LLOYD |
||
| ) |
constructor
| k | parameter k |
| d | distance |
| kmeanspp | true for using KMeans++ (default false) |
| f | train_method value |
在文件 KMeans.cpp 第 44 行定义.
| CKMeans | ( | int32_t | k_i, |
| CDistance * | d_i, | ||
| SGMatrix< float64_t > | centers_i, | ||
| EKMeansMethod | f = KMM_LLOYD |
||
| ) |
constructor for supplying initial centers
| k_i | parameter k |
| d_i | distance |
| centers_i | initial centers for KMeans algorithm |
| f | train_method value |
在文件 KMeans.cpp 第 54 行定义.
|
virtual |
在文件 KMeans.cpp 第 64 行定义.
apply machine to data if data is not specified apply to the current features
| data | (test)data to be classified |
在文件 Machine.cpp 第 152 行定义.
|
virtualinherited |
apply machine to data in means of binary classification problem
被 CKernelMachine, COnlineLinearMachine, CWDSVMOcas, CNeuralNetwork, CLinearMachine, CGaussianProcessClassification, CDomainAdaptationSVMLinear, CPluginEstimate , 以及 CBaggingMachine 重载.
在文件 Machine.cpp 第 208 行定义.
|
virtualinherited |
apply machine to data in means of latent problem
被 CLinearLatentMachine 重载.
在文件 Machine.cpp 第 232 行定义.
Applies a locked machine on a set of indices. Error if machine is not locked
| indices | index vector (of locked features) that is predicted |
在文件 Machine.cpp 第 187 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for binary problems
被 CKernelMachine , 以及 CMultitaskLinearMachine 重载.
在文件 Machine.cpp 第 238 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for latent problems
在文件 Machine.cpp 第 266 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for multiclass problems
在文件 Machine.cpp 第 252 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for regression problems
被 CKernelMachine 重载.
在文件 Machine.cpp 第 245 行定义.
|
virtualinherited |
applies a locked machine on a set of indices for structured problems
在文件 Machine.cpp 第 259 行定义.
|
virtualinherited |
Classify all provided features. Cluster index with smallest distance to to be classified element is returned
| data | (test)data to be classified |
重载 CMachine .
被 CKNN 重载.
在文件 DistanceMachine.cpp 第 208 行定义.
|
virtualinherited |
Apply machine to one example. Cluster index with smallest distance to to be classified element is returned
| num | which example to apply machine to |
重载 CMachine .
被 CKNN 重载.
在文件 DistanceMachine.cpp 第 234 行定义.
|
virtualinherited |
apply machine to data in means of regression problem
被 CKernelMachine, CWDSVMOcas, COnlineLinearMachine, CNeuralNetwork, CCHAIDTree, CStochasticGBMachine, CCARTree, CLinearMachine, CGaussianProcessRegression , 以及 CBaggingMachine 重载.
在文件 Machine.cpp 第 214 行定义.
|
virtualinherited |
apply machine to data in means of SO classification problem
被 CLinearStructuredOutputMachine 重载.
在文件 Machine.cpp 第 226 行定义.
|
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 第 597 行定义.
|
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 第 714 行定义.
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
| labs | labels used for locking |
| features | features used for locking |
被 CKernelMachine 重载.
在文件 Machine.cpp 第 112 行定义.
|
virtualinherited |
Unlocks a locked machine and restores previous state
被 CKernelMachine 重载.
在文件 Machine.cpp 第 143 行定义.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 198 行定义.
|
inherited |
get distance functions for lhs feature vectors going from a1 to a2 and rhs feature vector b
| result | array of distance values |
| idx_a1 | first feature vector a1 at idx_a1 |
| idx_a2 | last feature vector a2 at idx_a2 |
| idx_b | feature vector b at idx_b |
在文件 DistanceMachine.cpp 第 52 行定义.
|
inherited |
get distance functions for rhs feature vectors going from b1 to b2 and lhs feature vector a
| result | array of distance values |
| idx_b1 | first feature vector a1 at idx_b1 |
| idx_b2 | last feature vector a2 at idx_b2 |
| idx_a | feature vector a at idx_a |
在文件 DistanceMachine.cpp 第 114 行定义.
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 第 618 行定义.
|
virtual |
get centers
在文件 KMeans.cpp 第 370 行定义.
| int32_t get_dimensions | ( | ) |
|
inherited |
| bool get_fixed_centers | ( | ) |
|
inherited |
|
inherited |
|
inherited |
| int32_t get_k | ( | ) |
|
virtualinherited |
|
virtualinherited |
returns type of problem machine solves
被 CNeuralNetwork, CRandomForest, CCHAIDTree, CCARTree , 以及 CBaseMulticlassMachine 重载.
| float64_t get_max_iter | ( | ) |
|
inherited |
| int32_t get_mbKMeans_batch_size | ( | ) | const |
| int32_t get_mbKMeans_iter | ( | ) | const |
|
inherited |
在文件 SGObject.cpp 第 498 行定义.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
| param_name | name of the parameter |
在文件 SGObject.cpp 第 522 行定义.
|
inherited |
Returns index of model selection parameter with provided index
| param_name | name of model selection parameter |
在文件 SGObject.cpp 第 535 行定义.
|
virtual |
|
inherited |
| EKMeansMethod get_train_method | ( | ) | const |
| bool get_use_kmeanspp | ( | ) | const |
get use_kmeanspp attribute
在文件 KMeans.cpp 第 298 行定义.
|
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 第 296 行定义.
|
protectedvirtualinherited |
check whether the labels is valid.
Subclasses can override this to implement their check of label types.
| lab | the labels being checked, guaranteed to be non-NULL |
被 CNeuralNetwork, CCARTree, CCHAIDTree, CGaussianProcessRegression , 以及 CBaseMulticlassMachine 重载.
|
virtual |
load distance machine from file
| srcfile | file to load from |
在文件 KMeans.cpp 第 279 行定义.
|
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 |
在文件 SGObject.cpp 第 369 行定义.
|
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 第 426 行定义.
|
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 第 421 行定义.
|
virtualinherited |
在文件 SGObject.cpp 第 262 行定义.
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 474 行定义.
|
virtualinherited |
|
staticprotectedinherited |
thread function for computing distance values
| p | thread parameter |
在文件 DistanceMachine.cpp 第 176 行定义.
|
staticprotectedinherited |
thread function for computing distance values
| p | thread parameter |
在文件 DistanceMachine.cpp 第 192 行定义.
|
virtual |
save distance machine to file
| dstfile | file to save to |
在文件 KMeans.cpp 第 286 行定义.
|
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 |
在文件 SGObject.cpp 第 314 行定义.
|
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 第 436 行定义.
|
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 第 431 行定义.
|
inherited |
| void set_fixed_centers | ( | bool | fixed | ) |
|
inherited |
在文件 SGObject.cpp 第 41 行定义.
|
inherited |
在文件 SGObject.cpp 第 46 行定义.
|
inherited |
在文件 SGObject.cpp 第 51 行定义.
|
inherited |
在文件 SGObject.cpp 第 56 行定义.
|
inherited |
在文件 SGObject.cpp 第 61 行定义.
|
inherited |
在文件 SGObject.cpp 第 66 行定义.
|
inherited |
在文件 SGObject.cpp 第 71 行定义.
|
inherited |
在文件 SGObject.cpp 第 76 行定义.
|
inherited |
在文件 SGObject.cpp 第 81 行定义.
|
inherited |
在文件 SGObject.cpp 第 86 行定义.
|
inherited |
在文件 SGObject.cpp 第 91 行定义.
|
inherited |
在文件 SGObject.cpp 第 96 行定义.
|
inherited |
在文件 SGObject.cpp 第 101 行定义.
|
inherited |
在文件 SGObject.cpp 第 106 行定义.
|
inherited |
在文件 SGObject.cpp 第 111 行定义.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
|
inherited |
set the initial cluster centers
| centers | matrix with cluster centers (k colums, dim rows) |
在文件 KMeans.cpp 第 68 行定义.
| void set_k | ( | int32_t | p_k | ) |
|
virtualinherited |
set labels
| lab | labels |
被 CNeuralNetwork, CGaussianProcessMachine, CCARTree, CStructuredOutputMachine, CRelaxedTree , 以及 CMulticlassMachine 重载.
在文件 Machine.cpp 第 65 行定义.
| void set_max_iter | ( | int32_t | iter | ) |
|
inherited |
| void set_mbKMeans_batch_size | ( | int32_t | b | ) |
set batch size for mini-batch KMeans
| b | batch size int32_t(greater than 0) |
在文件 KMeans.cpp 第 335 行定义.
| void set_mbKMeans_iter | ( | int32_t | t | ) |
set no. of iterations for mini-batch KMeans
| t | no. of iterations int32_t(greater than 0) |
在文件 KMeans.cpp 第 346 行定义.
| void set_mbKMeans_params | ( | int32_t | b, |
| int32_t | t | ||
| ) |
set batch size and no. of iteration for mini-batch KMeans
| b | batch size |
| t | no. of iterations |
在文件 KMeans.cpp 第 357 行定义.
|
inherited |
|
virtualinherited |
Setter for store-model-features-after-training flag
| store_model | whether model should be stored after training |
在文件 Machine.cpp 第 107 行定义.
| void set_train_method | ( | EKMeansMethod | f | ) |
| void set_use_kmeanspp | ( | bool | kmpp | ) |
set use_kmeanspp attribute
| kmpp | true=>use KMeans++ false=>don't use KMeans++ |
在文件 KMeans.cpp 第 293 行定义.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
被 CGaussianKernel 重载.
在文件 SGObject.cpp 第 192 行定义.
|
virtualinherited |
被 CKernelMachine , 以及 CMultitaskLinearMachine 重载.
|
virtualinherited |
train machine
| data | training data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data). If flag is set, model features will be stored after training. |
被 CRelaxedTree, CAutoencoder, CSGDQN , 以及 COnlineSVMSGD 重载.
在文件 Machine.cpp 第 39 行定义.
Trains a locked machine on a set of indices. Error if machine is not locked
NOT IMPLEMENTED
| indices | index vector (of locked features) that is used for training |
被 CKernelMachine , 以及 CMultitaskLinearMachine 重载.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 303 行定义.
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 248 行定义.
|
protectedinherited |
the distance
在文件 DistanceMachine.h 第 130 行定义.
|
inherited |
io
在文件 SGObject.h 第 369 行定义.
|
inherited |
parameters wrt which we can compute gradients
在文件 SGObject.h 第 384 行定义.
|
inherited |
Hash of parameter values
在文件 SGObject.h 第 387 行定义.
|
inherited |
model selection parameters
在文件 SGObject.h 第 381 行定义.
|
inherited |
parameters
在文件 SGObject.h 第 378 行定义.
|
protectedinherited |
|
protectedinherited |
|
inherited |
parallel
在文件 SGObject.h 第 372 行定义.
|
inherited |
version
在文件 SGObject.h 第 375 行定义.
