org.tensorflow.op.train

Class PreventGradient<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

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

Type Parameters:

T - data type for output() output

All Implemented Interfaces:

Op, Operand<T>

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

An identity op that triggers an error if a gradient is requested.

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

When building ops to compute gradients, the TensorFlow gradient system will return an error when trying to lookup the gradient of this op, because no gradient must ever be registered for this function. This op exists to prevent subtle bugs from silently returning unimplemented gradients in some corner cases.

Nested Class Summary

Nested Classes

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

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> PreventGradient<T>	create(Scope scope, Operand<T> input, PreventGradient.Options... options) Factory method to create a class wrapping a new PreventGradient operation.
static PreventGradient.Options	message(String message)
Output<T>	output() the same input tensor.

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> PreventGradient<T> create(Scope scope,
                                            Operand<T> input,
                                            PreventGradient.Options... options)

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

Parameters:

scope - current scope

input - any tensor.

options - carries optional attributes values

Returns:

a new instance of PreventGradient

message

public static PreventGradient.Options message(String message)

Parameters:

message - Will be printed in the error when anyone tries to differentiate this operation.

output

public Output<T> output()

the same input tensor.

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)