utils.PrefetchingIter.PrefetchingIter Class Reference

List of all members.

Public Member Functions
def	__del__
def	__init__
def	getdata
def	getindex
def	getlabel
def	getpad
def	iter_next
def	next
def	provide_data
def	provide_label
def	reset
Public Attributes
	batch_size
	current_batch
	data_ready
	data_taken
	iters
	n_iter
	next_batch
	prefetch_threads
	rename_data
	rename_label
	started

---

Detailed Description

Base class for prefetching iterators. Takes one or more DataIters (
or any class with "reset" and "next" methods) and combine them with
prefetching. For example:

Parameters
----------
iters : DataIter or list of DataIter
    one or more DataIters (or any class with "reset" and "next" methods)
rename_data : None or list of dict
    i-th element is a renaming map for i-th iter, in the form of
    {'original_name' : 'new_name'}. Should have one entry for each entry
    in iter[i].provide_data
rename_label : None or list of dict
    Similar to rename_data

Examples
--------
iter = PrefetchingIter([NDArrayIter({'data': X1}), NDArrayIter({'data': X2})],
                       rename_data=[{'data': 'data1'}, {'data': 'data2'}])

Definition at line 15 of file PrefetchingIter.py.

---

Constructor & Destructor Documentation

def utils.PrefetchingIter.PrefetchingIter.__init__	(		self,
			iters,
			rename_data = None,
			rename_label = None
	)

Definition at line 36 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.__del__

(

self

)

Definition at line 71 of file PrefetchingIter.py.

---

Member Function Documentation

def utils.PrefetchingIter.PrefetchingIter.getdata

(

self

)

Definition at line 131 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.getindex

(

self

)

Definition at line 137 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.getlabel

(

self

)

Definition at line 134 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.getpad

(

self

)

Definition at line 140 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.iter_next

(

self

)

Definition at line 112 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.next

(

self

)

Definition at line 125 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.provide_data

(

self

)

The name and shape of data provided by this iterator

Definition at line 79 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.provide_label

(

self

)

The name and shape of label provided by this iterator

Definition at line 91 of file PrefetchingIter.py.

def utils.PrefetchingIter.PrefetchingIter.reset

(

self

)

Definition at line 102 of file PrefetchingIter.py.

---

Member Data Documentation

utils::PrefetchingIter.PrefetchingIter::batch_size

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::current_batch

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::data_ready

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::data_taken

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::iters

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::n_iter

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::next_batch

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::prefetch_threads

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::rename_data

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::rename_label

Definition at line 36 of file PrefetchingIter.py.

utils::PrefetchingIter.PrefetchingIter::started

Definition at line 36 of file PrefetchingIter.py.

---

The documentation for this class was generated from the following file:

• PrefetchingIter.py