From 7a649a8dee14f20e2f940f88643dfd5b97de8233 Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Tue, 5 Nov 2019 23:11:03 -0500 Subject: [PATCH] Update LSTM documentation. --- src/mlpack/methods/ann/layer/fast_lstm.hpp | 4 ++++ src/mlpack/methods/ann/layer/lstm.hpp | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/src/mlpack/methods/ann/layer/fast_lstm.hpp b/src/mlpack/methods/ann/layer/fast_lstm.hpp index 034bafd744..e73906a5ba 100644 --- a/src/mlpack/methods/ann/layer/fast_lstm.hpp +++ b/src/mlpack/methods/ann/layer/fast_lstm.hpp @@ -36,6 +36,10 @@ namespace ann /** Artificial Neural Network. */ { * Note that FastLSTM network layer does not use peephole connections between * the cell and gates. * + * Note also that if a FastLSTM layer is desired as the first layer of a neural + * network, an IdentityLayer should be added to the network as the first layer, + * and then the FastLSTM layer should be added. + * * For more information, see the following. * * @code diff --git a/src/mlpack/methods/ann/layer/lstm.hpp b/src/mlpack/methods/ann/layer/lstm.hpp index 0083aa0af7..c6b5c51ae2 100644 --- a/src/mlpack/methods/ann/layer/lstm.hpp +++ b/src/mlpack/methods/ann/layer/lstm.hpp @@ -31,6 +31,10 @@ namespace ann /** Artificial Neural Network. */ { * h &=& o \cdot tanh(c) * @f} * + * Note that if an LSTM layer is desired as the first layer of a neural network, + * an IdentityLayer should be added to the network as the first layer, and then + * the LSTM layer should be added. + * * For more information, see the following. * * @code