BarrierTakeMany

public final class BarrierTakeMany

Takes the given number of completed elements from a barrier.

This operation concatenates completed-element component tensors along the 0th dimension to make a single component tensor.

Elements come out of the barrier when they are complete, and in the order in which they were placed into the barrier. The indices output provides information about the batch in which each element was originally inserted into the barrier.

Nested Classes

class BarrierTakeMany.Options Optional attributes for BarrierTakeMany  

Public Methods

static BarrierTakeMany.Options
allowSmallBatch(Boolean allowSmallBatch)
static BarrierTakeMany
create(Scope scope, Operand<String> handle, Operand<Integer> numElements, List<Class<?>> componentTypes, Options... options)
Factory method to create a class wrapping a new BarrierTakeMany operation.
Output<Long>
indices()
A one-dimensional tensor of indices, with length num_elems.
Output<String>
keys()
A one-dimensional tensor of keys, with length num_elements.
static BarrierTakeMany.Options
timeoutMs(Long timeoutMs)
List<Output<?>>
values()
One any-dimensional tensor per component in a barrier element.
static BarrierTakeMany.Options
waitForIncomplete(Boolean waitForIncomplete)

Inherited Methods

Public Methods

public static BarrierTakeMany.Options allowSmallBatch (Boolean allowSmallBatch)

Parameters
allowSmallBatch Allow to return less than num_elements items if barrier is already closed.

public static BarrierTakeMany create (Scope scope, Operand<String> handle, Operand<Integer> numElements, List<Class<?>> componentTypes, Options... options)

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

Parameters
scope current scope
handle The handle to a barrier.
numElements A single-element tensor containing the number of elements to take.
componentTypes The type of each component in a value.
options carries optional attributes values
Returns
  • a new instance of BarrierTakeMany

public Output<Long> indices ()

A one-dimensional tensor of indices, with length num_elems. These indices refer to the batch in which the values were placed into the barrier (starting with MIN_LONG and increasing with each BarrierInsertMany).

public Output<String> keys ()

A one-dimensional tensor of keys, with length num_elements.

public static BarrierTakeMany.Options timeoutMs (Long timeoutMs)

Parameters
timeoutMs If the queue is empty, this operation will block for up to timeout_ms milliseconds. Note: This option is not supported yet.

public List<Output<?>> values ()

One any-dimensional tensor per component in a barrier element. All values have length num_elements in the 0th dimension.

public static BarrierTakeMany.Options waitForIncomplete (Boolean waitForIncomplete)