Home       Trees       Indices       Help   
Modular toolkit for Data Processing MDP
Package mdp :: Package nodes :: Class FastICANode
[hide private]
[frames] | no frames]

Class FastICANode

Perform Independent Component Analysis using the FastICA algorithm.

Note that FastICA is a batch-algorithm. This means that it needs all input data before it can start and compute the ICs. The algorithm is here given as a Node for convenience, but it actually accumulates all inputs it receives. Remember that to avoid running out of memory when you have many components and many time samples.

FastICA does not support the telescope mode (the convergence criterium is not robust in telescope mode). criterium is not robust in telescope mode).

History:

Reference

Aapo Hyvarinen (1999). Fast and Robust Fixed-Point Algorithms for Independent Component Analysis IEEE Transactions on Neural Networks, 10(3):626-634.

Instance Methods [hide private]
 
__init__(self, approach='defl', g='pow3', guess=None, fine_g='pow3', mu=1, sample_size=1, fine_tanh=1, fine_gaus=1, max_it=5000, max_it_fine=100, failures=5, coarse_limit=None, limit=0.001, verbose=False, whitened=False, white_comp=None, white_parm=None, input_dim=None, dtype=None)
Initializes an object of type 'FastICANode'.
 
_get_rsamples(self, X)
float
core(self, data)
This is the core routine of a node inheriting from ICANode.

Inherited from unreachable.ProjectMatrixMixin: get_projmatrix, get_recmatrix

Inherited from unreachable.newobject: __long__, __native__, __nonzero__, __unicode__, next

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

    Inherited from ICANode
 
_execute(self, x)
 
_inverse(self, y)
 
_set_input_dim(self, n)
 
_stop_training(self)
Whiten data if needed and call the 'core' routine to perform ICA.
 
execute(self, x)
Process the data contained in x.
 
inverse(self, y)
Invert y.
 
stop_training(self)
Whiten data if needed and call the 'core' routine to perform ICA.
    Inherited from Cumulator
 
_train(self, *args)
Collect all input data in a list.
 
train(self, *args)
Collect all input data in a list.
    Inherited from Node
 
__add__(self, other)
 
__call__(self, x, *args, **kwargs)
Calling an instance of Node is equivalent to calling its execute method.
 
__repr__(self)
repr(x)
 
__str__(self)
str(x)
 
_check_input(self, x)
 
_check_output(self, y)
 
_check_train_args(self, x, *args, **kwargs)
 
_get_supported_dtypes(self)
Return the list of dtypes supported by this node.
 
_get_train_seq(self)
 
_if_training_stop_training(self)
 
_pre_execution_checks(self, x)
This method contains all pre-execution checks.
 
_pre_inversion_checks(self, y)
This method contains all pre-inversion checks.
 
_refcast(self, x)
Helper function to cast arrays to the internal dtype.
 
_set_dtype(self, t)
 
_set_output_dim(self, n)
 
copy(self, protocol=None)
Return a deep copy of the node.
 
get_current_train_phase(self)
Return the index of the current training phase.
 
get_dtype(self)
Return dtype.
 
get_input_dim(self)
Return input dimensions.
 
get_output_dim(self)
Return output dimensions.
 
get_remaining_train_phase(self)
Return the number of training phases still to accomplish.
 
get_supported_dtypes(self)
Return dtypes supported by the node as a list of numpy.dtype objects.
 
has_multiple_training_phases(self)
Return True if the node has multiple training phases.
 
is_training(self)
Return True if the node is in the training phase, False otherwise.
 
save(self, filename, protocol=-1)
Save a pickled serialization of the node to filename. If filename is None, return a string.
 
set_dtype(self, t)
Set internal structures' dtype.
 
set_input_dim(self, n)
Set input dimensions.
 
set_output_dim(self, n)
Set output dimensions.
Static Methods [hide private]
    Inherited from Node
 
is_invertible()
Return True if the node can be inverted, False otherwise.
 
is_trainable()
Return True if the node can be trained, False otherwise.
Instance Variables [hide private]
  convergence
The value of the convergence threshold.
  filters
The ICA filters matrix (this is the transposed of the projection matrix after whitening).
  white
The whitening node used for preprocessing.
Properties [hide private]

Inherited from object: __class__

    Inherited from Node
  _train_seq
List of tuples:
  dtype
dtype
  input_dim
Input dimensions
  output_dim
Output dimensions
  supported_dtypes
Supported dtypes
Method Details [hide private]

__init__(self, approach='defl', g='pow3', guess=None, fine_g='pow3', mu=1, sample_size=1, fine_tanh=1, fine_gaus=1, max_it=5000, max_it_fine=100, failures=5, coarse_limit=None, limit=0.001, verbose=False, whitened=False, white_comp=None, white_parm=None, input_dim=None, dtype=None)
(Constructor)

 
Initializes an object of type 'FastICANode'.
Parameters:

  • approach (str) - approach: Approach to use. Possible values are

    -'defl':deflation -'symm': symmetric

  • g (str) - Nonlinearity to use. Possible values are -'pow3': x^3 -'tanh': tanh(fine_tanh*x) -'gaus': x*exp(-fine_gaus*x^2/2) -'skew': x^2 (for skewed signals)
  • guess - Initial guess for the mixing matrix (ignored if None).
  • fine_g (str) - Nonlinearity for fine tuning. Possible values are the same as for 'g'. Set it to None to disable fine tuning.
  • mu - Step size.
  • sample_size (float) - Percentage of samples used in one iteration. If sample_size < 1, samples are chosen in random order.
  • fine_tanh (float) - Parameter for 'tanh' nonlinearity.
  • fine_gaus (float) - Parameter for 'gaus' nonlinearity.
  • max_it (int) - Maximum number of iterations.
  • max_it_fine (int) - Maximum number of iterations for fine tuning.
  • failures (int) - Maximum number of failures to allow in deflation mode.
  • coarse_limit (float) - Initial convergence threshold, to switch to fine_g function (i.e. linear to non-linear) even before reaching the limit and final tuning. Set it to a value higher than limit to be in effect.
  • limit (float) - Convergence threshold.
  • verbose (bool) - Idicates whether information is to be reported about the operation.
  • whitened (bool) - Set whitened == True if input data are already whitened. Otherwise the node will whiten the data itself.
  • white_comp (int) - If whitened == False, you can set 'white_comp' to the number of whitened components to keep during the calculation (i.e., the input dimensions are reduced to white_comp by keeping the components of largest variance).

  • white_parm (dict) - A dictionary with additional parameters for whitening. It is passed directly to the WhiteningNode constructor. For example:

    >>> white_parm = { 'svd' : True }
  • input_dim (int) - The input dimensionality.
  • dtype (numpy.dtype or str) - The datatype.
Overrides: object.__init__

_get_rsamples(self, X)

 

core(self, data)

 

This is the core routine of a node inheriting from ICANode.

As a subclass, the FastICANode defines this function to return the achieved convergence value. This function is also responsible for setting the ICA filters matrix self.filters.

Parameters:
  • data (numpy.ndarray) - The data you want to perform ICA on.
Returns: float
The convergence value.
Overrides: ICANode.core

Instance Variable Details [hide private]

convergence

The value of the convergence threshold.

filters

The ICA filters matrix (this is the transposed of the projection matrix after whitening).

white

The whitening node used for preprocessing.

   Home       Trees       Indices       Help   
Modular toolkit for Data Processing MDP
Generated by Epydoc 3.0.1-MDP on Mon Apr 27 21:56:18 2020 http://epydoc.sourceforge.net