# XlaSendTPUEmbeddingGradients

public final class **XlaSendTPUEmbeddingGradients** An op that performs gradient updates of embedding tables.


The gradients argument is a TensorList having the same length and shapes as the
return value of XlaRecvTPUEmbeddingActivations, but contains gradients of the
model's loss with respect to the embedding activations. The embedding tables are
updated from these gradients via the optimizer specified in the
TPUEmbeddingConfiguration proto given to tpu.initialize_system.

<br />

### Public Methods

|---|---|
| static [XlaSendTPUEmbeddingGradients](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/XlaSendTPUEmbeddingGradients) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/XlaSendTPUEmbeddingGradients#create(org.tensorflow.op.Scope,%20java.lang.Iterable<org.tensorflow.Operand<java.lang.Float>>,%20java.lang.Iterable<org.tensorflow.Operand<java.lang.Float>>,%20org.tensorflow.Operand<?>,%20java.lang.String))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, Iterable\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\>\> gradients, Iterable\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\>\> learningRates, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> deduplicationData, String config) Factory method to create a class wrapping a new XlaSendTPUEmbeddingGradients operation. |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [XlaSendTPUEmbeddingGradients](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/XlaSendTPUEmbeddingGradients)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, Iterable\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\>\> gradients, Iterable\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<Float\>\> learningRates, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> deduplicationData, String config)

Factory method to create a class wrapping a new XlaSendTPUEmbeddingGradients operation.

##### Parameters

| scope | current scope |
| gradients | A TensorList of gradients with which to update embedding tables. |
| learningRates | A TensorList of learning rates used for updating the embedding tables via the optimizer. The length of the TensorList must be equal to the number of dynamic learning rate tags specified in the TPUEmbeddingConfiguration proto. |
| deduplicationData | A Tensor with type=DT_VARIANT containing the deduplication data. The tensor is an XLA nested tuple containing N elements (where N is the ratio of the number of embedding to tensor cores per TPU chip). Each element of the nested tuple is a tuple of rank 1 tensors. Each tensor either contains indices (DT_UINT32) for embedding lookup on the TensorCore or weights (DT_FLOAT) to apply to the output of the embedding lookup operation. |
| config | Serialized TPUEmbeddingConfiguration proto. |
|---|---|

##### Returns

- a new instance of XlaSendTPUEmbeddingGradients