gruProjectedLayer
Gated recurrent unit (GRU) projected layer for recurrent neural network (RNN)
Since R2023b
Description
A GRU projected layer is an RNN layer that learns dependencies between time steps in timeseries and sequence data using projected learnable weights.
To compress a deep learning network, you can use projected layers. A projected layer is a type of deep learning layer that enables compression by reducing the number of stored learnable parameters. The layer introduces learnable projector matrices Q, replaces multiplications of the form $$Wx$$, where W is a learnable matrix, with the multiplication $$WQ{Q}^{\top}x$$, and stores Q and $$W\prime =WQ$$ instead of storing W. Projecting x into a lowerdimensional space using Q typically requires less memory to store the learnable parameters and can have similarly strong prediction accuracy.
Reducing the number of learnable parameters by projecting a GRU layer rather than reducing the number of hidden units of the GRU layer maintains the output size of the layer and, in turn, the sizes of the downstream layers, which can result in better prediction accuracy.Creation
Syntax
Description
creates a GRU projected layer and sets the layer
= gruProjectedLayer(numHiddenUnits
,outputProjectorSize
,inputProjectorSize
)NumHiddenUnits
, OutputProjectorSize
, and InputProjectorSize
properties.
sets the layer
= gruProjectedLayer(___,Name=Value
)OutputMode
, HasStateInputs
, HasStateOutputs
, ResetGateMode
,
Activations, State, Parameters and Initialization, Learning Rate and Regularization, and Name
properties using one or more namevalue arguments.
Tip
To compress a neural network using projection, use the compressNetworkUsingProjection
function.
Properties
Projected GRU
NumHiddenUnits
— Number of hidden units
positive integer
Number of hidden units (also known as the hidden size), specified as a positive integer.
The number of hidden units corresponds to the amount of information that the layer remembers between time steps (the hidden state). The hidden state can contain information from all the previous time steps, regardless of the sequence length. If the number of hidden units is too large, then the layer can overfit to the training data.
The hidden state does not limit the number of time steps that the layer processes in
an iteration. To split your sequences into smaller sequences for when you use the
trainnet
and trainNetwork
functions, use the SequenceLength
training option.
The layer outputs data with NumHiddenUnits
channels.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
Data Types: single
 double
 int8
 int16
 int32
 int64
 uint8
 uint16
 uint32
 uint64
OutputProjectorSize
— Output projector size
positive integer
Output projector size, specified as a positive integer.
The GRU layer operation uses three matrix multiplications of the form $$R{h}_{t1}$$, where R denotes the recurrent weights and h_{t} denotes the hidden state (or, equivalently, the layer output) at time step t.
The GRU projected layer operation instead uses multiplications of the from $$R{Q}_{o}{Q}_{o}^{\top}{h}_{t1}$$, where Q_{o} is a NumHiddenUnits
byOutputProjectorSize
matrix known as the output projector. The layer uses the same projector Q_{o} for each of the three multiplications.
To perform the three multiplications of the form $$R{h}_{t1}$$, a GRU layer stores three recurrent weights matrices R, which necessitates storing 3*NumHiddenUnits^2
learnable parameters. By instead storing the 3*NumHiddenUnits
byOutputProjectorSize
matrix $$R\prime =R{Q}_{o}$$ and Q_{o}, a GRU projected layer can perform the multiplication $$R{Q}_{o}{Q}_{o}^{\top}{h}_{t1}$$ and store only 4*NumHiddenUnits*OutputProjectorSize
learnable parameters.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
Tip
To ensure that $$R{Q}_{o}{Q}_{o}^{\top}{h}_{t1}$$ requires fewer learnable parameters, set the
OutputProjectorSize
property to a value less than
3*NumHiddenUnits/4
.
Data Types: single
 double
 int8
 int16
 int32
 int64
 uint8
 uint16
 uint32
 uint64
InputProjectorSize
— Input projector size
positive integer
Input projector size, specified as a positive integer.
The GRU layer operation uses three matrix multiplications of the form $$W{x}_{t}$$, where W denotes the input weights and x_{t} denotes the layer input at time step t.
The GRU projected layer operation instead uses multiplications of the from $$W{Q}_{i}{Q}_{i}^{\top}{x}_{t}$$, where Q_{i} is an InputSize
byInputProjectorSize
matrix known as the input projector. The layer uses the same projector Q_{i} for each of the three multiplications.
To perform the three multiplications of the form $$W{x}_{t}$$, a GRU layer stores three weight matrices W, which necessitates storing 3*NumHiddenUnits*InputSize
learnable parameters. By instead storing the 3*NumHiddenUnits
byInputProjectorSize
matrix $$W\prime =W{Q}_{i}$$ and Q_{i}, a GRU projected layer can perform the multiplication $$W{Q}_{i}{Q}_{i}^{\top}{x}_{t}$$ and store only (3*NumHiddenUnits+InputSize)*InputProjectorSize
learnable parameters.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
Tip
To ensure that $$W{Q}_{i}{Q}_{i}^{\top}{x}_{t}$$ requires fewer learnable parameters, set the
InputProjectorSize
property to a value less than
3*NumHiddenUnits*inputSize/(3*NumHiddenUnits+inputSize)
.
Data Types: single
 double
 int8
 int16
 int32
 int64
 uint8
 uint16
 uint32
 uint64
OutputMode
— Output mode
"sequence"
(default)  "last"
Output mode, specified as one of these values:
"sequence"
— Output the complete sequence."last"
— Output the last time step of the sequence.
The GRUProjectedLayer
object stores this property as a character vector.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
HasStateInputs
— Flag for state inputs to layer
0
(false
) (default)  1
(true
)
Flag for state inputs to the layer, specified as 0
(false
) or 1
(true
).
If the HasStateInputs
property is 0
(false
), then the layer has one input with the name
"in"
, which corresponds to the input data. In this case, the layer
uses the HiddenState
property for the layer
operation.
If the HasStateInputs
property is 1
(true
), then the layer has two inputs with the names
"in"
and "hidden"
, which correspond to the input
data and hidden state, respectively. In this case, the layer uses the values that the
network passes to these inputs for the layer operation. If HasStateInputs
is 1
(true
), then the
HiddenState
property must be empty.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
HasStateOutputs
— Flag for state outputs from layer
0
(false
) (default)  1
(true
)
Flag for state outputs from the layer, specified as 0
(false
) or 1
(true
).
If the HasStateOutputs
property is 0
(false
), then the layer has one output with the name
"out"
, which corresponds to the output data.
If the HasStateOutputs
property is 1
(true
), then the layer has two outputs with the names
"out"
and "hidden"
, which correspond
to the output data and hidden state, respectively. In this case, the layer also
outputs the state values computed during the layer operation.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
ResetGateMode
— Reset gate mode
"aftermultiplication"
(default) 
"beforemultiplication"

"recurrentbiasaftermultiplication"
Reset gate mode, specified as one of these values:
"aftermultiplication"
— Apply the reset gate after matrix multiplication. This option is cuDNN compatible."beforemultiplication"
— Apply the reset gate before matrix multiplication."recurrentbiasaftermultiplication"
— Apply the reset gate after matrix multiplication and use an additional set of bias terms for the recurrent weights.
For more information about the reset gate calculations, see Gated Recurrent Unit Layer.
The GRUProjectedLayer
object stores this property as a character vector.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
InputSize
— Input size
"auto"
(default)  positive integer
This property is readonly.
Input size, specified as a positive integer or "auto"
. If
InputSize
is "auto"
, then the software
automatically assigns the input size at training time.
If InputSize
is "auto"
, then the
GRUProjectedLayer
object stores this property as a character
vector.
Data Types: double
 char
 string
Activations
StateActivationFunction
— Activation function to update hidden state
"tanh"
(default) 
"softsign"
Activation function to update the hidden state, specified as one of these values:
"tanh"
— Use the hyperbolic tangent function (tanh)."softsign"
— Use the softsign function, $$\text{softsign}(x)=\frac{x}{1+\leftx\right}$$.
The layer uses this option as the function $${\sigma}_{s}$$ in the calculations to update the hidden state.
The GRUProjectedLayer
object stores this property as a character vector.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
GateActivationFunction
— Activation function to apply to gates
"sigmoid"
(default)  "hardsigmoid"
Activation function to apply to the gates, specified as one of these values:
"sigmoid"
— Use the sigmoid function, $$\sigma (x)={(1+{e}^{x})}^{1}$$."hardsigmoid"
— Use the hard sigmoid function,$$\sigma (x)=\{\begin{array}{cc}\begin{array}{l}0\hfill \\ 0.2x+0.5\hfill \\ 1\hfill \end{array}& \begin{array}{l}\text{if}x2.5\hfill \\ \text{if}2.5\le x\le 2.5\hfill \\ \text{if}x2.5\hfill \end{array}\end{array}.$$
The layer uses this option as the function $${\sigma}_{g}$$ in the calculations for the layer gates.
The GRUProjectedLayer
object stores this property as a character vector.
To set this property, use the corresponding namevalue argument when you create the GRUProjectedLayer
object. After you create a GRUProjectedLayer
object, this property is readonly.
State
HiddenState
— Hidden state
[]
(default)  numeric vector
Hidden state to use in the layer operation, specified as a
NumHiddenUnits
by1 numeric vector. This value corresponds to the
initial hidden state when data is passed to the layer.
After you set this property manually, calls to the resetState
function set the hidden state to this value.
If HasStateInputs
is 1
(true
), then the HiddenState
property must be empty.
Data Types: single
 double
Parameters and Initialization
InputWeightsInitializer
— Function to initialize input weights
"glorot"
(default)  "he"
 "orthogonal"
 "narrownormal"
 "zeros"
 "ones"
 function handle
Function to initialize the input weights, specified as one of these values:
"glorot"
— Initialize the input weights with the Glorot initializer [1] (also known as the Xavier initializer). The Glorot initializer independently samples from a uniform distribution with a mean of zero and a variance of2/(InputProjectorSize + numOut)
, wherenumOut = 3*NumHiddenUnits
."he"
— Initialize the input weights with the He initializer [2]. The He initializer samples from a normal distribution with a mean of zero and a variance of2/InputProjectorSize
."orthogonal"
— Initialize the input weights with Q, the orthogonal matrix in the QR decomposition of Z = QR for a random matrix Z sampled from a unit normal distribution [3]."narrownormal"
— Initialize the input weights by independently sampling from a normal distribution with a mean of zero and a standard deviation of 0.01."zeros"
— Initialize the input weights with zeros."ones"
— Initialize the input weights with ones.Function handle — Initialize the input weights with a custom function. If you specify a function handle, then the function must have the form
weights = func(sz)
, wheresz
is the size of the input weights.
The layer initializes the input weights only when the InputWeights
property is empty.
The GRUProjectedLayer
object stores this property as a character vector or a
function handle.
Data Types: char
 string
 function_handle
RecurrentWeightsInitializer
— Function to initialize recurrent weights
"orthogonal"
(default)  "glorot"
 "he"
 "narrownormal"
 "zeros"
 "ones"
 function handle
Function to initialize the recurrent weights, specified as one of these values:
"orthogonal"
— Initialize the recurrent weights with Q, the orthogonal matrix in the QR decomposition of Z = QR for a random matrix Z sampled from a unit normal distribution [3]."glorot"
— Initialize the recurrent weights with the Glorot initializer [1] (also known as the Xavier initializer). The Glorot initializer independently samples from a uniform distribution with a mean of zero and a variance of2/(numIn + numOut)
, wherenumIn = OutputProjectorSize
andnumOut = 3*NumHiddenUnits
."he"
— Initialize the recurrent weights with the He initializer [2]. The He initializer samples from a normal distribution with a mean of zero and a variance of2/OutputProjectorSize
."narrownormal"
— Initialize the recurrent weights by independently sampling from a normal distribution with a mean of zero and a standard deviation of 0.01."zeros"
— Initialize the recurrent weights with zeros."ones"
— Initialize the recurrent weights with ones.Function handle — Initialize the recurrent weights with a custom function. If you specify a function handle, then the function must have the form
weights = func(sz)
, wheresz
is the size of the recurrent weights.
The layer initializes the recurrent weights only when the RecurrentWeights
property is empty.
The GRUProjectedLayer
object stores this property as a character vector or a
function handle.
Data Types: char
 string
 function_handle
InputProjectorInitializer
— Function to initialize input projector
"orthogonal"
(default)  "glorot"
 "he"
 "narrownormal"
 "zeros"
 "ones"
 function handle
Function to initialize the input projector, specified as one of these values:
"orthogonal"
— Initialize the input projector with Q, the orthogonal matrix in the QR decomposition of Z = QR for a random matrix Z sampled from a unit normal distribution [3]."glorot"
— Initialize the input projector with the Glorot initializer [1] (also known as the Xavier initializer). The Glorot initializer independently samples from a uniform distribution with a mean of zero and a variance of2/(InputSize + inputProjectorSize)
."he"
— Initialize the input projector with the He initializer [2]. The He initializer samples from a normal distribution with a mean of zero and a variance of2/InputSize
."narrownormal"
— Initialize the input projector by independently sampling from a normal distribution with a mean of zero and a standard deviation of 0.01."zeros"
— Initialize the input projector with zeros."ones"
— Initialize the input projector with ones.Function handle — Initialize the input projector with a custom function. If you specify a function handle, then the function must have the form
weights = func(sz)
, wheresz
is the size of the input projector.
The layer initializes the input projector only when the InputProjector
property is empty.
The GRUProjectedLayer
object stores this property as a character vector or a
function handle.
Data Types: char
 string
 function_handle
OutputProjectorInitializer
— Function to initialize output projector
"orthogonal"
(default)  "glorot"
 "he"
 "narrownormal"
 "zeros"
 "ones"
 function handle
Function to initialize the output projector, specified as one of these values:
"orthogonal"
— Initialize the output projector with Q, the orthogonal matrix in the QR decomposition of Z = QR for a random matrix Z sampled from a unit normal distribution [3]."glorot"
— Initialize the output projector with the Glorot initializer [1] (also known as the Xavier initializer). The Glorot initializer independently samples from a uniform distribution with a mean of zero and a variance of2/(NumHiddenUnits + OutputProjectorSize)
."he"
— Initialize the output projector with the He initializer [2]. The He initializer samples from a normal distribution with a mean of zero and a variance of2/NumHiddenUnits
."narrownormal"
— Initialize the output projector by independently sampling from a normal distribution with a mean of zero and a standard deviation of 0.01."zeros"
— Initialize the output projector with zeros."ones"
— Initialize the output projector with ones.Function handle — Initialize the output projector with a custom function. If you specify a function handle, then the function must have the form
weights = func(sz)
, wheresz
is the size of the output projector.
The layer initializes the output projector only when the OutputProjector
property is empty.
The GRUProjectedLayer
object stores this property as a character vector or a
function handle.
Data Types: char
 string
 function_handle
BiasInitializer
— Function to initialize bias
"zeros"
(default) 
"narrownormal"

"ones"
 function handle
Function to initialize the bias, specified as one of these values:
"zeros"
— Initialize the bias with zeros."narrownormal"
— Initialize the bias by independently sampling from a normal distribution with a mean of zero and standard deviation 0.01."ones"
— Initialize the bias with ones.Function handle — Initialize the bias with a custom function. If you specify a function handle, then the function must have the form
bias = func(sz)
, wheresz
is the size of the bias.
The layer initializes the bias only when the Bias
property is
empty.
The GRUProjectedLayer
object stores this property as a character vector or a
function handle.
Data Types: char
 string
 function_handle
InputWeights
— Input weights
[]
(default)  matrix
Input weights, specified as a matrix.
The input weight matrix is a concatenation of the three input weight matrices for the components in the layer operation. The layer concatenates the matrices vertically in this order:
Reset gate
Update gate
Candidate state
The input weights are learnable parameters. When you train a
neural network using the trainnet
or
trainNetwork
function, if InputWeights
is
nonempty, then the software uses the InputWeights
property as
the initial value. If InputWeights
is empty, then the
software uses the initializer specified by InputWeightsInitializer
.
At training time, InputWeights
is a
3*NumHiddenUnits
byInputProjectorSize
matrix.
RecurrentWeights
— Recurrent weights
[]
(default)  matrix
Recurrent weights, specified as a matrix.
The recurrent weight matrix is a concatenation of the three recurrent weight matrices for the components in the layer operation. The layer concatenates the matrices vertically in this order:
Reset gate
Update gate
Candidate state
The recurrent weights are learnable parameters. When you train
an RNN using the trainnet
or
trainNetwork
function, if RecurrentWeights
is
nonempty, then the software uses the RecurrentWeights
property as the initial value. If RecurrentWeights
is empty,
then the software uses the initializer specified by RecurrentWeightsInitializer
.
At training time RecurrentWeights
is a
3*NumHiddenUnits
byOutputProjectorSize
matrix.
InputProjector
— Input projector
[]
(default)  matrix
Input projector, specified as a matrix.
The input projector weights are learnable parameters. When you train a network using the
trainnet
or
trainNetwork
function, if InputProjector
is nonempty, then the software uses the
InputProjector
property as the initial value. If
InputProjector
is empty, then the software uses
the initializer specified by InputProjectorInitializer
.
At training time, InputProjector
is a InputSize
byInputProjectorSize
matrix.
Data Types: single
 double
OutputProjector
— Output projector
[]
(default)  matrix
Output projector, specified as a matrix.
The output projector weights are learnable parameters. When you train a network using the
trainnet
or
trainNetwork
function, if OutputProjector
is nonempty, then the software uses the
OutputProjector
property as the initial value. If
OutputProjector
is empty, then the software uses
the initializer specified by OutputProjectorInitializer
.
At training time, OutputProjector
is a NumHiddenUnits
byOutputProjectorSize
matrix.
Data Types: single
 double
Bias
— Layer biases
[]
(default)  numeric vector
Layer biases, specified as a numeric vector.
If ResetGateMode
is
"aftermultiplication"
or
"beforemultiplication"
, then the bias vector is a concatenation
of three bias vectors for the components in the layer operation. The layer concatenates
the vectors vertically in this order:
Reset gate
Update gate
Candidate state
In this case, at training time, Bias
is a 3*NumHiddenUnits
by1 numeric vector.
If ResetGateMode
is
"recurrentbiasaftermultiplication"
, then the bias vector is a
concatenation of six bias vectors for the components in the GRU layer. The layer
concatenates the vectors vertically in this order:
Reset gate
Update gate
Candidate state
Reset gate (recurrent bias)
Update gate (recurrent bias)
Candidate state (recurrent bias)
In this case, at training time, Bias
is a 6*NumHiddenUnits
by1 numeric vector.
The layer biases are learnable parameters. When you train a neural network, if Bias
is nonempty, then the trainnet
and trainNetwork
functions use the Bias
property as the initial value. If Bias
is empty, then software uses the initializer specified by BiasInitializer
.
For more information about the reset gate calculations, see Gated Recurrent Unit Layer.
Learning Rate and Regularization
InputWeightsLearnRateFactor
— Learning rate factor for input weights
1
(default)  numeric scalar  1by3 numeric vector
Learning rate factor for the input weights, specified as a numeric scalar or a 1by3 numeric vector.
The software multiplies this factor by the global learning rate
to determine the learning rate factor for the input weights of the layer. For example, if
InputWeightsLearnRateFactor
is 2
, then the learning
rate factor for the input weights of the layer is twice the current global learning rate. The
software determines the global learning rate based on the settings you specify with the
trainingOptions
function.
To control the value of the learning rate factor for the three individual matrices in
InputWeights
, specify a 1by3 vector. The entries of
InputWeightsLearnRateFactor
correspond to the learning rate
factor of these values:
Reset gate
Update gate
Candidate state
To specify the same value for all the matrices, specify a nonnegative scalar.
Example: 2
Example: [1 2 1]
RecurrentWeightsLearnRateFactor
— Learning rate factor for recurrent weights
1
(default)  numeric scalar  1by3 numeric vector
Learning rate factor for the recurrent weights, specified as a numeric scalar or a 1by3 numeric vector.
The software multiplies this factor by the global learning rate
to determine the learning rate for the recurrent weights of the layer. For example, if
RecurrentWeightsLearnRateFactor
is 2
, then the
learning rate for the recurrent weights of the layer is twice the current global learning rate.
The software determines the global learning rate based on the settings you specify using the
trainingOptions
function.
To control the value of the learning rate factor for the three individual matrices in
RecurrentWeights
, specify a 1by3 vector. The entries of
RecurrentWeightsLearnRateFactor
correspond to the learning rate
factor of these values:
Reset gate
Update gate
Candidate state
To specify the same value for all the matrices, specify a nonnegative scalar.
Example: 2
Example: [1 2 1]
InputProjectorLearnRateFactor
— Learning rate factor for input projector
1
(default)  nonnegative scalar
Learning rate factor for the input projector, specified as a nonnegative scalar.
The software multiplies this factor by the global learning rate to determine the learning rate factor for the input projector of the layer. For example, if InputProjectorLearnRateFactor
is 2
, then the learning rate factor for the input projector of the layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions
function.
OutputProjectorLearnRateFactor
— Learning rate factor for output projector
1
(default)  nonnegative scalar
Learning rate factor for the output projector, specified as a nonnegative scalar.
The software multiplies this factor by the global learning rate to determine the learning rate factor for the output projector of the layer. For example, if OutputProjectorLearnRateFactor
is 2
, then the learning rate factor for the output projector of the layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions
function.
BiasLearnRateFactor
— Learning rate factor for biases
1
(default)  nonnegative scalar  1by3 numeric vector
Learning rate factor for the biases, specified as a nonnegative scalar or a 1by3 numeric vector.
The software multiplies this factor by the global learning rate to determine the learning rate for the biases in this layer. For example, if BiasLearnRateFactor
is 2
, then the learning rate for the biases in the layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions
function.
To control the value of the learning rate factor for the three individual vectors in
Bias
, specify a 1by3 vector. The entries of
BiasLearnRateFactor
correspond to the learning rate factor of
these values:
Reset gate
Update gate
Candidate state
If ResetGateMode
is
"recurrentbiasaftermultiplication"
, then the software uses the
same vector for the recurrent bias vectors.
To specify the same value for all the vectors, specify a nonnegative scalar.
Example: 2
Example: [1 2 1]
InputWeightsL2Factor
— L_{2} regularization factor for input weights
1
(default)  numeric scalar  1by3 numeric vector
L_{2} regularization factor for the input weights, specified as a numeric scalar or a 1by3 numeric vector.
The software multiplies this factor by the global
L_{2} regularization factor to determine the
L_{2} regularization factor for the input weights
of the layer. For example, if InputWeightsL2Factor
is 2
,
then the L_{2} regularization factor for the input
weights of the layer is twice the current global L_{2}
regularization factor. The software determines the L_{2}
regularization factor based on the settings you specify using the trainingOptions
function.
To control the value of the L_{2}
regularization factor for the three individual matrices in
InputWeights
, specify a 1by3 vector. The entries of
InputWeightsL2Factor
correspond to the
L_{2} regularization factor of these
values:
Reset gate
Update gate
Candidate state
To specify the same value for all the matrices, specify a nonnegative scalar.
Example:
2
Example:
[1 2 1]
RecurrentWeightsL2Factor
— L_{2} regularization factor for recurrent weights
1
(default)  numeric scalar  1by3 numeric vector
L_{2} regularization factor for the recurrent weights, specified as a numeric scalar or a 1by3 numeric vector.
The software multiplies this factor by the global
L_{2} regularization factor to determine the
L_{2} regularization factor for the recurrent
weights of the layer. For example, if RecurrentWeightsL2Factor
is
2
, then the L_{2} regularization
factor for the recurrent weights of the layer is twice the current global
L_{2} regularization factor. The software
determines the L_{2} regularization factor based on the
settings you specify using the trainingOptions
function.
To control the value of the L_{2}
regularization factor for the three individual matrices in
RecurrentWeights
, specify a 1by3 vector. The entries of
RecurrentWeightsL2Factor
correspond to the
L_{2} regularization factor of these
values:
Reset gate
Update gate
Candidate state
To specify the same value for all the matrices, specify a nonnegative scalar.
Example:
2
Example:
[1 2 1]
InputProjectorL2Factor
— L_{2} regularization factor for input projector
1
(default)  nonnegative scalar
L_{2} regularization factor for the input projector, specified as a nonnegative scalar.
The software multiplies this factor by the global L_{2} regularization factor to determine the L_{2} regularization factor for the input projector of the layer. For example, if InputProjectorL2Factor
is 2
, then the L_{2} regularization factor for the input projector of the layer is twice the current global L_{2} regularization factor. The software determines the global L_{2} regularization factor based on the settings you specify using the trainingOptions
function.
OutputProjectorL2Factor
— L_{2} regularization factor for output projector
1
(default)  nonnegative scalar
L_{2} regularization factor for the output projector, specified as a nonnegative scalar.
The software multiplies this factor by the global L_{2} regularization factor to determine the L_{2} regularization factor for the output projector of the layer. For example, if OutputProjectorL2Factor
is 2
, then the L_{2} regularization factor for the output projector of the layer is twice the current global L_{2} regularization factor. The software determines the global L_{2} regularization factor based on the settings you specify using the trainingOptions
function.
BiasL2Factor
— L_{2} regularization factor for biases
0
(default)  nonnegative scalar  1by3 numeric vector
L_{2} regularization factor for the biases, specified as a nonnegative scalar or a 1by3 numeric vector.
The software multiplies this factor by the global L_{2} regularization factor to determine the L_{2} regularization for the biases in this layer. For example, if BiasL2Factor
is 2
, then the L_{2} regularization for the biases in this layer is twice the global L_{2} regularization factor. The software determines the global L_{2} regularization factor based on the settings you specify using the trainingOptions
function.
To control the value of the L_{2}
regularization factor for the individual vectors in Bias
, specify a
1by3 vector. The entries of BiasL2Factor
correspond to the
L_{2} regularization factor of these
values:
Reset gate
Update gate
Candidate state
If ResetGateMode
is
"recurrentbiasaftermultiplication"
, then the software uses the
same vector for the recurrent bias vectors.
To specify the same value for all the vectors, specify a nonnegative scalar.
Example:
2
Example:
[1 2 1]
Layer
Name
— Layer name
""
(default)  character vector  string scalar
Layer name, specified as a character vector or a string scalar.
For Layer
array input, the trainnet
, trainNetwork
, assembleNetwork
, layerGraph
, and
dlnetwork
functions automatically assign
names to layers with the name ""
.
The GRUProjectedLayer
object stores this property as a character vector.
Data Types: char
 string
NumInputs
— Number of inputs
1

2
This property is readonly.
Number of inputs to the layer.
If the HasStateInputs
property is 0
(false
), then the layer has one input with the name
"in"
, which corresponds to the input data. In this case, the layer
uses the HiddenState
property for the layer
operation.
If the HasStateInputs
property is 1
(true
), then the layer has two inputs with the names
"in"
and "hidden"
, which correspond to the input
data and hidden state, respectively. In this case, the layer uses the values that the
network passes to these inputs for the layer operation. If HasStateInputs
is 1
(true
), then the
HiddenState
property must be empty.
Data Types: double
InputNames
— Layer input names
"in"

["in" "hidden"]
This property is readonly.
Layer input names.
If the HasStateInputs
property is 0
(false
), then the layer has one input with the name
"in"
, which corresponds to the input data. In this case, the layer
uses the HiddenState
property for the layer
operation.
If the HasStateInputs
property is 1
(true
), then the layer has two inputs with the names
"in"
and "hidden"
, which correspond to the input
data and hidden state, respectively. In this case, the layer uses the values that the
network passes to these inputs for the layer operation. If HasStateInputs
is 1
(true
), then the
HiddenState
property must be empty.
The GRUProjectedLayer
object stores this property as a cell array of character
vectors.
NumOutputs
— Number of outputs
1

2
This property is readonly.
Number of outputs from the layer.
If the HasStateOutputs
property is 0
(false
), then the layer has one output with the name
"out"
, which corresponds to the output data.
If the HasStateOutputs
property is 1
(true
), then the layer has two outputs with the names
"out"
and "hidden"
, which correspond
to the output data and hidden state, respectively. In this case, the layer also
outputs the state values computed during the layer operation.
Data Types: double
OutputNames
— Layer output names
"out"

["out" "hidden"]
This property is readonly.
Layer output names.
If the HasStateOutputs
property is 0
(false
), then the layer has one output with the name
"out"
, which corresponds to the output data.
If the HasStateOutputs
property is 1
(true
), then the layer has two outputs with the names
"out"
and "hidden"
, which correspond
to the output data and hidden state, respectively. In this case, the layer also
outputs the state values computed during the layer operation.
The GRUProjectedLayer
object stores this property as a cell array of character
vectors.
Examples
Create GRU Projected Layer
Create a GRU projected layer with 100 hidden units, an output projector size of 30, an input projector size of 16, and the name "grup"
.
layer = gruProjectedLayer(100,30,16,Name="grup")
layer = GRUProjectedLayer with properties: Name: 'grup' InputNames: {'in'} OutputNames: {'out'} NumInputs: 1 NumOutputs: 1 HasStateInputs: 0 HasStateOutputs: 0 Hyperparameters InputSize: 'auto' NumHiddenUnits: 100 InputProjectorSize: 16 OutputProjectorSize: 30 OutputMode: 'sequence' StateActivationFunction: 'tanh' GateActivationFunction: 'sigmoid' ResetGateMode: 'aftermultiplication' Learnable Parameters InputWeights: [] RecurrentWeights: [] Bias: [] InputProjector: [] OutputProjector: [] State Parameters HiddenState: [] Use properties method to see a list of all properties.
Include a GRU projected layer in a layer array.
inputSize = 12; numHiddenUnits = 100; outputProjectorSize = max(1,floor(0.75*numHiddenUnits)); inputProjectorSize = max(1,floor(0.25*inputSize)); layers = [ sequenceInputLayer(inputSize) gruProjectedLayer(numHiddenUnits,outputProjectorSize,inputProjectorSize) fullyConnectedLayer(10) softmaxLayer];
Compare Network Projection Sizes
Compare the sizes of networks that do and do not contain projected layers.
Define a GRU network architecture. Specify the input size as 12, which corresponds to the number of features of the input data. Configure a GRU layer with 100 hidden units that outputs the last element of the sequence. Finally, specify nine classes by including a fully connected layer with a size of 9, followed by a softmax layer.
inputSize = 12; numHiddenUnits = 100; numClasses = 9; layers = [ ... sequenceInputLayer(inputSize) gruLayer(numHiddenUnits,OutputMode="last") fullyConnectedLayer(numClasses) softmaxLayer]; net = dlnetwork(layers);
Analyze the network using the analyzeNetwork
function. The network has approximately 34,800 learnable parameters.
analyzeNetwork(net)
Create an identical network with a GRU projected layer in place of the GRU layer.
For the GRU projected layer:
Specify the same number of hidden units as the GRU layer.
Specify an output projector size of 25% of the number of hidden units.
Specify an input projector size of 75% of the input size.
Ensure that the output and input projector sizes are positive by taking the maximum of the sizes and 1.
outputProjectorSize = max(1,floor(0.25*numHiddenUnits)); inputProjectorSize = max(1,floor(0.75*inputSize)); layersProjected = [ ... sequenceInputLayer(inputSize) gruProjectedLayer(numHiddenUnits,outputProjectorSize,inputProjectorSize,OutputMode="last") fullyConnectedLayer(numClasses) softmaxLayer]; netProjected = dlnetwork(layersProjected);
Analyze the network using the analyzeNetwork
function. The network has approximately 14,000 learnable parameters, which is a reduction of about 60%. The sizes of the learnable parameters of the layers following the projected layer have the same sizes as the network without the GRU projected layer. Reducing the number of learnable parameters by projecting a GRU layer rather than reducing the number of hidden units of the GRU layer maintains the output size of the layer and, in turn, the sizes of the downstream layers, which can result in better prediction accuracy.
analyzeNetwork(netProjected)
Algorithms
Gated Recurrent Unit Layer
A GRU layer is an RNN layer that learns dependencies between time steps in timeseries and sequence data.
The hidden state of the layer at time step t contains the output of the GRU layer for this time step. At each time step, the layer adds information to or removes information from the state. The layer controls these updates using gates.
These components control the hidden state of the layer.
Component  Purpose 

Reset gate (r)  Control level of state reset 
Update gate (z)  Control level of state update 
Candidate state ($$\tilde{h}$$)  Control level of update added to hidden state 
The learnable weights of a GRU layer are the input weights W
(InputWeights
), the recurrent weights R
(RecurrentWeights
), and the bias b
(Bias
). If the ResetGateMode
property is "recurrentbiasaftermultiplication"
, then the gate and
state calculations require two sets of bias values. The matrices W and
R are concatenations of the input weights and the recurrent weights
of each component, respectively. The layer concatenates the matrices in this order:
$$W=\left[\begin{array}{c}{W}_{r}\\ {W}_{z}\\ {W}_{\tilde{h}}\end{array}\right],R=\left[\begin{array}{c}{R}_{r}\\ {R}_{z}\\ {R}_{\tilde{h}}\end{array}\right],$$
where r, z, and $$\tilde{h}$$ denote the reset gate, update gate, and candidate state, respectively.
The bias vector depends on the ResetGateMode
property. If
ResetGateMode
is
"aftermultiplication"
or "beforemultiplication"
,
then the bias vector is a concatenation of three vectors:
$$b=\left[\begin{array}{c}{b}_{{W}_{r}}\\ {b}_{{W}_{z}}\\ {b}_{{W}_{\tilde{h}}}\end{array}\right],$$
where the subscript W indicates that this bias corresponds to the input weights multiplication.
If ResetGateMode
is
"recurrentbiasaftermultiplication"
, then the bias vector is a
concatenation of six vectors:
$$b=\left[\begin{array}{c}{b}_{{W}_{r}}\\ {b}_{{W}_{z}}\\ {b}_{{W}_{\tilde{h}}}\\ {b}_{{R}_{r}}\\ {b}_{{R}_{z}}\\ {b}_{{R}_{\tilde{h}}}\end{array}\right],$$
where the subscript R indicates that this is the bias corresponding to the recurrent weights multiplication.
The hidden state at time step t is given by this equation:
$${h}_{t}=(1{z}_{t})\odot {\tilde{h}}_{t}+{z}_{t}\odot {h}_{t1}.$$
These formulas describe the components at time step t.
Component  ResetGateMode  Formula  

Reset gate  "aftermultiplication"  $${r}_{t}={\sigma}_{g}\left({W}_{r}{x}_{t}+{b}_{{W}_{r}}+\text{}{R}_{r}{h}_{t1}\right)$$  
"beforemultiplication"  
"recurrentbiasaftermultiplication"  $${r}_{t}={\sigma}_{g}\left({W}_{r}{x}_{t}+{b}_{{W}_{r}}+\text{}{R}_{r}{h}_{t1}+{b}_{{R}_{r}}\right)$$  
Update gate  "aftermultiplication"  $${z}_{t}={\sigma}_{g}\left({W}_{z}{x}_{t}+{b}_{{W}_{z}}+\text{}{R}_{z}{h}_{t1}\right)$$  
"beforemultiplication"  
"recurrentbiasaftermultiplication"  $${z}_{t}={\sigma}_{g}\left({W}_{z}{x}_{t}+{b}_{{W}_{z}}+\text{}{R}_{z}{h}_{t1}+{b}_{{R}_{z}}\right)$$  
Candidate state  "aftermultiplication"  $${\tilde{h}}_{t}={\sigma}_{s}\left({W}_{\tilde{h}}{x}_{t}+{b}_{{W}_{\tilde{h}}}+{r}_{t}\odot \text{}({\text{R}}_{\tilde{h}}{h}_{t1})\right)$$  
"beforemultiplication"  $${\tilde{h}}_{t}={\sigma}_{s}\left({W}_{\tilde{h}}{x}_{t}+{b}_{{W}_{\tilde{h}}}+{R}_{\tilde{h}}({r}_{t}\odot \text{}{h}_{t1})\right)$$  
"recurrentbiasaftermultiplication"  $${\tilde{h}}_{t}={\sigma}_{s}\left({W}_{\tilde{h}}{x}_{t}+{b}_{{W}_{\tilde{h}}}+{r}_{t}\odot \text{}\left({\text{R}}_{\tilde{h}}{h}_{t1}+{b}_{{R}_{\tilde{h}}}\right)\right)$$ 
In these calculations, $${\sigma}_{g}$$ and $${\sigma}_{s}$$ denote the gate and state activation functions, respectively. The
gruLayer
function, by default, uses the sigmoid function given by $$\sigma (x)={(1+{e}^{x})}^{1}$$ to compute the gate activation function and the hyperbolic tangent
function (tanh) to compute the state activation function. To specify the state and gate
activation functions, use the StateActivationFunction
and GateActivationFunction
properties, respectively.
GRU Projected Layer
A GRU projected layer is an RNN layer that learns dependencies between time steps in timeseries and sequence data using projected learnable weights.
To compress a deep learning network, you can use projected layers. A projected layer is a type of deep learning layer that enables compression by reducing the number of stored learnable parameters. The layer introduces learnable projector matrices Q, replaces multiplications of the form $$Wx$$, where W is a learnable matrix, with the multiplication $$WQ{Q}^{\top}x$$, and stores Q and $$W\prime =WQ$$ instead of storing W. Projecting x into a lowerdimensional space using Q typically requires less memory to store the learnable parameters and can have similarly strong prediction accuracy.
Reducing the number of learnable parameters by projecting a GRU layer rather than reducing the number of hidden units of the GRU layer maintains the output size of the layer and, in turn, the sizes of the downstream layers, which can result in better prediction accuracy.The GRU layer operation uses three matrix multiplications of the form $$R{h}_{t1}$$, where R denotes the recurrent weights and h_{t} denotes the hidden state (or, equivalently, the layer output) at time step t.
The GRU projected layer operation instead uses multiplications of the from $$R{Q}_{o}{Q}_{o}^{\top}{h}_{t1}$$, where Q_{o} is a NumHiddenUnits
byOutputProjectorSize
matrix known as the output projector. The layer uses the same projector Q_{o} for each of the three multiplications.
To perform the three multiplications of the form $$R{h}_{t1}$$, a GRU layer stores three recurrent weights matrices R, which necessitates storing 3*NumHiddenUnits^2
learnable parameters. By instead storing the 3*NumHiddenUnits
byOutputProjectorSize
matrix $$R\prime =R{Q}_{o}$$ and Q_{o}, a GRU projected layer can perform the multiplication $$R{Q}_{o}{Q}_{o}^{\top}{h}_{t1}$$ and store only 4*NumHiddenUnits*OutputProjectorSize
learnable parameters.
The GRU layer operation uses three matrix multiplications of the form $$W{x}_{t}$$, where W denotes the input weights and x_{t} denotes the layer input at time step t.
The GRU projected layer operation instead uses multiplications of the from $$W{Q}_{i}{Q}_{i}^{\top}{x}_{t}$$, where Q_{i} is an InputSize
byInputProjectorSize
matrix known as the input projector. The layer uses the same projector Q_{i} for each of the three multiplications.
To perform the three multiplications of the form $$W{x}_{t}$$, a GRU layer stores three weight matrices W, which necessitates storing 3*NumHiddenUnits*InputSize
learnable parameters. By instead storing the 3*NumHiddenUnits
byInputProjectorSize
matrix $$W\prime =W{Q}_{i}$$ and Q_{i}, a GRU projected layer can perform the multiplication $$W{Q}_{i}{Q}_{i}^{\top}{x}_{t}$$ and store only (3*NumHiddenUnits+InputSize)*InputProjectorSize
learnable parameters.
Layer Input and Output Formats
Layers in a layer array or layer graph pass data to subsequent layers as formatted dlarray
objects. The format of a dlarray
object is a string of characters, in which each character describes the corresponding dimension of the data. The formats consists of one or more of these characters:
"S"
— Spatial"C"
— Channel"B"
— Batch"T"
— Time"U"
— Unspecified
For example, 2D image data represented as a 4D array, where the first two dimensions correspond to the spatial dimensions of the images, the third dimension corresponds to the channels of the images, and the fourth dimension corresponds to the batch dimension, can be described as having the format "SSCB"
(spatial, spatial, channel, batch).
You can interact with these dlarray
objects in automatic differentiation workflows such as developing a custom layer, using a functionLayer
object, or using the forward
and predict
functions with dlnetwork
objects.
This table shows the supported input formats of GRUProjectedLayer
objects and the
corresponding output format. If the software passes the output of the layer to a custom
layer that does not inherit from the nnet.layer.Formattable
class, or a
FunctionLayer
object with the Formattable
property
set to 0
(false), then the layer receives an unformatted
dlarray
object with dimensions ordered corresponding to the formats in
this table. The formats listed here are only a subset. The layer may support additional
formats such as formats with additional "S"
(spatial) or
"U"
(unspecified) dimensions.
Input Format  OutputMode  Output Format 

 "sequence" 

"last"  
 "sequence" 

"last" 
 
 "sequence" 

"last" 
In dlnetwork
objects, GRUProjectedLayer
objects also support these input and output format combinations.
Input Format  OutputMode  Output Format 

 "sequence" 

"last"  
 "sequence"  
"last"  
 "sequence"  
"last"  
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last"  
 "sequence"  
"last"  
 "sequence"  
"last"  
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last"  
 "sequence"  
"last"  
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last" 
 
 "sequence" 

"last" 

To use these input formats in trainNetwork
workflows, convert the
data to "CB"
(channel, batch) or "CBT"
(channel,
batch, time) format using flattenLayer
.
If the HasStateInputs
property is 1
(true
), then the layer has two inputs with the names
"in"
and "hidden"
, which correspond to the input
data and hidden state, respectively. This additional input expects input with the format
"CB"
(channel, batch).
If the HasStateOutputs
property is 1
(true
), then the layer has two outputs with the names
"out"
and "hidden"
, which correspond to the output
data and hidden state, respectively. This additional output has output with the format
"CB"
(channel, batch).
References
[1] Glorot, Xavier, and Yoshua Bengio. "Understanding the Difficulty of Training Deep Feedforward Neural Networks." In Proceedings of the Thirteenth International Conference on Artificial Intelligence and Statistics, 249–356. Sardinia, Italy: AISTATS, 2010. https://proceedings.mlr.press/v9/glorot10a/glorot10a.pdf
[2] He, Kaiming, Xiangyu Zhang, Shaoqing Ren, and Jian Sun. "Delving Deep into Rectifiers: Surpassing HumanLevel Performance on ImageNet Classification." In 2015 IEEE International Conference on Computer Vision (ICCV), 1026–34. Santiago, Chile: IEEE, 2015. https://doi.org/10.1109/ICCV.2015.123
[3] Saxe, Andrew M., James L. McClelland, and Surya Ganguli. "Exact Solutions to the Nonlinear Dynamics of Learning in Deep Linear Neural Networks.” Preprint, submitted February 19, 2014. https://arxiv.org/abs/1312.6120.
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.
Usage notes and limitations:
GRU projected layer objects support generic C and C++ code generation only.
Version History
Introduced in R2023b
See Also
compressNetworkUsingProjection
 neuronPCA
 trainingOptions
 trainnet
 ProjectedLayer
 lstmProjectedLayer
 gruLayer
Topics
 Train Network with LSTM Projected Layer
 Compress Neural Network Using Projection
 Sequence Classification Using Deep Learning
 Sequence Classification Using 1D Convolutions
 Time Series Forecasting Using Deep Learning
 SequencetoSequence Classification Using Deep Learning
 SequencetoSequence Regression Using Deep Learning
 SequencetoOne Regression Using Deep Learning
 Classify Videos Using Deep Learning
 Long ShortTerm Memory Neural Networks
 List of Deep Learning Layers
 Deep Learning Tips and Tricks
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
 América Latina (Español)
 Canada (English)
 United States (English)
Europe
 Belgium (English)
 Denmark (English)
 Deutschland (Deutsch)
 España (Español)
 Finland (English)
 France (Français)
 Ireland (English)
 Italia (Italiano)
 Luxembourg (English)
 Netherlands (English)
 Norway (English)
 Österreich (Deutsch)
 Portugal (English)
 Sweden (English)
 Switzerland
 United Kingdom (English)