# Gradients

public class **Gradients** Adds operations to compute the partial derivatives of sum of `y`s w.r.t `x`s,
i.e., `d(y_1 + y_2 + ...)/dx_1, d(y_1 + y_2 + ...)/dx_2...`


If `Options.dx()` values are set, they are as the initial symbolic partial derivatives of some loss
function `L` w.r.t. `y`. `Options.dx()` must have the size of `y`.


If `Options.dx()` is not set, the implementation will use dx of `OnesLike` for all
shapes in `y`.


The partial derivatives are returned in output `dy`, with the size of `x`.


Example of usage:

    Gradients gradients = Gradients.create(scope, Arrays.asList(loss), Arrays.asList(w, b));
     
     Constant&lt;Float&gt; alpha = ops.constant(1.0f, Float.class);
     ApplyGradientDescent.create(scope, w, alpha, gradients.&lt;Float&gt;dy(0));
     ApplyGradientDescent.create(scope, b, alpha, gradients.&lt;Float&gt;dy(1));
     
<br />

<br />

<br />

<br />

<br />

### Nested Classes

|---|---|---|---|
| class | [Gradients.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients` |

### Public Methods

|---|---|
| static [Gradients](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<?>,%20java.lang.Iterable<?%20extends%20org.tensorflow.Operand<?>>,%20org.tensorflow.op.core.Gradients.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> y, Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> x, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options) options) Adds gradients computation ops to the graph according to scope. |
| static [Gradients](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#create(org.tensorflow.op.Scope,%20java.lang.Iterable<?%20extends%20org.tensorflow.Operand<?>>,%20java.lang.Iterable<?%20extends%20org.tensorflow.Operand<?>>,%20org.tensorflow.op.core.Gradients.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> y, Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> x, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options) options) Adds gradients computation ops to the graph according to scope. |
| static [Gradients.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options) | [dx](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#dx(java.lang.Iterable<?%20extends%20org.tensorflow.Operand<?>>))(Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> dx) |
| \<T\> [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [dy](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#dy(int))(int index) Returns a symbolic handle to one of the gradient operation output Warning: Does not check that the type of the tensor matches T. |
| List\<[Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<?\>\> | [dy](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#dy())() Partial derivatives of `y`s w.r.t. |
| Iterator\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> | [iterator](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#iterator())() |

### Inherited Methods

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() |

From interface java.lang.Iterable

|---|---|
| void | forEach(Consumer\<? super T\> arg0) |
| abstract Iterator\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> | iterator() |
| Spliterator\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> | spliterator() |

## Public Methods

#### public static [Gradients](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> y, Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> x, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options) options)

Adds gradients computation ops to the graph according to scope.

This is a simplified version of `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients#create(org.tensorflow.op.Scope,%20java.lang.Iterable<?%20extends%20org.tensorflow.Operand<?>>,%20java.lang.Iterable<?%20extends%20org.tensorflow.Operand<?>>,%20org.tensorflow.op.core.Gradients.Options...)` where
`y` is a single output.

<br />

##### Parameters

| scope | current graph scope |
| y | output of the function to derive |
| x | inputs of the function for which partial derivatives are computed |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of `Gradients`

##### Throws

| IllegalArgumentException | if execution environment is not a graph |
|---|---|

#### public static [Gradients](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> y, Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> x, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options) options)

Adds gradients computation ops to the graph according to scope.

##### Parameters

| scope | current graph scope |
| y | outputs of the function to derive |
| x | inputs of the function for which partial derivatives are computed |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of `Gradients`

##### Throws

| IllegalArgumentException | if execution environment is not a graph |
|---|---|

#### public static [Gradients.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Gradients.Options)
**dx**
(Iterable\<? extends [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\> dx)

<br />

##### Parameters

| dx | partial derivatives of some loss function `L` w.r.t. `y` |
|---|---|

##### Returns

- builder to add more options to this operation

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**dy**
(int index)

Returns a symbolic handle to one of the gradient operation output

Warning: Does not check that the type of the tensor matches T. It is recommended to call
this method with an explicit type parameter rather than letting it be inferred, e.g. `gradients.&lt;Float&gt;dy(0)`

<br />

##### Parameters

| index | The index of the output among the gradients added by this operation |
|---|---|

#### public List\<[Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<?\>\>
**dy**
()

Partial derivatives of `y`s w.r.t. `x`s, with the size of `x`

#### public Iterator\<[Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\>\>
**iterator**
()

<br />