Package mdp :: Package nodes :: Class HistogramNode

Class HistogramNode

Node which stores a history of the data during its training phase.

The data history is stored in self.data_hist and can also be deleted to free memory. Alternatively it can be automatically pickled to disk.

Note that data is only stored during training.

Instance Methods

[hide private]

__init__(self, hist_fraction=1.0, hist_filename=None, input_dim=None, output_dim=None, dtype=None)
Initializes an object of type 'HistogramNode'.

list

_get_supported_dtypes(self)
Return the data types supported by this node.

_stop_training(self)
Pickle the histogram data to file and clear it if required.

_train(self, x)
Store the history data.

stop_training(self)
Pickle the histogram data to file and clear it if required.

train(self, x)
Store the history data.

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 PreserveDimNode

_set_input_dim(self, n)

_set_output_dim(self, n)

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)

_execute(self, x)

_get_train_seq(self)

_if_training_stop_training(self)

_inverse(self, x)

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

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

execute(self, x, *args, **kwargs)
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.

has_multiple_training_phases(self)
Return True if the node has multiple training phases.

inverse(self, y, *args, **kwargs)
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. 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.

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, hist_fraction=1.0, hist_filename=None, input_dim=None, output_dim=None, dtype=None)
(Constructor)

Initializes an object of type 'HistogramNode'.

Parameters:

hist_fraction (float) - Defines the fraction of the data that is stored randomly. Default is 1.0.
hist_filename (str) - Filename for the file to which the data history will be pickled after training. The data is pickled when stop_training is called and data_hist is then cleared (to free memory). If filename is None (default value) then data_hist is not cleared and can be directly used after training.
input_dim (int) - The input dimensionality.
output_dim (int) - The output dimensionality.
dtype (numpy.dtype or str) - The datatype.

Overrides: object.__init__

_get_supported_dtypes(self)

Return the data types supported by this node.

Returns: list: The list of numpy.dtypes that this node supports.
Overrides: Node._get_supported_dtypes

_stop_training(self)

Pickle the histogram data to file and clear it if required.

Overrides: Node._stop_training

_train(self, x)

Store the history data.

Parameters:

x (numpy.ndarray) - The history data.

Overrides: Node._train

stop_training(self)

Pickle the histogram data to file and clear it if required.

Overrides: Node.stop_training

train(self, x)

Store the history data.

Parameters:

x (numpy.ndarray) - The history data.

Overrides: Node.train

Class HistogramNode

__init__(self, hist_fraction=1.0, hist_filename=None, input_dim=None, output_dim=None, dtype=None) (Constructor)

_get_supported_dtypes(self)

_stop_training(self)

_train(self, x)

stop_training(self)

train(self, x)

init(self, hist_fraction=1.0, hist_filename=None, input_dim=None, output_dim=None, dtype=None)
(Constructor)