儲存 TensorDict 和 tensorclass 物件¶

雖然我們可以直接使用 save() 來儲存 tensordict，但這會建立一個包含整個資料結構內容的檔案。可以很容易地想象到某些情況下的效率不高！

TensorDict 的序列化 API 主要依賴於 MemoryMappedTensor，它被用來獨立地將張量寫入磁碟，並使用一個模仿 TensorDict 結構的資料結構。

TensorDict 的序列化速度可能比 PyTorch 的 save() （依賴於 pickle）快一個數量級。本文件將解釋如何使用 TensorDict 建立和互動儲存在磁碟上的資料。

儲存記憶體對映的 TensorDict¶

當 tensordict 被轉儲為 mmap 資料結構時，每個條目對應一個單獨的 *.memmap 檔案，目錄結構由鍵結構決定：通常，巢狀鍵對應子目錄。

將資料結構儲存為結構化的記憶體對映張量集合具有以下優點：

儲存的資料可以部分載入。如果一個大型模型已儲存到磁碟，但只需要將其中一部分權重載入到單獨指令碼中建立的模組中，那麼只有這些權重會被載入到記憶體中。
儲存資料是安全的：使用 pickle 庫序列化大型資料結構可能不安全，因為反序列化會執行任意程式碼。TensorDict 的載入 API 只讀取儲存的 json 檔案和磁碟上儲存的 memorybuffer 中預先選定的欄位。
儲存速度快：因為資料被寫入多個獨立的檔案，我們可以透過啟動多個併發執行緒來分攤 IO 開銷，每個執行緒都可以訪問自己的專用檔案。
儲存資料的結構很明顯：目錄樹指示了資料的內容。

但是，此方法也有一些缺點：

並非所有資料型別都可以儲存。tensorclass 允許儲存任何非張量資料：如果這些資料可以在 json 檔案中表示，則會使用 json 格式。否則，非張量資料將作為回退，透過 save() 獨立儲存。可以使用 NonTensorData 類在常規 TensorDict 例項中表示非張量資料。

tensordict 的記憶體對映 API 依賴於四個核心方法：memmap_()、memmap()、memmap_like() 和 load_memmap()。

memmap_() 和 memmap() 方法將資料寫入磁碟，是否修改包含資料的 tensordict 例項。這些方法可用於序列化模型到磁碟（我們使用多個執行緒來加快序列化速度）。

>>> model = nn.Transformer()
>>> weights = TensorDict.from_module(model)
>>> weights_disk = weights.memmap("/path/to/saved/dir", num_threads=32)
>>> new_weights = TensorDict.load_memmap("/path/to/saved/dir")
>>> assert (weights_disk == new_weights).all()

memmap_like() 用於需要預分配到磁碟的資料集，典型用法為：

>>> def make_datum(): # used for illustration purposes
...    return TensorDict({"image": torch.randint(255, (3, 64, 64)), "label": 0}, batch_size=[])
>>> dataset_size = 1_000_000
>>> datum = make_datum() # creates a single instance of a TensorDict datapoint
>>> data = datum.expand(dataset_size) # does NOT require more memory usage than datum, since it's only a view on datum!
>>> data_disk = data.memmap_like("/path/to/data")  # creates the two memory-mapped tensors on disk
>>> del data # data is not needed anymore

如上所示，在將 `TensorDict` 的條目轉換為 `MemoryMappedTensor` 時，可以控制記憶體對映在磁碟上的儲存位置，以便它們可以持久化並稍後載入。另一方面，也可以使用檔案系統。要使用此功能，只需在上述三個序列化方法中省略 `prefix` 引數。

當指定了 `prefix` 時，資料結構遵循 TensorDict 的結構。

>>> import torch
>>> from tensordict import TensorDict
>>> td = TensorDict({"a": torch.rand(10), "b": {"c": torch.rand(10)}}, [10])
>>> td.memmap_(prefix="tensordict")

會產生以下目錄結構：

tensordict
├── a.memmap
├── b
│   ├── c.memmap
│   └── meta.json
└── meta.json

meta.json 檔案包含重建 tensordict 的所有相關資訊，例如裝置、批次大小，以及 tensordict 的子型別。這意味著 load_memmap() 將能夠重構複雜的巢狀結構，其中子 tensordict 的型別與父級不同。

>>> from tensordict import TensorDict, tensorclass, TensorDictBase
>>> from tensordict.utils import print_directory_tree
>>> import torch
>>> import tempfile
>>> td_list = [TensorDict({"item": i}, batch_size=[]) for i in range(4)]
>>> @tensorclass
... class MyClass:
...     data: torch.Tensor
...     metadata: str
>>> tc = MyClass(torch.randn(3), metadata="some text", batch_size=[])
>>> data = TensorDict({"td_list": torch.stack(td_list), "tensorclass": tc}, [])
>>> with tempfile.TemporaryDirectory() as tempdir:
...     data.memmap_(tempdir)
...
...     loaded_data = TensorDictBase.load_memmap(tempdir)
...     assert (loaded_data == data).all()
...     print_directory_tree(tempdir)
tmpzy1jcaoq/
    tensorclass/
        _tensordict/
            data.memmap
            meta.json
        meta.json
    td_list/
        0/
            item.memmap
            meta.json
        1/
            item.memmap
            meta.json
        3/
            item.memmap
            meta.json
        2/
            item.memmap
            meta.json
        meta.json
    meta.json

處理現有的 `MemoryMappedTensor`¶

如果 `TensorDict` 已包含 `MemoryMappedTensor` 條目，則有幾種可能的行為。

如果未指定 `prefix` 並且兩次呼叫 `memmap()`，則生成的 `TensorDict` 將包含與原始資料相同的資料。

>>> td = TensorDict({"a": 1}, [])
>>> td0 = td.memmap()
>>> td1 = td0.memmap()
>>> td0["a"] is td1["a"]
True

如果指定了 `prefix` 並且與現有 `MemoryMappedTensor` 例項的 `prefix` 不同，則會引發異常，除非傳遞了 `copy_existing=True`。

>>> with tempfile.TemporaryDirectory() as tmpdir_0:
...     td0 = td.memmap(tmpdir_0)
...     td0 = td.memmap(tmpdir_0)  # works, results are just overwritten
...     with tempfile.TemporaryDirectory() as tmpdir_1:
...         td1 = td0.memmap(tmpdir_1)
...         td_load = TensorDict.load_memmap(tmpdir_1)  # works!
...     assert (td_load == td).all()
...     with tempfile.TemporaryDirectory() as tmpdir_1:
...         td_load = TensorDict.load_memmap(tmpdir_1)  # breaks!

此功能旨在防止使用者無意中將記憶體對映的張量從一個位置複製到另一個位置。

TorchSnapshot 相容性¶

警告

由於 torchsnapshot 的維護已停止。因此，我們不會為 tensordict 與該庫的相容性實現新功能。

TensorDict 與 PyTorch 的檢查點庫 torchsnapshot 相容。TorchSnapshot 將獨立儲存您的每個張量，其資料結構模仿您的 tensordict 或 tensorclass 的結構。此外，TensorDict 已內建了在不將完整張量載入到記憶體的情況下，儲存和載入大型資料集的工具：換句話說，tensordict + torchsnapshot 的組合使得可以將一個大小為數百 GB 的張量載入到預先分配的 `MemmapTensor` 中，而無需將其作為一個大塊載入到 RAM 中。

主要有兩種用例：儲存和載入適合記憶體的 tensordict，以及使用 `MemmapTensor` 儲存和載入儲存在磁碟上的 tensordict。

通用用例：記憶體載入¶

如果目標 tensordict 未預先分配，則此方法適用。它提供了靈活性（您可以將任何 tensordict 載入到您的 tensordict 中，無需提前瞭解其內容），並且此方法的編碼比其他方法稍微簡單一些。但是，如果您的張量非常大且不適合記憶體，此方法可能會失敗。此外，它不允許您直接載入到您選擇的裝置上。

儲存操作需要記住的兩個主要命令是：

>>> state = {"state": tensordict_source}
>>> snapshot = torchsnapshot.Snapshot.take(app_state=state, path="/path/to/my/snapshot")

要載入到目標 tensordict，您可以直接載入快照並更新 tensordict。在此底層，此方法將呼叫 `tensordict_target.load_state_dict(state_dict)`，這意味著 `state_dict` 將首先完全載入到記憶體中，然後載入到目標 tensordict。

>>> snapshot = Snapshot(path="/path/to/my/snapshot")
>>> state_target = {"state": tensordict_target}
>>> snapshot.restore(app_state=state_target)

這是一個完整的示例：

>>> import uuid
>>> import torchsnapshot
>>> from tensordict import TensorDict
>>> import torch
>>>
>>> tensordict_source = TensorDict({"a": torch.randn(3), "b": {"c": torch.randn(3)}}, [])
>>> state = {"state": tensordict}
>>> path = f"/tmp/{uuid.uuid4()}"
>>> snapshot = torchsnapshot.Snapshot.take(app_state=state, path=path)
>>> # later
>>> snapshot = torchsnapshot.Snapshot(path=path)
>>> tensordict2 = TensorDict()
>>> target_state = {
>>>     "state": tensordict2
>>> }
>>> snapshot.restore(app_state=target_state)
>>> assert (tensordict == tensordict2).all()

儲存和載入大型資料集¶

如果資料集太大而無法放入記憶體，上述方法可能會輕易失敗。我們利用 torchsnapshot 的功能，將張量分塊載入到其預先分配的目的地。這需要您知道目標資料將具有什麼形狀、裝置等，並且資料將駐留在何處，但這是能夠檢查點您的模型或資料載入的一個小小的代價！

與前面的示例相比，我們將不使用 `TensorDict` 的 `load_state_dict()` 方法，而是使用從目標物件獲取的 `state_dict`，並用儲存的資料重新填充它。

同樣，只需兩行程式碼即可儲存資料：

>>> app_state = {
...     "state": torchsnapshot.StateDict(tensordict=tensordict_source.state_dict(keep_vars=True))
... }
>>> snapshot = torchsnapshot.Snapshot.take(app_state=app_state, path="/path/to/my/snapshot")

我們使用了 `torchsnapshot.StateDict`，並明確呼叫了 `my_tensordict_source.state_dict(keep_vars=True)`，這與前面的示例不同。現在，要將其載入到目標 tensordict：

>>> snapshot = Snapshot(path="/path/to/my/snapshot")
>>> app_state = {
...     "state": torchsnapshot.StateDict(tensordict=tensordict_target.state_dict(keep_vars=True))
... }
>>> snapshot.restore(app_state=app_state)

在此示例中，載入完全由 torchsnapshot 處理，即沒有呼叫 `TensorDict.load_state_dict()`。

注意

這有兩個重要的含義：

由於 `LazyStackedTensorDict.state_dict()`（以及其他懶惰 tensordict 類）在執行某些操作後返回資料的副本，因此載入到 state_dict 不會更新原始類。但是，由於支援 `state_dict()` 操作，因此不會引發錯誤。
同樣，由於 state_dict 是就地更新的，但 tensordict 沒有使用 `TensorDict.update()` 或 `TensorDict.set()` 進行更新，因此目標 tensordict 中缺少鍵將不會被注意到。