<!--
{
  "availability" : [
    "iOS: 15.4.0 -",
    "iPadOS: 15.4.0 -",
    "macCatalyst: 15.4.0 -",
    "macOS: 12.3.0 -",
    "tvOS: 15.4.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "MetalPerformanceShadersGraph",
  "identifier" : "/documentation/MetalPerformanceShadersGraph/MPSGraph/LSTMGradients(_:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:descriptor:name:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "Metal Performance Shaders Graph",
      "MetalPerformanceShadersGraph"
    ],
    "preciseIdentifier" : "c:objc(cs)MPSGraph(im)LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:descriptor:name:"
  },
  "title" : "LSTMGradients(_:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:descriptor:name:)"
}
-->

# LSTMGradients(_:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:descriptor:name:)

Creates an LSTM gradient operation and returns the gradient tensor values.

```
func LSTMGradients(_ source: MPSGraphTensor, recurrentWeight: MPSGraphTensor, sourceGradient: MPSGraphTensor, zState: MPSGraphTensor, cellOutputFwd: MPSGraphTensor, inputWeight: MPSGraphTensor?, bias: MPSGraphTensor?, initState: MPSGraphTensor?, initCell: MPSGraphTensor?, descriptor: MPSGraphLSTMDescriptor, name: String?) -> [MPSGraphTensor]
```

## Parameters

`source`

A tensor containing the source data `x[t]`  with the data layout [T,N,I]. In case `inputWeight = nil` and `bidirectional = NO` then the layout is [T,N,4H] and for `inputWeight = nil` and `bidirectional = YES` the layout is [T,N,8H].

`recurrentWeight`

A tensor containing the recurrent weights `R`. For `bidirectional` the layout is [2,4H,H] and otherwise it is [4H,H].

`sourceGradient`

The input gradient, that is the gradient of a tensor with respect to the first output of the forward pass.

`zState`

The third output of
[`LSTM(_:recurrentWeight:inputWeight:bias:initState:initCell:descriptor:name:)`](/documentation/MetalPerformanceShadersGraph/MPSGraph/LSTM(_:recurrentWeight:inputWeight:bias:initState:initCell:descriptor:name:))
with `descriptor.training = YES`.

`cellOutputFwd`

The second output of
[`LSTM(_:recurrentWeight:inputWeight:bias:initState:initCell:descriptor:name:)`](/documentation/MetalPerformanceShadersGraph/MPSGraph/LSTM(_:recurrentWeight:inputWeight:bias:initState:initCell:descriptor:name:))
with `descriptor.training = YES` or `descriptor.produceCell = YES`.

`inputWeight`

A tensor containing the input weights matrix `W` - optional, if missing the operation assumes a diagonal unit-matrix. For `bidirectional` the layout is [8H,I] and otherwise it is [4H,I].

`bias`

A tensor containing the bias `b` - optional, if missing the operation assumes zeroes. For `bidirectional` the layout is [8H] and otherwise it is [4H].

`initState`

The initial internal state of the LSTM `h[-1]` - optional, if missing the operation assumes zeroes.
For `bidirectional` the layout is [N,2H] and otherwise it is [N,H].

`initCell`

The initial internal cell of the LSTM `h[-1]` - optional, if missing the operation assumes zeroes.
For `bidirectional` the layout is [N,2H] and otherwise it is [N,H].

`descriptor`

A descriptor that defines the parameters for the LSTM operation.

`name`

The name for the operation.

## Return Value

A valid `MPSGraphTensor` array containing gradients for each input tensor, except for `sourceGradient` and `mask`.
In case an input is nil, no gradient will be returned for it.
The order of the gradients will be: for `source`, for `recurrentWeight`, for `inputWeight`, for `bias`, for `initState` and for `initCell`.

## Discussion

For details of this operation and parameters, refer to documentation of
[`LSTM(_:recurrentWeight:inputWeight:bias:initState:initCell:mask:peephole:descriptor:name:)`](/documentation/MetalPerformanceShadersGraph/MPSGraph/LSTM(_:recurrentWeight:inputWeight:bias:initState:initCell:mask:peephole:descriptor:name:)).

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)