Barrier

public final class Barrier

Defines a barrier that persists across different graph executions.

A barrier represents a key-value map, where each key is a string, and each value is a tuple of tensors.

At runtime, the barrier contains 'complete' and 'incomplete' elements. A complete element has defined tensors for all components of its value tuple, and may be accessed using BarrierTakeMany. An incomplete element has some undefined components in its value tuple, and may be updated using BarrierInsertMany.

Nested Classes

class Barrier.Options Optional attributes for Barrier  

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<TString>
asOutput()
Returns the symbolic handle of the tensor.
static Barrier.Options
capacity(Long capacity)
static Barrier.Options
container(String container)
static Barrier
create(Scope scope, List<Class<? extends TType>> componentTypes, Options... options)
Factory method to create a class wrapping a new Barrier operation.
Output<TString>
handle()
The handle to the barrier.
static Barrier.Options
shapes(List<Shape> shapes)
static Barrier.Options
sharedName(String sharedName)

Inherited Methods

org.tensorflow.op.RawOp
final boolean
equals(Object obj)
final int
hashCode()
Operation
op()
Return this unit of computation as a single Operation.
final String
toString()
boolean
equals(Object arg0)
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
org.tensorflow.op.Op
abstract ExecutionEnvironment
env()
Return the execution environment this op was created in.
abstract Operation
op()
Return this unit of computation as a single Operation.
org.tensorflow.Operand
abstract Output<TString>
asOutput()
Returns the symbolic handle of the tensor.
abstract TString
asTensor()
Returns the tensor at this operand.
abstract Shape
shape()
Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
abstract Class<TString>
type()
Returns the tensor type of this operand
org.tensorflow.ndarray.Shaped
abstract int
rank()
abstract Shape
shape()
abstract long
size()
Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "Barrier"

Public Methods

public Output<TString> asOutput ()

Returns the symbolic handle of the 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 Barrier.Options capacity (Long capacity)

Parameters
capacity The capacity of the barrier. The default capacity is MAX_INT32, which is the largest capacity of the underlying queue.

public static Barrier.Options container (String container)

Parameters
container If non-empty, this barrier is placed in the given container. Otherwise, a default container is used.

public static Barrier create (Scope scope, List<Class<? extends TType>> componentTypes, Options... options)

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

Parameters
scope current scope
componentTypes The type of each component in a value.
options carries optional attributes values
Returns
  • a new instance of Barrier

public Output<TString> handle ()

The handle to the barrier.

public static Barrier.Options shapes (List<Shape> shapes)

Parameters
shapes The shape of each component in a value. Each shape must be 1 in the first dimension. The length of this attr must be the same as the length of component_types.

public static Barrier.Options sharedName (String sharedName)

Parameters
sharedName If non-empty, this barrier will be shared under the given name across multiple sessions.