VariableLike

Abstract Value Members

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

Annotations
@throws( ... )
abstract 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.

Annotations
@throws( ... ) @throws( ... )
abstract 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.

Annotations
@throws( ... ) @throws( ... )
abstract 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.

Annotations
@throws( ... ) @throws( ... )
abstract 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.

Annotations
@throws( ... ) @throws( ... )
abstract 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.

Annotations
@throws( ... ) @throws( ... )
abstract val dataType: types.DataType

Data type of this variable.
abstract 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.

Annotations
@throws( ... )
abstract val graph: core.Graph

Graph where this variable is defined.

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

abstract val initializer: Op

Op responsible for initializing this variable.
abstract val isInitialized: Output

Op output that is true when the variable has been initialized and false otherwise.
abstract val name: String

Name of this variable.
abstract 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.
abstract val shape: core.Shape

Shape of this variable.
abstract val value: Output

Returns a cached op which reads the last value of this partitioned variable.
Returns a cached op which reads the last value of this partitioned variable.
You can not assign a new value to the returned tensor as it is not a reference to the variable.
The returned op output will not inherit the control dependencies from the scope where the value is used, which is equivalent behavior to that of getting the value of a 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.

Concrete 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 clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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 toString(): String

Definition Classes
AnyRef → Any
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

trait VariableLike extends OutputConvertible

Abstract Value Members

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

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

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

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

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

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

abstract val dataType: types.DataType

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

abstract val graph: core.Graph

abstract val initializedValue: Output

abstract val initializer: Op

abstract val isInitialized: Output

abstract val name: String

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

abstract val shape: core.Shape

abstract val value: Output

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toOutput: Output

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from OutputConvertible

Inherited from AnyRef

Inherited from Any

Ungrouped