Warning: This API is deprecated and will be removed in a future version of TensorFlow after the replacement is stable.

StopGradient

public final class StopGradient

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.

Public Methods

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 wrapping a new StopGradient operation.
Output<T>
output()

Inherited Methods

Public Methods

public Output<T> asOutput ()

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.

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

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

Parameters
scope current scope
Returns
  • a new instance of StopGradient

public Output<T> output ()