ML Community Day is November 9! Join us for updates from TensorFlow, JAX, and more Learn more

TemporaryVariable

public final class TemporaryVariable

Returns a tensor that may be mutated, but only persists within a single step.

This is an experimental op for internal use only and it is possible to use this op in unsafe ways. DO NOT USE unless you fully understand the risks.

It is the caller's responsibility to ensure that 'ref' is eventually passed to a matching 'DestroyTemporaryVariable' op after all other uses have completed.

Outputs a ref to the tensor state so it may be read or modified.

E.g. var = state_ops._temporary_variable([1, 2], types.float_) var_name = var.op.name var = state_ops.assign(var, [[4.0, 5.0]]) var = state_ops.assign_add(var, [[6.0, 7.0]]) final = state_ops._destroy_temporary_variable(var, var_name=var_name)

Nested Classes

class TemporaryVariable.Options Optional attributes for TemporaryVariable  

Public Methods

Output<T>
asOutput()
Returns the symbolic handle of a tensor.
static <T> TemporaryVariable<T>
create(Scope scope, Shape shape, Class<T> dtype, Options... options)
Factory method to create a class wrapping a new TemporaryVariable operation.
Output<T>
ref()
A reference to the variable tensor.
static TemporaryVariable.Options
varName(String varName)

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 TemporaryVariable<T> create (Scope scope, Shape shape, Class<T> dtype, Options... options)

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

Parameters
scope current scope
shape The shape of the variable tensor.
dtype The type of elements in the variable tensor.
options carries optional attributes values
Returns
  • a new instance of TemporaryVariable

public Output<T> ref ()

A reference to the variable tensor.

public static TemporaryVariable.Options varName (String varName)

Parameters
varName Overrides the name used for the temporary variable resource. Default value is the name of the 'TemporaryVariable' op (which is guaranteed unique).