org.tensorflow.op.io

Class QueueDequeueMany

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.io.QueueDequeueMany

All Implemented Interfaces:

Iterable<Operand<Object>>, Op

@Operator(group="io")
public final class QueueDequeueMany
extends PrimitiveOp
implements Iterable<Operand<Object>>

Dequeues `n` tuples of one or more tensors from the given queue.

If the queue is closed and there are fewer than `n` elements, then an OutOfRange error is returned.

This operation concatenates queue-element component tensors along the 0th dimension to make a single component tensor. All of the components in the dequeued tuple will have size `n` in the 0th dimension.

This operation has `k` outputs, where `k` is the number of components in the tuples stored in the given queue, and output `i` is the ith component of the dequeued tuple.

N.B. If the queue is empty, this operation will block until `n` elements have been dequeued (or 'timeout_ms' elapses, if specified).

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
List<Output<?>>	components() One or more tensors that were dequeued as a tuple.
static QueueDequeueMany	create(Scope scope, Operand<?> handle, Operand<Integer> n, List<Class<?>> componentTypes, QueueDequeueMany.Options... options) Factory method to create a class wrapping a new QueueDequeueMany operation.
Iterator<Operand<Object>>	iterator()
static QueueDequeueMany.Options	timeoutMs(Long timeoutMs)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

create

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

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

Parameters:

scope - current scope

handle - The handle to a queue.

n - The number of tuples to dequeue.

componentTypes - The type of each component in a tuple.

options - carries optional attributes values

Returns:

a new instance of QueueDequeueMany

timeoutMs

public static QueueDequeueMany.Options timeoutMs(Long timeoutMs)

Parameters:

timeoutMs - If the queue has fewer than n elements, this operation will block for up to timeout_ms milliseconds. Note: This option is not supported yet.

components

public List<Output<?>> components()

One or more tensors that were dequeued as a tuple.

iterator

public Iterator<Operand<Object>> iterator()

Specified by:

iterator in interface Iterable<Operand<Object>>