Define the interface for Model.py

[MarcCote]

We should discuss the interface of Model, what method should be mandatory for subclasses.

Definitions (to be added in a wiki)

• Model:

Some questions

• Should we have a method Initialize in the model. If so, what should it took as input?

Suggestions

• [ ]

[ASalvail]

Model interface :

class Model(object):
    def get_model_output(self, inputs: theano.Varable) -> theano.Variable

    @abstractproperty
    def parameters(self) -> Iterable[theano.SharedVariable]

    @abstractmethod
    def save(self, path)

    @abstractclassmethod
    def load(self, path)

    @abstractmethod
    def initialize(self, rng)
      # A random number generator (instead of a seed) to generate the model with default initializers

    def use_regression(self, X: theano.Variable) -> theano.Variable
      return self._use_regression(self.generate_model_output(X))

    def use_classification(self, X: theano.Variable) -> theano.Variable
      return self._use_classification(self.generate_model_output(X))

    @abstractmethod
    def _use_regression(self, out: theano.Variable) -> theano.Variable

    @abstractmethod
    def _use_classification(self, out: theano.Variable) -> theano.Variable