Variable

Variable based on resource handles.

See the Variables Guide for a high-level overview.

A variable allows you to maintain state across subsequent calls to Session.run(). The variable constructors require an initial value for the variable, which can be a tensor of any type and shape. The initial value defines the type and shape of the variable. After construction, the type and shape of the variable are fixed. The value can be changed using one of the assignment methods.

Just like any tensor, variables can be used as inputs for other ops in the graph. Additionally, all the operators overloaded for tensors are carried over to variables, so you can also add nodes to the graph by just doing arithmetic on variables.

Unlike the Python API, the Scala API uses resource variables that have well-defined semantics. Each usage of a resource variable in a TensorFlow graph adds a read operation to the graph. The tensors returned by a read operation are guaranteed to see all modifications to the value of the variable which happen in any operation on which the read depends on (either directly, indirectly, or via a control dependency) and guaranteed to not see any modification to the value of the variable from operations that depend on the read operation. Updates from operations that have no dependency relationship to the read operation might or might not be visible to read. For example, if there is more than one assignment to a resource variable in a single Session.run() call there is a well-defined value for each operation which uses the variable's value if the assignments and the read are connected by edges in the graph.

Linear Supertypes

Serializable, Serializable, Product, Equals, VariableLike, OutputConvertible, Serializable, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def assign(value: Output, name: String = "Assign"): Output

Creates an op that assigns the provided value to this variable and returns its value.
Creates an op that assigns the provided value to this variable and returns its value.
value
Value to assign the variable to.
name
Name for created op.
returns
Variable value read op, after the assignment.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... )
def assignAdd(value: Output, name: String = "AssignAdd"): Output

Creates an op that adds the provided value to the current value of the variable and returns its value.
Creates an op that adds the provided value to the current value of the variable and returns its value.
value
Value to add to the current variable value.
name
Name for created op.
returns
Variable value read op, after the addition.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... ) @throws( ... )
def assignScatter(indices: Output, values: Output, name: String = "AssignScatter"): Output

Creates an op that applies updates the provided sparse value updates to this variable and returns its value.
Creates an op that applies updates the provided sparse value updates to this variable and returns its value.
indices
Indices corresponding to the values used for the update.
values
Values to use for updating, corresponding to the provided indices.
name
Name for created op.
returns
Variable value read op, after the addition.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... ) @throws( ... )
def assignScatterAdd(indices: Output, values: Output, name: String = "AssignScatterAdd"): Output

Creates an op that adds the provided sparse value to the current value of the variable and returns its value.
Creates an op that adds the provided sparse value to the current value of the variable and returns its value.
indices
Indices corresponding to the values being added.
values
Values to be added, corresponding to the provided indices.
name
Name for created op.
returns
Variable value read op, after the addition.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... ) @throws( ... )
def assignScatterSub(indices: Output, values: Output, name: String = "AssignScatterSub"): Output

Creates an op that subtracts the provided sparse value from the current value of the variable and returns its value.
Creates an op that subtracts the provided sparse value from the current value of the variable and returns its value.
indices
Indices corresponding to the values being subtracted.
values
Values to be subtracted, corresponding to the provided indices.
name
Name for created op.
returns
Variable value read op, after the subtraction.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... ) @throws( ... )
def assignSub(value: Output, name: String = "AssignAdd"): Output

Creates an op that subtracts the provided value from the current value of the variable and returns its value.
Creates an op that subtracts the provided value from the current value of the variable and returns its value.
value
Value to subtract from the current variable value.
name
Name for created op.
returns
Variable value read op, after the subtraction.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... ) @throws( ... )
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dataType: types.DataType

Data type of this variable.
Data type of this variable.

Definition Classes
Variable → VariableLike
val device: String

Device where this variable resides.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Definition Classes
Variable → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def gather(indices: Output, name: String = "Gather"): Output

Creates an op that reads the value of this variable sparsely, using the provided indices.
Creates an op that reads the value of this variable sparsely, using the provided indices.
This method should be used when there are multiple reads, or when it is desirable to read the value only after some condition is true.
indices
Indices to use for the sparse read.
name
Name for the created op.
returns
Created op.

Definition Classes
Variable → VariableLike
Annotations
@throws( ... )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val graph: core.Graph

Graph where this variable is defined.
Graph where this variable is defined.

Definition Classes
Variable → VariableLike
def hashCode(): Int

Definition Classes
Variable → AnyRef → Any

val initializedValue: Output

Value of the initialized variable.

Value of the initialized variable. You should use this instead of the variable itself to initialize another variable with a value that depends on the value of this variable.

Example:

// Initialize `v` with random values, and then use `initializedValue` to guarantee that `v` has been initialized
// before its value is used to initialize `w`. The random tensor will only be sampled once.
val v = tf.variable("v", FLOAT32, Shape(10, 40), tf.RandomTruncatedNormalInitializer())
val w = tf.variable("w", initializer = tf.ConstantInitializer(v.initializedValue * 2.0))

Definition Classes: Variable → VariableLike

val initializer: api.Op

Op responsible for initializing this variable.
Op responsible for initializing this variable.

Definition Classes
Variable → VariableLike
val isInitialized: Output

Op output that is true when the variable has been initialized and false otherwise.
Op output that is true when the variable has been initialized and false otherwise.

Definition Classes
Variable → VariableLike
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String

Name of this variable.
Name of this variable.

Definition Classes
Variable → VariableLike
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val op: api.Op

Op corresponding to this variable.
def read(name: String = "Read"): Output

Creates an op that reads the value of this variable.
Creates an op that reads the value of this variable.
This method should be used when there are multiple reads, or when it is desirable to read the value only after some condition is true.
The returned value may be different from that of value depending on the device being used, the control dependencies, etc.
returns
Created op.

Definition Classes
Variable → VariableLike
val shape: core.Shape

Shape of this variable.
Shape of this variable.

Definition Classes
Variable → VariableLike
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toOutput: Output

Converts this variable to an op output.
Converts this variable to an op output. This function simply returns an op corresponding to the variable value.

Definition Classes
VariableLike → OutputConvertible
def toProto(exportScope: String): VariableDef

Alias for toVariableDef.
def toProto: VariableDef

Converts this object to its corresponding ProtoBuf object.
Converts this object to its corresponding ProtoBuf object.
returns
ProtoBuf object corresponding to this object.

Definition Classes
Variable → Serializable
def toString(): String

Definition Classes
Variable → AnyRef → Any
def toVariableDef(exportScope: String): VariableDef

Convert this object to its corresponding ProtoBuf object.
Convert this object to its corresponding ProtoBuf object.
exportScope
Optional string specifying the name scope to remove. Only the ops within this name scope will be included in the resulting ProtoBuf object and the export scope will be stripped from their names to allow for easy import into new name scopes.
returns
ProtoBuf object corresponding to this object.
val value: Output

Cached op which reads the last value of this variable.
Cached op which reads the last value of this variable.
You can not assign a new value to the returned tensor as it is not a reference to the variable.
NOTE: You usually do not need to call this method directly, as all ops that use variables do so by internally converting them to tensors.

Definition Classes
Variable → VariableLike
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package variables

case class Variable extends Serializable with VariableLike with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def assign(value: Output, name: String = "Assign"): Output

def assignAdd(value: Output, name: String = "AssignAdd"): Output

def assignScatter(indices: Output, values: Output, name: String = "AssignScatter"): Output

def assignScatterAdd(indices: Output, values: Output, name: String = "AssignScatterAdd"): Output

def assignScatterSub(indices: Output, values: Output, name: String = "AssignScatterSub"): Output

def assignSub(value: Output, name: String = "AssignAdd"): Output

def clone(): AnyRef

val dataType: types.DataType

val device: String

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def gather(indices: Output, name: String = "Gather"): Output

final def getClass(): Class[_]

val graph: core.Graph

def hashCode(): Int

val initializedValue: Output

val initializer: api.Op

val isInitialized: Output

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val op: api.Op

def read(name: String = "Read"): Output

val shape: core.Shape

final def synchronized[T0](arg0: ⇒ T0): T0

def toOutput: Output

def toProto(exportScope: String): VariableDef

def toProto: VariableDef

def toString(): String

def toVariableDef(exportScope: String): VariableDef

val value: Output

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from VariableLike

Inherited from OutputConvertible

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped