Package mdp :: Package hinet :: Class ChannelSwitchboard

Class ChannelSwitchboard

Base class for Switchboards in which the data is bundled into channels.

The dimensions of the input / output channels are constant.

public attributes (in addition to inherited attributes):
    out_channel_dim
    in_channel_dim
    output_channels

Instance Methods

[hide private]

__init__(self, input_dim, connections, out_channel_dim, in_channel_dim=1)
Initialize the switchboard.

get_out_channel_input(self, channel)
Return the input connections for the given channel index.

get_out_channel_node(self, channel)
Return a Switchboard that does the routing for a single output channel.

get_out_channels_input_channels(self, channels)
Return array of input channel indices for the given output channels.

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 Switchboard

_execute(self, x)

_get_supported_dtypes(self)
Return the list of dtypes supported by this node.

_inverse(self, x)

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

inverse(self, x)
Invert `y`.

is_invertible(self)
Return True if the node can be inverted, False otherwise.

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_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_input_dim(self, n)

_set_output_dim(self, n)

_stop_training(self, *args, **kwargs)

_train(self, x)

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.

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 Switchboard

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

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, input_dim, connections, out_channel_dim, in_channel_dim=1)
(Constructor)

Initialize the switchboard.

connections -- Connection sequence like for a standard switchboard
    (the indices do not correspond to whole channels, but single
     connections).
out_channel_dim -- Number of connections per output channel.
in_channel_dim -- Number of connections per input channel (default 1).
    All the components of an input channel are treated equally
    by the switchboard (i.e., they are routed to the same output
    channel).

Overrides: object.__init__

get_out_channel_input(self, channel)

Return the input connections for the given channel index.

channel -- index of the requested channel (starting at 0)

get_out_channel_node(self, channel)

Return a Switchboard that does the routing for a single
output channel.

channel -- index of the requested channel (starting at 0)

get_out_channels_input_channels(self, channels)

Return array of input channel indices for the given output channels.

channels -- Sequence of the requested output channels or a single
    channel index (i.e. a number).

The returned array contains the indices of all input channels which
are connected to at least one of the given output channels.

Class ChannelSwitchboard

__init__(self, input_dim, connections, out_channel_dim, in_channel_dim=1) (Constructor)

get_out_channel_input(self, channel)

get_out_channel_node(self, channel)

get_out_channels_input_channels(self, channels)

init(self, input_dim, connections, out_channel_dim, in_channel_dim=1)
(Constructor)