Package org.tensorflow.op.train

Class ApplyGradientDescent<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.train.ApplyGradientDescent<T>

Type Parameters:

T - data type for out() output

All Implemented Interfaces:

Op, Operand<T>

@Operator(group="train")
public final class ApplyGradientDescent<T>
extends PrimitiveOp
implements Operand<T>

Update '*var' by subtracting 'alpha' * 'delta' from it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplyGradientDescent.Options	Optional attributes for ApplyGradientDescent

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method	Description
Output<T>	asOutput()	Returns the symbolic handle of a tensor.
static <T> ApplyGradientDescent<T>	create(Scope scope, Operand<T> var, Operand<T> alpha, Operand<T> delta, ApplyGradientDescent.Options... options)	Factory method to create a class to wrap a new ApplyGradientDescent operation to the graph.
Output<T>	out()	Same as "var".
static ApplyGradientDescent.Options	useLocking(java.lang.Boolean useLocking)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Method Detail

create

public static <T> ApplyGradientDescent<T> create(Scope scope,
                                                 Operand<T> var,
                                                 Operand<T> alpha,
                                                 Operand<T> delta,
                                                 ApplyGradientDescent.Options... options)

Factory method to create a class to wrap a new ApplyGradientDescent operation to the graph.

Parameters:

scope - current graph scope

var - Should be from a Variable().

alpha - Scaling factor. Must be a scalar.

delta - The change.

options - carries optional attributes values

Returns:

a new instance of ApplyGradientDescent

useLocking

public static ApplyGradientDescent.Options useLocking(java.lang.Boolean useLocking)

Parameters:

useLocking - If `True`, the subtraction will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

out

public Output<T> out()

Same as "var".

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

Specified by:

asOutput in interface Operand<T>

See Also:

OperationBuilder.addInput(Output)