org.deeplearning4j.nn.layers.recurrent.GravesBidirectionalLSTM Maven / Gradle / Ivy
/*-
*
* * Copyright 2015 Skymind,Inc.
* *
* * Licensed under the Apache License, Version 2.0 (the "License");
* * you may not use this file except in compliance with the License.
* * You may obtain a copy of the License at
* *
* * http://www.apache.org/licenses/LICENSE-2.0
* *
* * Unless required by applicable law or agreed to in writing, software
* * distributed under the License is distributed on an "AS IS" BASIS,
* * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* * See the License for the specific language governing permissions and
* * limitations under the License.
*
*/
package org.deeplearning4j.nn.layers.recurrent;
import lombok.extern.slf4j.Slf4j;
import org.deeplearning4j.berkeley.Pair;
import org.deeplearning4j.nn.api.Layer;
import org.deeplearning4j.nn.api.MaskState;
import org.deeplearning4j.nn.conf.CacheMode;
import org.deeplearning4j.nn.conf.NeuralNetConfiguration;
import org.deeplearning4j.nn.gradient.DefaultGradient;
import org.deeplearning4j.nn.gradient.Gradient;
import org.deeplearning4j.nn.params.GravesBidirectionalLSTMParamInitializer;
import org.nd4j.linalg.api.ndarray.INDArray;
import java.util.Map;
/**
*
* RNN tutorial: http://deeplearning4j.org/usingrnns.html
* READ THIS FIRST
*
* Bdirectional LSTM layer implementation.
* Based on Graves: Supervised Sequence Labelling with Recurrent Neural Networks
* http://www.cs.toronto.edu/~graves/phd.pdf
* See also for full/vectorized equations (and a comparison to other LSTM variants):
* Greff et al. 2015, "LSTM: A Search Space Odyssey", pg11. This is the "vanilla" variant in said paper
* http://arxiv.org/pdf/1503.04069.pdf
*
* A high level description of bidirectional LSTM can be found from
* "Hybrid Speech Recognition with Deep Bidirectional LSTM"
* http://www.cs.toronto.edu/~graves/asru_2013.pdf
*
*
* @author Alex Black
* @author Benjamin Joseph
*/
@Slf4j
public class GravesBidirectionalLSTM
extends BaseRecurrentLayer {
protected FwdPassReturn cachedPassForward;
protected FwdPassReturn cachedPassBackward;
public GravesBidirectionalLSTM(NeuralNetConfiguration conf) {
super(conf);
}
public GravesBidirectionalLSTM(NeuralNetConfiguration conf, INDArray input) {
super(conf, input);
}
@Override
public Gradient gradient() {
throw new UnsupportedOperationException("Not supported " + layerId());
}
@Override
public Gradient calcGradient(Gradient layerError, INDArray activation) {
throw new UnsupportedOperationException("Not supported " + layerId());
}
@Override
public Pair backpropGradient(INDArray epsilon) {
return backpropGradientHelper(epsilon, false, -1);
}
@Override
public Pair tbpttBackpropGradient(INDArray epsilon, int tbpttBackwardLength) {
return backpropGradientHelper(epsilon, true, tbpttBackwardLength);
}
private Pair backpropGradientHelper(final INDArray epsilon, final boolean truncatedBPTT,
final int tbpttBackwardLength) {
if (truncatedBPTT) {
throw new UnsupportedOperationException(
"Time step for bidirectional RNN not supported: it has to run on a batch of data all at once "
+ layerId());
}
final FwdPassReturn fwdPass = activateHelperDirectional(true, null, null, true, true);
final Pair forwardsGradient = LSTMHelpers.backpropGradientHelper(this.conf,
this.layerConf().getGateActivationFn(), this.input,
getParam(GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_FORWARDS),
getParam(GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_FORWARDS), epsilon,
truncatedBPTT, tbpttBackwardLength, fwdPass, true,
GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_FORWARDS,
GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_FORWARDS,
GravesBidirectionalLSTMParamInitializer.BIAS_KEY_FORWARDS, gradientViews, maskArray, true, null);
final FwdPassReturn backPass = activateHelperDirectional(true, null, null, true, false);
final Pair backwardsGradient = LSTMHelpers.backpropGradientHelper(this.conf,
this.layerConf().getGateActivationFn(), this.input,
getParam(GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_BACKWARDS),
getParam(GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_BACKWARDS), epsilon,
truncatedBPTT, tbpttBackwardLength, backPass, false,
GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_BACKWARDS,
GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_BACKWARDS,
GravesBidirectionalLSTMParamInitializer.BIAS_KEY_BACKWARDS, gradientViews, maskArray, true, null);
//merge the gradient, which is key value pair of String,INDArray
//the keys for forwards and backwards should be different
final Gradient combinedGradient = new DefaultGradient();
for (Map.Entry entry : forwardsGradient.getFirst().gradientForVariable().entrySet()) {
combinedGradient.setGradientFor(entry.getKey(), entry.getValue());
}
for (Map.Entry entry : backwardsGradient.getFirst().gradientForVariable().entrySet()) {
combinedGradient.setGradientFor(entry.getKey(), entry.getValue());
}
final Gradient correctOrderedGradient = new DefaultGradient();
for (final String key : params.keySet()) {
correctOrderedGradient.setGradientFor(key, combinedGradient.getGradientFor(key));
}
final INDArray forwardEpsilon = forwardsGradient.getSecond();
final INDArray backwardsEpsilon = backwardsGradient.getSecond();
final INDArray combinedEpsilon = forwardEpsilon.addi(backwardsEpsilon);
//sum the errors that were back-propagated
return new Pair<>(correctOrderedGradient, combinedEpsilon);
}
@Override
public INDArray preOutput(INDArray x) {
return activate(x, true);
}
@Override
public INDArray preOutput(INDArray x, boolean training) {
return activate(x, training);
}
@Override
public INDArray activate(INDArray input, boolean training) {
setInput(input);
return activateOutput(training, false);
}
@Override
public INDArray activate(INDArray input) {
setInput(input);
return activateOutput(true, false);
}
@Override
public INDArray activate(boolean training) {
return activateOutput(training, false);
}
@Override
public INDArray activate() {
return activateOutput(false, false);
}
private INDArray activateOutput(final boolean training, boolean forBackprop) {
final FwdPassReturn forwardsEval;
final FwdPassReturn backwardsEval;
if (cacheMode != CacheMode.NONE && cachedPassForward != null && cachedPassBackward != null) {
// restore from cache. but this coll will probably never happen
forwardsEval = cachedPassForward;
backwardsEval = cachedPassBackward;
cachedPassBackward = null;
cachedPassForward = null;
} else {
forwardsEval = LSTMHelpers.activateHelper(this, this.conf, this.layerConf().getGateActivationFn(),
this.input, getParam(GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_FORWARDS),
getParam(GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_FORWARDS),
getParam(GravesBidirectionalLSTMParamInitializer.BIAS_KEY_FORWARDS), training, null, null,
forBackprop || (cacheMode != CacheMode.NONE && training), true,
GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_FORWARDS, maskArray, true,
null, forBackprop ? cacheMode : CacheMode.NONE);
backwardsEval = LSTMHelpers.activateHelper(this, this.conf, this.layerConf().getGateActivationFn(),
this.input,
getParam(GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_BACKWARDS),
getParam(GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_BACKWARDS),
getParam(GravesBidirectionalLSTMParamInitializer.BIAS_KEY_BACKWARDS), training, null, null,
forBackprop || (cacheMode != CacheMode.NONE && training), false,
GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_BACKWARDS, maskArray, true,
null, forBackprop ? cacheMode : CacheMode.NONE);
cachedPassForward = forwardsEval;
cachedPassBackward = backwardsEval;
}
//sum outputs
final INDArray fwdOutput = forwardsEval.fwdPassOutput;
final INDArray backOutput = backwardsEval.fwdPassOutput;
// if we're on ff pass & cache enabled - we should not modify fwdOutput, and for backprop pass - we don't care
final INDArray totalOutput = training && cacheMode != CacheMode.NONE && !forBackprop ? fwdOutput.add(backOutput)
: fwdOutput.addi(backOutput);
return totalOutput;
}
private FwdPassReturn activateHelperDirectional(final boolean training, final INDArray prevOutputActivations,
final INDArray prevMemCellState, boolean forBackprop, boolean forwards) {
if (cacheMode == null)
cacheMode = CacheMode.NONE;
if (cacheMode != CacheMode.NONE && forwards && forBackprop && cachedPassForward != null) {
FwdPassReturn ret = cachedPassForward;
cachedPassForward = null;
return ret;
} else if (cacheMode != CacheMode.NONE && !forwards && forBackprop) {
FwdPassReturn ret = cachedPassBackward;
cachedPassBackward = null;
return ret;
} else {
String recurrentKey = GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_FORWARDS;
String inputKey = GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_FORWARDS;
String biasKey = GravesBidirectionalLSTMParamInitializer.BIAS_KEY_FORWARDS;
if (!forwards) {
recurrentKey = GravesBidirectionalLSTMParamInitializer.RECURRENT_WEIGHT_KEY_BACKWARDS;
inputKey = GravesBidirectionalLSTMParamInitializer.INPUT_WEIGHT_KEY_BACKWARDS;
biasKey = GravesBidirectionalLSTMParamInitializer.BIAS_KEY_BACKWARDS;
}
return LSTMHelpers.activateHelper(this, this.conf, this.layerConf().getGateActivationFn(), this.input,
getParam(recurrentKey), getParam(inputKey), getParam(biasKey), training,
prevOutputActivations, prevMemCellState, forBackprop, forwards, inputKey, maskArray, true,
null, forBackprop ? cacheMode : CacheMode.NONE);
}
}
@Override
public INDArray activationMean() {
return activate();
}
@Override
public Type type() {
return Type.RECURRENT;
}
@Override
public Layer transpose() {
throw new UnsupportedOperationException("Not supported " + layerId());
}
@Override
public boolean isPretrainLayer() {
return false;
}
@Override
public double calcL2(boolean backpropParamsOnly) {
if (!conf.isUseRegularization())
return 0.0;
double l2Sum = 0.0;
for (Map.Entry entry : paramTable().entrySet()) {
double l2 = conf.getL2ByParam(entry.getKey());
if (l2 > 0) {
double norm2 = getParam(entry.getKey()).norm2Number().doubleValue();
l2Sum += 0.5 * l2 * norm2 * norm2;
}
}
return l2Sum;
}
@Override
public double calcL1(boolean backpropParamsOnly) {
if (!conf.isUseRegularization())
return 0.0;
double l1Sum = 0.0;
for (Map.Entry entry : paramTable().entrySet()) {
double l1 = conf.getL1ByParam(entry.getKey());
if (l1 > 0) {
double norm1 = getParam(entry.getKey()).norm1Number().doubleValue();
l1Sum += l1 * norm1;
}
}
return l1Sum;
}
@Override
public INDArray rnnTimeStep(INDArray input) {
throw new UnsupportedOperationException(
"you can not time step a bidirectional RNN, it has to run on a batch of data all at once "
+ layerId());
}
@Override
public INDArray rnnActivateUsingStoredState(INDArray input, boolean training, boolean storeLastForTBPTT) {
throw new UnsupportedOperationException(
"Cannot set stored state: bidirectional RNNs don't have stored state " + layerId());
}
@Override
public Pair feedForwardMaskArray(INDArray maskArray, MaskState currentMaskState,
int minibatchSize) {
//Bidirectional RNNs operate differently to standard RNNs from a masking perspective
//Specifically, the masks are applied regardless of the mask state
//For example, input -> RNN -> Bidirectional-RNN: we should still mask the activations and errors in the bi-RNN
// even though the normal RNN has marked the current mask state as 'passthrough'
//Consequently, the mask is marked as active again
this.maskArray = maskArray;
this.maskState = currentMaskState;
return new Pair<>(maskArray, MaskState.Active);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy