org.deeplearning4j.parallelism

Class MagicQueue

java.lang.Object

org.deeplearning4j.parallelism.MagicQueue

All Implemented Interfaces:

Iterable<org.nd4j.linalg.dataset.DataSet>, Collection<org.nd4j.linalg.dataset.DataSet>, BlockingQueue<org.nd4j.linalg.dataset.DataSet>, Queue<org.nd4j.linalg.dataset.DataSet>

public class MagicQueue
extends Object
implements BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Limited Queue implementation, suited for multi-gpu prefetch. Basic idea is simple: DataSets are coming from DataSetIterator, and their device location is unknown. So, for better performance DataSets should be transparently moved to the devices where they will be used later, and this should be done in background.

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MagicQueue.Builder
static class	MagicQueue.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected List<LinkedBlockingQueue<org.nd4j.linalg.dataset.DataSet>>	backingQueues
protected int	capacity
protected AtomicLong	cntGet
protected AtomicLong	cntPut
protected List<org.deeplearning4j.parallelism.MagicQueue.QueueHandler>	handlers
protected AtomicInteger	interleavedCounter
protected AtomicInteger	interleavedPutter
protected MagicQueue.Mode	mode
protected AtomicInteger	nextBucket
protected int	numberOfBuckets

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MagicQueue(int numberOfFlows, int capacity)

Method Summary

Modifier and Type	Method and Description
boolean	add(org.nd4j.linalg.dataset.DataSet dataSet)
boolean	addAll(Collection<? extends org.nd4j.linalg.dataset.DataSet> c)
void	clear()
boolean	contains(Object o) This method isn't supported
boolean	containsAll(Collection<?> c) This method isn't supported
int	drainTo(Collection<? super org.nd4j.linalg.dataset.DataSet> c)
int	drainTo(Collection<? super org.nd4j.linalg.dataset.DataSet> c, int maxElements)
org.nd4j.linalg.dataset.DataSet	element()
boolean	isEmpty()
Iterator<org.nd4j.linalg.dataset.DataSet>	iterator() This method isn't supported
boolean	offer(org.nd4j.linalg.dataset.DataSet dataSet)
boolean	offer(org.nd4j.linalg.dataset.DataSet dataSet, long timeout, TimeUnit unit)
org.nd4j.linalg.dataset.DataSet	peek()
org.nd4j.linalg.dataset.DataSet	poll() This method is supposed to be called from managed thread, attached to specific device.
org.nd4j.linalg.dataset.DataSet	poll(long time, TimeUnit timeUnit) This method is supposed to be called from managed thread, attached to specific device.
void	put(org.nd4j.linalg.dataset.DataSet dataSet)
int	remainingCapacity()
org.nd4j.linalg.dataset.DataSet	remove()
boolean	remove(Object o) This method isn't supported
boolean	removeAll(Collection<?> c) This method isn't supported
boolean	retainAll(Collection<?> c) This method isn't supported
int	size() This method returns average queue size for all devices
protected int	size(int deviceId)
org.nd4j.linalg.dataset.DataSet	take()
Object[]	toArray() This method isn't supported
<T> T[]	toArray(T[] a) This method isn't supported

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

backingQueues

protected final List<LinkedBlockingQueue<org.nd4j.linalg.dataset.DataSet>> backingQueues

nextBucket

protected final AtomicInteger nextBucket

numberOfBuckets

protected final int numberOfBuckets

handlers

protected final List<org.deeplearning4j.parallelism.MagicQueue.QueueHandler> handlers

capacity

protected int capacity

mode

protected MagicQueue.Mode mode

interleavedCounter

protected AtomicInteger interleavedCounter

interleavedPutter

protected AtomicInteger interleavedPutter

cntPut

protected AtomicLong cntPut

cntGet

protected AtomicLong cntGet

Constructor Detail

MagicQueue

protected MagicQueue(int numberOfFlows,
                     int capacity)

Method Detail

size

public int size()

This method returns average queue size for all devices

Specified by:

size in interface Collection<org.nd4j.linalg.dataset.DataSet>

Returns:

size

protected int size(int deviceId)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<org.nd4j.linalg.dataset.DataSet>

contains

public boolean contains(Object o)

This method isn't supported

Specified by:

contains in interface Collection<org.nd4j.linalg.dataset.DataSet>

Specified by:

contains in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Parameters:

o -

Returns:

drainTo

public int drainTo(Collection<? super org.nd4j.linalg.dataset.DataSet> c)

Specified by:

drainTo in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

drainTo

public int drainTo(Collection<? super org.nd4j.linalg.dataset.DataSet> c,
                   int maxElements)

Specified by:

drainTo in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

iterator

public Iterator<org.nd4j.linalg.dataset.DataSet> iterator()

This method isn't supported

Specified by:

iterator in interface Iterable<org.nd4j.linalg.dataset.DataSet>

Specified by:

iterator in interface Collection<org.nd4j.linalg.dataset.DataSet>

Returns:

toArray

public Object[] toArray()

This method isn't supported

Specified by:

toArray in interface Collection<org.nd4j.linalg.dataset.DataSet>

Returns:

toArray

public <T> T[] toArray(T[] a)

This method isn't supported

Specified by:

toArray in interface Collection<org.nd4j.linalg.dataset.DataSet>

Type Parameters:

T -

Parameters:

a -

Returns:

add

public boolean add(org.nd4j.linalg.dataset.DataSet dataSet)

Specified by:

add in interface Collection<org.nd4j.linalg.dataset.DataSet>

Specified by:

add in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Specified by:

add in interface Queue<org.nd4j.linalg.dataset.DataSet>

remove

public boolean remove(Object o)

This method isn't supported

Specified by:

remove in interface Collection<org.nd4j.linalg.dataset.DataSet>

Specified by:

remove in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Parameters:

o -

Returns:

containsAll

public boolean containsAll(Collection<?> c)

This method isn't supported

Specified by:

containsAll in interface Collection<org.nd4j.linalg.dataset.DataSet>

Parameters:

c -

Returns:

addAll

public boolean addAll(Collection<? extends org.nd4j.linalg.dataset.DataSet> c)

Specified by:

addAll in interface Collection<org.nd4j.linalg.dataset.DataSet>

removeAll

public boolean removeAll(Collection<?> c)

This method isn't supported

Specified by:

removeAll in interface Collection<org.nd4j.linalg.dataset.DataSet>

Parameters:

c -

Returns:

retainAll

public boolean retainAll(Collection<?> c)

This method isn't supported

Specified by:

retainAll in interface Collection<org.nd4j.linalg.dataset.DataSet>

Parameters:

c -

Returns:

clear

public void clear()

Specified by:

clear in interface Collection<org.nd4j.linalg.dataset.DataSet>

offer

public boolean offer(org.nd4j.linalg.dataset.DataSet dataSet)

Specified by:

offer in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Specified by:

offer in interface Queue<org.nd4j.linalg.dataset.DataSet>

put

public void put(org.nd4j.linalg.dataset.DataSet dataSet)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Throws:

InterruptedException

offer

public boolean offer(org.nd4j.linalg.dataset.DataSet dataSet,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Throws:

InterruptedException

take

public org.nd4j.linalg.dataset.DataSet take()
                                     throws InterruptedException

Specified by:

take in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Throws:

InterruptedException

remove

public org.nd4j.linalg.dataset.DataSet remove()

Specified by:

remove in interface Queue<org.nd4j.linalg.dataset.DataSet>

poll

public org.nd4j.linalg.dataset.DataSet poll(long time,
                                            TimeUnit timeUnit)
                                     throws InterruptedException

This method is supposed to be called from managed thread, attached to specific device. It returns 1 DataSet element from head of the queue, and deletes that element from Queue. If queue is empty, Please note: if there's nothing available in Queue - NULL will be returned

Specified by:

poll in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

Parameters:

time - time to wait for something appear in queue

timeUnit - TimeUnit for time param

Returns:

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<org.nd4j.linalg.dataset.DataSet>

poll

public org.nd4j.linalg.dataset.DataSet poll()

This method is supposed to be called from managed thread, attached to specific device. It returns 1 DataSet element from head of the queue, and deletes that element from Queue Please note: if there's nothing available in Queue - NULL will be returned

Specified by:

poll in interface Queue<org.nd4j.linalg.dataset.DataSet>

Returns:

element

public org.nd4j.linalg.dataset.DataSet element()

Specified by:

element in interface Queue<org.nd4j.linalg.dataset.DataSet>

peek

public org.nd4j.linalg.dataset.DataSet peek()

Specified by:

peek in interface Queue<org.nd4j.linalg.dataset.DataSet>