From 44a18de28cb71b07b3f042520eb49cdadcd7abed Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Sun, 3 Apr 2022 15:58:36 -0400 Subject: [PATCH] Clarify RNN comment. --- src/mlpack/methods/ann/rnn.hpp | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/mlpack/methods/ann/rnn.hpp b/src/mlpack/methods/ann/rnn.hpp index 8cf1b67647..87bd5e4e35 100644 --- a/src/mlpack/methods/ann/rnn.hpp +++ b/src/mlpack/methods/ann/rnn.hpp @@ -21,7 +21,13 @@ namespace mlpack { namespace ann /** Artificial Neural Network. */ { /** - * Defenition of a standard recurrent neural network container. + * Definition of a standard recurrent neural network container. A recurrent + * neural network can handle recurrent layers (i.e. `RecurrentLayer`s), which + * hold internal state and are passed sequences of data as inputs. + * + * As opposed to the standard `FFN`, which takes data in a matrix format where + * each column is a data point, the `RNN` takes a cube format where each column + * is a data point and each slice is a time step. * * @tparam OutputLayerType The output layer type used to evaluate the network. * @tparam InitializationRuleType Rule used to initialize the weight matrix.