Package mdp :: Package hinet :: Class FlowNode
[hide private]
[frames] | no frames]

Class FlowNode


FlowNode wraps a Flow of Nodes into a single Node.

This is handy if you want to use a flow where a Node is required.
Additional args and kwargs for train and execute are supported.

Note that for nodes in the internal flow the intermediate training phases
will generally be closed, e.g. a CheckpointSaveFunction should not expect
these training  phases to be left open.

All the read-only container slots are supported and are forwarded to the
internal flow.

Nested Classes [hide private]
    Inherited from Node
  __metaclass__
This Metaclass is meant to overwrite doc strings of methods like execute, stop_training, inverse with the ones defined in the corresponding private methods _execute, _stop_training, _inverse, etc...
Instance Methods [hide private]
 
__contains__(self, item)
 
__getitem__(self, key)
 
__init__(self, flow, input_dim=None, output_dim=None, dtype=None)
Wrap the given flow into this node.
 
__iter__(self)
 
__len__(self)
 
_execute(self, x, *args, **kwargs)
 
_get_stop_training_wrapper(self, node, func)
Return wrapper for stop_training to set FlowNode outputdim.
 
_get_supported_dtypes(self)
Return the list of dtypes supported by this node.
 
_get_train_seq(self)
Return a training sequence containing all training phases.
 
_inverse(self, x)
 
_set_dtype(self, t)
 
_set_input_dim(self, n)
 
_set_output_dim(self, n)
 
is_invertible(self)
Return True if the node can be inverted, False otherwise.
 
is_trainable(self)
Return True if the node can be trained, False otherwise.

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

    Inherited from Node
 
__add__(self, other)
 
__call__(self, x, *args, **kargs)
Calling an instance of Node is equivalent to call 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)
 
_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.
 
_stop_training(self, *args, **kwargs)
 
_train(self, x)
 
copy(self, protocol=-1)
Return a deep copy of the node.
 
execute(self, x, *args, **kargs)
Process the data contained in 'x'.
 
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.
 
inverse(self, y, *args, **kargs)
Invert 'y'.
 
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'.
 
set_dtype(self, t)
Set internal structures' dtype.
 
set_input_dim(self, n)
Set input dimensions.
 
set_output_dim(self, n)
Set output dimensions.
 
stop_training(self, *args, **kwargs)
Stop the training phase.
 
train(self, x, *args, **kwargs)
Update the internal structures according to the input data 'x'.
Properties [hide private]
  flow
Read-only internal flow property.

Inherited from object: __class__

    Inherited from Node
  _train_seq
List of tuples: [(training-phase1, stop-training-phase1), (training-phase2, stop_training-phase2), ...
  dtype
dtype
  input_dim
Input dimensions
  output_dim
Output dimensions
  supported_dtypes
Supported dtypes
Method Details [hide private]

__contains__(self, item)
(In operator)

 

__getitem__(self, key)
(Indexing operator)

 

__init__(self, flow, input_dim=None, output_dim=None, dtype=None)
(Constructor)

 
Wrap the given flow into this node.

Pretrained nodes are allowed, but the internal flow should not 
be modified after the FlowNode was created (this will cause problems
if the training phase structure of the internal nodes changes).

If the node dimensions and dtype are not specified, they will be
extracted from the internal nodes (late dimension setting is also
supported). 

flow can have crash recovery enabled, but there is no special support
for it.

Overrides: object.__init__

__iter__(self)

 

__len__(self)
(Length operator)

 

_execute(self, x, *args, **kwargs)

 
Overrides: Node._execute

_get_stop_training_wrapper(self, node, func)

 
Return wrapper for stop_training to set FlowNode outputdim.

_get_supported_dtypes(self)

 
Return the list of dtypes supported by this node.
The types can be specified in any format allowed by numpy.dtype.

Overrides: Node._get_supported_dtypes
(inherited documentation)

_get_train_seq(self)

 
Return a training sequence containing all training phases.

Overrides: Node._get_train_seq

_inverse(self, x)

 
Overrides: Node._inverse

_set_dtype(self, t)

 
Overrides: Node._set_dtype

_set_input_dim(self, n)

 
Overrides: Node._set_input_dim

_set_output_dim(self, n)

 
Overrides: Node._set_output_dim

is_invertible(self)

 
Return True if the node can be inverted, False otherwise.

Overrides: Node.is_invertible
(inherited documentation)

is_trainable(self)

 
Return True if the node can be trained, False otherwise.

Overrides: Node.is_trainable
(inherited documentation)

Property Details [hide private]

flow

Read-only internal flow property.

In general the internal flow should not be modified (see __init__
for more details). 

Get Method:
unreachable.flow(self) - Read-only internal flow property.