org.tensorflow.op.core

Class StopGradient<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.core.StopGradient<T>

Type Parameters:

T - data type for output() output

All Implemented Interfaces:

Op, Operand<T>

@Operator
public final class StopGradient<T>
extends PrimitiveOp
implements Operand<T>

Stops gradient computation.

When executed in a graph, this op outputs its input tensor as-is.

When building ops to compute gradients, this op prevents the contribution of its inputs to be taken into account. Normally, the gradient generator adds ops to a graph to compute the derivatives of a specified 'loss' by recursively finding out inputs that contributed to its computation. If you insert this op in the graph it inputs are masked from the gradient generator. They are not taken into account for computing gradients.

This is useful any time you want to compute a value with TensorFlow but need to pretend that the value was a constant. Some examples include:

• The EM algorithm where the M-step should not involve backpropagation through the output of the E-step.
• Contrastive divergence training of Boltzmann machines where, when differentiating the energy function, the training must not backpropagate through the graph that generated the samples from the model.
• Adversarial training, where no backprop should happen through the adversarial example generation process.

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<T>	asOutput() Returns the symbolic handle of a tensor.
static <T> StopGradient<T>	create(Scope scope, Operand<T> input) Factory method to create a class to wrap a new StopGradient operation to the graph.
Output<T>	output()

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> StopGradient<T> create(Scope scope,
                                         Operand<T> input)

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

Parameters:

scope - current graph scope

input -

Returns:

a new instance of StopGradient

output

public Output<T> output()

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)