deepy.layers.NeuralLayer

Complexity

Total Complexity

50

Size/Duplication

Total Lines	250
Duplicated Lines	0 %

26 Methods

Rating	Name	Duplication	Size	Complexity
A	NeuralLayer.register_monitors()	0	9	3
A	NeuralLayer.create_vector()	0	6	1
A	NeuralLayer.register_training_callbacks()	0	5	1
A	NeuralLayer.register_external_targets()	0	5	1
A	NeuralLayer.register_updates()	0	8	3
A	NeuralLayer.register_parameters()	0	7	2
A	NeuralLayer.create_bias()	0	8	2
A	NeuralLayer.setup()	0	6	1
A	NeuralLayer.compute_flexible_tensor()	0	9	2
A	NeuralLayer.callback_forward_propagation()	0	2	1
A	NeuralLayer.register_training_updates()	0	8	3
A	NeuralLayer.create_matrix()	0	6	1
D	NeuralLayer.compute()	0	25	8
A	NeuralLayer.compute_test_tesnor()	0	6	1
A	NeuralLayer.register_free_parameters()	0	5	1
A	NeuralLayer.register_epoch_callbacks()	0	5	1
B	NeuralLayer.__init__()	0	28	1
A	NeuralLayer.create_weight()	0	11	3
A	NeuralLayer.prepare()	0	5	1
A	NeuralLayer.register_inner_layers()	0	5	2
A	NeuralLayer.compute_tensor()	0	6	1
A	NeuralLayer.register()	0	5	1
A	NeuralLayer.register_external_inputs()	0	5	1
A	NeuralLayer.register_testing_callbacks()	0	5	1
B	NeuralLayer.initialize()	0	22	5
A	NeuralLayer.belongs_to()	0	11	2

#!/usr/bin/env python
# -*- coding: utf-8 -*-


import logging as loggers

import numpy as np
import theano

from deepy.utils import FLOATX, UniformInitializer, neural_computation, neural_computation_prefer_tensor
from deepy.utils import convert_to_neural_var, convert_to_theano_var

logging = loggers.getLogger(__name__)

class NeuralLayer(object):

    def __init__(self, name="unknown"):
        """
        Create a neural layer.
        """
        self.name = name
        self.input_dim = 0
        self.input_dims = [0]
        self.output_dim = 0
        self.output_dims= [0]

        self._linked_block = None

        self.initialized = False
        self.updates = []
        self.training_updates = []
        self.free_parameters = []
        self.parameters = []
        self.training_monitors = []
        self.testing_monitors = []
        self._registered_monitors = set()
        self._registered_updates = set()
        self._registered_training_updates = set()
        self.external_inputs = []
        self.external_targets = []
        self.parameter_count = 0
        self.epoch_callbacks = []
        self.training_callbacks = []
        self.testing_callbacks = []

    def initialize(self, input_dim=0, input_dims=None, no_prepare=False):
        """
        Initialize the layer.
        :param no_prepare: avoid calling preparation function
        """
        if self.initialized:
            return
        # configure input dimensions
        if input_dims:
            self.input_dims = input_dims
            self.input_dim = input_dims[0]
        else:
            self.input_dim = input_dim
            self.input_dims = [input_dims]
        # set default output dimension
        if self.output_dim == 0:
            self.output_dim = self.input_dim
        self.initialized = True
        # call prepare
        if not no_prepare:
            self.prepare()
        return self

    def compute(self, *inputs, **kwargs):
        """
        Compute based on NeuralVariable.
        :type inputs:  list of NeuralVariable
        :return: NeuralVariable
        """
        from var import NeuralVariable
        if type(inputs[0]) != NeuralVariable:
            raise SystemError("The input of `compute` must be NeuralVar")

        dims = [t.dim() for t in inputs]
        if len(inputs) == 1:
            self.initialize(input_dim=dims[0])
        else:
            self.initialize(input_dims=dims)
        # convert kwargs
        train_kwargs, test_kwargs, _, _ = convert_to_theano_var(kwargs)

        output = self.compute_tensor(*[t.tensor for t in inputs], **train_kwargs)
        test_output = self.compute_test_tesnor(*[t.test_tensor for t in inputs], **test_kwargs)

        if type(output) != list:
            return NeuralVariable(output, test_output, self.output_dim)
        else:
            return [NeuralVariable(*item) for item in zip(self.output_dims, output, test_output)]

    def prepare(self):
        """
        Prepare function will be called after connected.
        """
        return self.setup()

    def setup(self):
        """
        !!! DEPRECATED !!!
        Setup function will be called after connected.
        """
        pass

    @neural_computation_prefer_tensor
    def compute_tensor(self, *args, **kwargs):
        """
        Compute with tensors in Theano.
        """
        raise NotImplementedError("output function of '%s' is not implemented" % self.name)

    @neural_computation_prefer_tensor
    def compute_test_tesnor(self, *args, **kwargs):
        """
        Compute with tensors in Theano in test time.
        """
        return self.compute_tensor(*args, **kwargs)

    def compute_flexible_tensor(self, x, test=False):
        """
        Deprecated.
        Compute with tensors in Theano, with a parameter to switch test or not.
        """
        if test:
            return self.compute_test_tesnor(x)
        else:
            return self.compute_tensor(x)

    def belongs_to(self, block):
        """
        Let the given block or network manage the parameters of this layer.
        :param block: Block or NeuralNetwork
        :return: NeuralLayer
        """
        if self._linked_block:
            raise SystemError("One layer can not belong to two blocks")
        self._linked_block = block
        block.register_layer(self)
        return self

    def register(self, *layers):
        """
        Register inner layers.
        """
        self.register_inner_layers(*layers)

    def register_inner_layers(self, *layers):
        for layer in layers:
            self.register_parameters(*layer.parameters)
            self.register_updates(*layer.updates)
            self.register_training_updates(*layer.training_updates)

    def register_parameters(self, *parameters):
        """
        Register parameters.
        """
        for param in parameters:
            self.parameter_count += np.prod(param.get_value().shape)
        self.parameters.extend(parameters)

    def register_free_parameters(self, *free_parameters):
        """
        Register free parameters, which means their value will not be learned by trainer.
        """
        return self.free_parameters.extend(free_parameters)

    def register_updates(self, *updates):
        """
        Register updates that will be executed in each iteration.
        """
        for key, node in updates:
            if key not in self._registered_updates:
                self.updates.append((key, node))
                self._registered_updates.add(key)

    def register_training_updates(self, *updates):
        """
        Register updates that will only be executed in training phase.
        """
        for key, node in updates:
            if key not in self._registered_training_updates:
                self.training_updates.append((key, node))
                self._registered_training_updates.add(key)

    def register_monitors(self, *monitors):
        """
        Register monitors they should be tuple of name and Theano variable.
        """
        for key, node in monitors:
            if key not in self._registered_monitors:
                self.training_monitors.append((key, node))
                self.testing_monitors.append((key, node))
                self._registered_monitors.add(key)

    def register_external_inputs(self, *variables):
        """
        Register external input variables.
        """
        self.external_inputs.extend(variables)

    def register_external_targets(self, *variables):
        """
        Register extenal target variables.
        """
        self.external_targets.extend(variables)

    def register_training_callbacks(self, *callbacks):
        """
        Register callback for each iteration in the training.
        """
        self.training_callbacks.extend(callbacks)

    def register_testing_callbacks(self, *callbacks):
        """
        Register callback for each iteration in the testing.
        """
        self.testing_callbacks.extend(callbacks)

    def register_epoch_callbacks(self, *callbacks):
        """
        Register callback which will be called after epoch finished.
        """
        self.epoch_callbacks.extend(callbacks)

    def create_weight(self, input_n=1, output_n=1, suffix="", initializer=None, shape=None):
        if not shape:
            shape = (input_n, output_n)

        if not initializer:
            initializer = UniformInitializer()

        weight = theano.shared(initializer.sample(shape).astype(FLOATX), name='W_{}'.format(suffix))

        logging.info('create weight W_%s: %s', suffix, str(shape))
        return weight

    def create_bias(self, output_n=1, suffix="", value=0., shape=None):
        if not shape:
            shape = (output_n, )
        bs =  np.ones(shape)
        bs *= value
        bias = theano.shared(bs.astype(FLOATX), name='B_{}'.format(suffix))
        logging.info('create bias B_%s: %s', suffix, str(shape))
        return bias

    def create_vector(self, n, name, dtype=FLOATX):
        bs =  np.zeros(n)
        v = theano.shared(bs.astype(dtype), name='{}'.format(name))

        logging.info('create vector %s: %d', name, n)
        return v

    def create_matrix(self, m, n, name):

        matrix = theano.shared(np.zeros((m, n)).astype(FLOATX), name=name)

        logging.info('create matrix %s: %d x %d', name, m, n)
        return matrix

    def callback_forward_propagation(self):
        pass