org.tensorflow.op.core

Class TemporaryVariable<T>

java.lang.Object

org.tensorflow.op.PrimitiveOp

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

Type Parameters:

T - data type for ref() output

All Implemented Interfaces:

Op, Operand<T>

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

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 Class Summary

Nested Classes

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

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> TemporaryVariable<T>	create(Scope scope, Shape shape, Class<T> dtype, TemporaryVariable.Options... options) Factory method to create a class to wrap a new TemporaryVariable operation to the graph.
Output<T>	ref() A reference to the variable tensor.
static TemporaryVariable.Options	varName(String varName)

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

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

Parameters:

scope - current graph 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

varName

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).

ref

public Output<T> ref()

A reference to the variable 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)