Skip to main content

TensorFlow Keras RNNs with trainable initial states

Project description

Python Version PyPI Package Version Last Commit GitHub Actions Build Status Code Coverage Documentation Status License

Treat the initial state(s) of TensorFlow Keras recurrent neural network (RNN) layers as a parameter or parameters to be learned during training, as recommended in, e.g., [1].

Ordinary RNNs use an all-zero initial state by default. Why not let the neural network learn a smarter initial state?

The trainable-initial-state-rnn package provides a class TrainableInitialStateRNN that can wrap any tf.keras RNN (or bidirectional RNN) and manage new initial state variables in addition to the RNN’s weights.

Typical usage looks as follows.

import tensorflow as tf
from trainable_initial_state_rnn import TrainableInitialStateRNN

base_rnn = tf.keras.layers.LSTM(256)
rnn = TrainableInitialStateRNN(base_rnn)  # Treats initial state as a variable!

model = tf.keras.Model(...)  # Use rnn like any other tf.keras layer in your model
model.compile(...)
history = model.fit(...)

Documentation is available at Read the Docs.

Installation

The trainable_initial_state_rnn package can be installed using the pip utility directly from the package’s GitHub page:

pip install git+https://github.com/artemmavrin/trainable-initial-state-rnn.git

Alternatively, install a recent release from the Python Package Index (PyPI):

pip install trainable-initial-state-rnn

Note. To install the project for development (e.g., to make changes to the source code), clone the project repository from GitHub and run make dev:

git clone https://github.com/artemmavrin/trainable-initial-state-rnn.git
cd trainable-initial-state-rnn
# Optional but recommended: create and activate a new Python virtual environment
make dev

This will additionally install the requirements needed to run tests, check code coverage, and produce documentation.

References

[1]Felix A. Gers, Nicol N. Schraudolph, Jürgen Schmidhuber. Learning Precise Timing with LSTM Recurrent Networks. Journal of Machine Learning Research 3 (2002) 115-143. (Link)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for trainable-initial-state-rnn, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size trainable_initial_state_rnn-0.0.3-py3-none-any.whl (10.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size trainable-initial-state-rnn-0.0.3.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page