PyTorch原始碼解讀之torch.utils.data.DataLoader
PyTorch中資料讀取的一個重要介面是torch.utils.data.DataLoader，該介面定義在dataloader.py指令碼中，只要是用PyTorch來訓練模型基本都會用到該介面，該介面主要用來將自定義的資料讀取介面的輸出或者PyTorch已有的資料讀取介面的輸入按照batch size封裝成Tensor，後續只需要再包裝成Variable即可作為模型的輸入，因此該介面有點承上啟下的作用，比較重要。這篇部落格介紹該介面的原始碼，主要包含DataLoader和DataLoaderIter兩個類。
dataloader.py指令碼的的github地址：https://github.com/pytorch/pytorch/blob/master/torch/utils/data/dataloader.py
DataLoader類原始碼如下。先看看__init__中的幾個重要的輸入：1、dataset，這個就是PyTorch已有的資料讀取介面（比如torchvision.datasets.ImageFolder）或者自定義的資料介面的輸出，該輸出要麼是torch.utils.data.Dataset類的物件，要麼是繼承自torch.utils.data.Dataset類的自定義類的物件。2、batch_size，根據具體情況設定即可。3、shuffle，一般在訓練資料中會採用。4、collate_fn，是用來處理不同情況下的輸入dataset的封裝，一般採用預設即可，除非你自定義的資料讀取輸出非常少見。5、batch_sampler，從註釋可以看出，其和batch_size、shuffle等引數是互斥的，一般採用預設。6、sampler，從程式碼可以看出，其和shuffle是互斥的，一般預設即可。7、num_workers，從註釋可以看出這個引數必須大於等於0，0的話表示資料匯入在主程序中進行，其他大於0的數表示通過多個程序來匯入資料，可以加快資料匯入速度。8、pin_memory，註釋寫得很清楚了： pin_memory (bool, optional): If True, the data loader will copy tensors into CUDA pinned memory before returning them. 也就是一個數據拷貝的問題。9、timeout，是用來設定資料讀取的超時時間的，但超過這個時間還沒讀取到資料的話就會報錯。
在__init__
train_data=torch.utils.data.DataLoader(...)for i, (input, target) in enumerate(train_data): ... 就會呼叫DataLoader類的
__iter__方法，__iter__方法就一行程式碼：return DataLoaderIter(self)，輸入正是DataLoader類的屬性。因此當呼叫__iter__方法的時候就牽扯到另外一個類：DataLoaderIter，接下來介紹。
class DataLoader(object):
"""
Data loader. Combines a dataset and a sampler, and provides
single- or multi-process iterators over the dataset.
Arguments:
dataset (Dataset): dataset from which to load the data.
batch_size (int, optional): how many samples per batch to load
(default: 1).
shuffle (bool, optional): set to ``True`` to have the data reshuffled
at every epoch (default: False).
sampler (Sampler, optional): defines the strategy to draw samples from
the dataset. If specified, ``shuffle`` must be False.
batch_sampler (Sampler, optional): like sampler, but returns a batch of
indices at a time. Mutually exclusive with batch_size, shuffle,
sampler, and drop_last.
num_workers (int, optional): how many subprocesses to use for data
loading. 0 means that the data will be loaded in the main process.
(default: 0)
collate_fn (callable, optional): merges a list of samples to form a mini-batch.
pin_memory (bool, optional): If ``True``, the data loader will copy tensors
into CUDA pinned memory before returning them.
drop_last (bool, optional): set to ``True`` to drop the last incomplete batch,
if the dataset size is not divisible by the batch size. If ``False`` and
the size of dataset is not divisible by the batch size, then the last batch
will be smaller. (default: False)
timeout (numeric, optional): if positive, the timeout value for collecting a batch
from workers. Should always be non-negative. (default: 0)
worker_init_fn (callable, optional): If not None, this will be called on each
worker subprocess with the worker id as input, after seeding and before data
loading. (default: None)
"""
def __init__(self, dataset, batch_size=1, shuffle=False, sampler=None, batch_sampler=None,
num_workers=0, collate_fn=default_collate, pin_memory=False, drop_last=False,
timeout=0, worker_init_fn=None):
self.dataset = dataset
self.batch_size = batch_size
self.num_workers = num_workers
self.collate_fn = collate_fn
self.pin_memory = pin_memory
self.drop_last = drop_last
self.timeout = timeout
self.worker_init_fn = worker_init_fn
if timeout < 0:
raise ValueError('timeout option should be non-negative')
if batch_sampler is not None:
if batch_size > 1 or shuffle or sampler is not None or drop_last:
raise ValueError('batch_sampler is mutually exclusive with '
'batch_size, shuffle, sampler, and drop_last')
if sampler is not None and shuffle:
raise ValueError('sampler is mutually exclusive with shuffle')
if self.num_workers < 0:
raise ValueError('num_workers cannot be negative; '
'use num_workers=0 to disable multiprocessing.')
if batch_sampler is None:
if sampler is None:
if shuffle:
sampler = RandomSampler(dataset)
else:
sampler = SequentialSampler(dataset)
batch_sampler = BatchSampler(sampler, batch_size, drop_last)
self.sampler = sampler
self.batch_sampler = batch_sampler
def __iter__(self):
return DataLoaderIter(self)
def __len__(self):
return len(self.batch_sampler)DataLoaderIter類原始碼如下。self.index_queue = multiprocessing.SimpleQueue()中的multiprocessing是Python中的多程序管理包，而threading則是Python中的多執行緒管理包，二者很大一部分的介面用法類似。還是照例先看看__init__，前面部分都是一些賦值操作，比較特殊的是self.sample_iter = iter(self.batch_sampler)，得到的self.sample_iter可以通過next(self.sample_iter)來獲取batch size個數據的index。self.rcvd_idx表示讀取到的一個batch資料的index，初始化為0，該值在迭代讀取資料的時候會用到。if self.num_workers語句是針對多程序或單程序的情況進行初始化，如果不是設定為多程序讀取資料，那麼就不需要這些初始化操作，後面會介紹單程序資料讀取。在if語句中通過multiprocessing.SimpleQueue()類建立了一個簡單的佇列物件。multiprocessing.Process類就是構造程序的類，這裡根據設定的程序數來啟動，然後賦值給self.workers。接下來的一個for迴圈就通過呼叫start方法依次啟動self.workers中的程序。接下來關於self.pin_memory的判斷語句，該判斷語句內部主要是實現了多執行緒操作。self.pin_memory的含義在前面已經介紹過了，當為True的時候，就會把資料拷到CUDA中。self.data_queue = queue.Queue()是通過Python的queue模組初始化得到一個先進先出的佇列（queue模組也可以初始化得到先進後出的佇列，需要用queue.LifoQueue()初始化），queue模組主要應用在多執行緒讀取資料中。在threading.Thread的args引數中，第一個引數in_data就是一個程序的資料，一個程序中不同執行緒的資料也是通過佇列來維護的，這裡採用的是Python的queue模組來初始化得到一個佇列：queue.Queue()。初始化結束後，就會呼叫__next__方法，接下來介紹。
總的來說，如果設定為多程序讀取資料，那麼就會採用佇列的方式來讀，如果不是採用多程序來讀取資料，那就採用普通方式來讀。
class DataLoaderIter(object):
"Iterates once over the DataLoader's dataset, as specified by the sampler"
def __init__(self, loader):
self.dataset = loader.dataset
self.collate_fn = loader.collate_fn
self.batch_sampler = loader.batch_sampler
self.num_workers = loader.num_workers
self.pin_memory = loader.pin_memory and torch.cuda.is_available()
self.timeout = loader.timeout
self.done_event = threading.Event()
self.sample_iter = iter(self.batch_sampler)
if self.num_workers > 0:
self.worker_init_fn = loader.worker_init_fn
self.index_queue = multiprocessing.SimpleQueue()
self.worker_result_queue = multiprocessing.SimpleQueue()
self.batches_outstanding = 0
self.worker_pids_set = False
self.shutdown = False
self.send_idx = 0
self.rcvd_idx = 0
self.reorder_dict = {}
base_seed = torch.LongTensor(1).random_()[0]
self.workers = [
multiprocessing.Process(
target=_worker_loop,
args=(self.dataset, self.index_queue, self.worker_result_queue, self.collate_fn,
base_seed + i, self.worker_init_fn, i))
for i in range(self.num_workers)]
if self.pin_memory or self.timeout > 0:
self.data_queue = queue.Queue()
self.worker_manager_thread = threading.Thread(
target=_worker_manager_loop,
args=(self.worker_result_queue, self.data_queue, self.done_event, self.pin_memory,
torch.cuda.current_device()))
self.worker_manager_thread.daemon = True
self.worker_manager_thread.start()
else:
self.data_queue = self.worker_result_queue
for w in self.workers:
w.daemon = True # ensure that the worker exits on process exit
w.start()
_update_worker_pids(id(self), tuple(w.pid for w in self.workers))
_set_SIGCHLD_handler()
self.worker_pids_set = True
# prime the prefetch loop
for _ in range(2 * self.num_workers):
self._put_indices()DataLoaderIter類的__next__方法如下，包含3個if語句和1個while語句。
第一個if語句是用來處理self.num_workers等於0的情況，也就是不採用多程序進行資料讀取，可以看出在這個if語句中先通過indices = next(self.sample_iter)獲取長度為batch size的列表：indices，這個列表的每個值表示一個batch中每個資料的index，每執行一次next操作都會讀取一批長度為batch size的indices列表。然後通過self.collate_fn函式將batch size個tuple（每個tuple長度為2，其中第一個值是資料，Tensor型別，第二個值是標籤，int型別）封裝成一個list，這個list長度為2，兩個值都是Tensor，一個是batch size個數據組成的FloatTensor，另一個是batch size個標籤組成的LongTensor。所以簡單講self.collate_fn函式就是將batch size個分散的Tensor封裝成一個Tensor。batch = pin_memory_batch(batch)中pin_memory_batch函式的作用就是將輸入batch的每個Tensor都拷貝到CUDA中，該函式後面會詳細介紹。
第二個if語句是判斷當前想要讀取的batch的index(self.rcvd_idx)是否之前已經讀出來過(已讀出來的index和batch資料儲存在self.reorder_dict字典中，可以結合最後的while語句一起看，因為self.reorder_dict字典的更新是在最後的while語句中），如果之前已經讀取過了，就根據這個index從reorder_dict字典中彈出對應的資料。最後返回batch資料的時候是 return self._process_next_batch(batch)，該方法後面會詳細介紹。主要做是獲取下一個batch的資料index資訊。
第三個if語句，self.batches_outstanding的值在前面初始中呼叫self._put_indices()方法時修改了，所以假設你的程序數self.num_workers設定為3，那麼這裡self.batches_outstanding就是3*2=6，可具體看self._put_indices()方法。
最後的while迴圈就是真正用來從佇列中讀取資料的操作，最主要的就是idx, batch = self._get_batch()，通過呼叫_get_batch()方法來讀取，後面有介紹，簡單講就是呼叫了佇列的get方法得到下一個batch的資料，得到的batch一般是長度為2的列表，列表的兩個值都是Tensor，分別表示資料（是一個batch的）和標籤。_get_batch()方法除了返回batch資料外，還得到另一個輸出：idx，這個輸出表示batch的index，這個if idx != self.rcvd_idx條件語句表示如果你讀取到的batch的index不等於當前想要的index:selg,rcvd_idx，那麼就將讀取到的資料儲存在字典self.reorder_dict中：self.reorder_dict[idx] = batch，然後繼續讀取資料，直到讀取到的資料的index等於self.rcvd_idx。
def __next__(self):
if self.num_workers == 0: # same-process loading
indices = next(self.sample_iter) # may raise StopIteration
batch = self.collate_fn([self.dataset[i] for i in indices])
if self.pin_memory:
batch = pin_memory_batch(batch)
return batch
# check if the next sample has already been generated
if self.rcvd_idx in self.reorder_dict:
batch = self.reorder_dict.pop(self.rcvd_idx)
return self._process_next_batch(batch)
if self.batches_outstanding == 0:
self._shutdown_workers()
raise StopIteration
while True:
assert (not self.shutdown and self.batches_outstanding > 0)
idx, batch = self._get_batch()
self.batches_outstanding -= 1
if idx != self.rcvd_idx:
# store out-of-order samples
self.reorder_dict[idx] = batch
continue
return self._process_next_batch(batch)pin_memory_batch函式不是定義在DataLoader類或DataLoaderIter類中。該函式主要是對batch中的Tensor執行batch.pin_memory()操作，這裡的很多條件語句只是用來判斷batch的型別，假如batch是一個列表，列表中的每個值是Tensor，那麼就會執行 elif isinstance(batch, collections.Sequence):這個條件，從而遍歷該列表中的每個Tensor，然後執行第一個條件語句的內容： return batch.pin_memory()
def pin_memory_batch(batch):
if torch.is_tensor(batch):
return batch.pin_memory()
elif isinstance(batch, string_classes):
return batch
elif isinstance(batch, collections.Mapping):
return {k: pin_memory_batch(sample) for k, sample in batch.items()}
elif isinstance(batch, collections.Sequence):
return [pin_memory_batch(sample) for sample in batch]
else:
return batchDataloaderIter類的_get_batch方法。主要根據是否設定了超時時間來操作，如果超過指定的超時時間後沒有從佇列中讀到資料就報錯，如果不設定超時時間且一致沒有從佇列中讀到資料，那麼就會一直卡著且不報錯，這部分是PyTorch後來修的一個bug。
def _get_batch(self):
if self.timeout > 0:
try:
return self.data_queue.get(True, self.timeout)
except queue.Empty:
raise RuntimeError('DataLoader timed out after {} seconds'.format(self.timeout))
else:
return self.data_queue.get()DataLoaderIter類的_process_next_batch方法。首先對self.rcvd_idx進行加一，也就是更新下下一個要讀取的batch資料的index。然後呼叫_put_indices()方法獲取下一個batch的每個資料的index。
def _process_next_batch(self, batch):
self.rcvd_idx += 1
self._put_indices()
if isinstance(batch, ExceptionWrapper):
raise batch.exc_type(batch.exc_msg)
return batchDataLoaderIter類的_put_indices方法。該方法主要實現從self.sample_iter中讀取下一個batch資料中每個資料的index：indices = next(self.sample_iter, None)，注意這裡的index和前面idx是不一樣的，這裡的index是一個batch中每個資料的index，idx是一個batch的index；然後將讀取到的index通過呼叫queue物件的put方法壓到佇列self.index_queue中：self.index_queue.put((self.send_idx, indices))
def _put_indices(self):
assert self.batches_outstanding < 2 * self.num_workers
indices = next(self.sample_iter, None)
if indices is None:
return
self.index_queue.put((self.send_idx, indices))
self.batches_outstanding += 1
self.send_idx += 1