Package mdp :: Package parallel :: Class ParallelFlowNode

Class ParallelFlowNode

Parallel version of FlowNode.

Instance Methods

[hide private]

_fork(self)
Fork nodes that require it, reference all other nodes.

_join(self, forked_node)
Join the required nodes from the forked node into this FlowNode.

use_execute_fork(self)
Return True if node requires a fork / join even during execution.

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 hinet.FlowNode

__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)

_fix_nodes_dimensions(self)
Try to fix the dimensions of the internal nodes.

_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)

copy(self, protocol=None)
Return a copy of this node.

execute(self, x, *args, **kwargs)
Process the data contained in `x`.

inverse(self, x)
Invert `y`.

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 ParallelExtensionNode

_default_fork(self)
Default implementation of _fork.

fork(self)
Return a new instance of this node class for remote training.

join(self, forked_node)
Absorb the trained node from a fork into this parent node.

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)

_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)

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 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.

stop_training(self, *args, **kwargs)
Stop the training phase.

train(self, x, *args, **kwargs)
Update the internal structures according to the input data x.

Static Methods

[hide private]

Inherited from ParallelExtensionNode

_join_covariance(cov, forked_cov)
Helper method to join two CovarianceMatrix instances.

Class Variables

[hide private]

Inherited from ParallelExtensionNode

extension_name = 'parallel'
hash(x)

Properties

[hide private]

Inherited from object: __class__

Inherited from hinet.FlowNode

flow
Read-only internal flow property.

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]

_fork(self)

Fork nodes that require it, reference all other nodes.

If a required fork() fails the exception is not caught here.

Overrides: ParallelExtensionNode._fork

_join(self, forked_node)

Join the required nodes from the forked node into this FlowNode.

Overrides: ParallelExtensionNode._join

use_execute_fork(self)

Return True if node requires a fork / join even during execution.

The default output is False, overwrite this method if required.

Note that the same fork and join methods are used as during training,
so the distinction must be implemented in the custom _fork and _join
methods.

Overrides: ParallelExtensionNode.use_execute_fork: (inherited documentation)