RewardData¶

類 torchrl.data.RewardData(input_ids: 'torch.Tensor', attention_mask: 'torch.Tensor', rewards: 'Optional[torch.Tensor]' = None, end_scores: 'Optional[torch.Tensor]' = None, *, batch_size, device=None, names=None)[原始碼]¶

屬性 device: device¶: 檢索 tensorclass 的裝置型別。

dumps(prefix: str | None = None, copy_existing: bool =False, *, num_threads: int =0, return_early: bool =False, share_non_tensor: bool =False) → T¶

將 tensordict 儲存到磁碟。

此函式是 memmap() 的代理。

類方法 fields()¶

返回描述此資料類的欄位的元組。

接受資料類或其一個例項。元組元素型別為 Field。

類方法 from_tensordict(tensordict, non_tensordict=None, safe=True)¶

用於例項化新的 tensor class 物件的 tensor class 包裝器。

引數:

tensordict (TensorDict) – 張量型別的字典
non_tensordict (dict) – 包含非張量和巢狀 tensor class 物件的字典

get(key: NestedKey, *args, **kwargs)¶

獲取與輸入鍵關聯的值。

引數:

key (str, tuple of str) – 要查詢的鍵。如果是字串元組，則相當於鏈式呼叫 getattr。
default – 如果在 tensorclass 中找不到鍵，則返回預設值。

返回值:

與輸入鍵關聯的值

類方法 load(prefix: str | Path, *args, **kwargs) → T¶

從磁碟載入 tensordict。

此類方法是 load_memmap() 的代理。

load_(prefix: str | Path, *args, **kwargs)¶

在當前 tensordict 中從磁碟載入 tensordict。

此方法是 load_memmap_() 的代理。

類方法 load_memmap(prefix: str | Path, device: torch.device | None = None, non_blocking: bool =False, *, out: TensorDictBase | None = None) → T¶

從磁碟載入記憶體對映 tensordict。

引數:

prefix (str 或 資料夾路徑) – 應從中獲取已儲存 tensordict 的資料夾路徑。
device (torch.device 或 等效型別, 可選) – 如果提供，資料將非同步轉換到該裝置。支援 “meta” 裝置，在此情況下，資料不會被載入，而是建立一組空的“meta”張量。這有助於瞭解模型整體大小和結構，而無需實際開啟任何檔案。
non_blocking (bool, 可選) – 如果為 True，則在將張量載入到裝置後不會呼叫 synchronize。預設為 False。
out (TensorDictBase, 可選) – 可選的 tensordict，資料應寫入其中。

示例

>>> from tensordict import TensorDict
>>> td = TensorDict.fromkeys(["a", "b", "c", ("nested", "e")], 0)
>>> td.memmap("./saved_td")
>>> td_load = TensorDict.load_memmap("./saved_td")
>>> assert (td == td_load).all()

此方法還允許載入巢狀的 tensordict。

示例

>>> nested = TensorDict.load_memmap("./saved_td/nested")
>>> assert nested["e"] == 0

tensordict 也可以載入到“meta”裝置上，或者作為偽張量載入。

示例

>>> import tempfile
>>> td = TensorDict({"a": torch.zeros(()), "b": {"c": torch.zeros(())}})
>>> with tempfile.TemporaryDirectory() as path:
...     td.save(path)
...     td_load = TensorDict.load_memmap(path, device="meta")
...     print("meta:", td_load)
...     from torch._subclasses import FakeTensorMode
...     with FakeTensorMode():
...         td_load = TensorDict.load_memmap(path)
...         print("fake:", td_load)
meta: TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=meta, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([]), device=meta, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=meta,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=meta,
    is_shared=False)
fake: TensorDict(
    fields={
        a: FakeTensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: FakeTensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=cpu,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=cpu,
    is_shared=False)

load_state_dict(state_dict: dict[str, Any], strict=True, assign=False, from_flatten=False)¶: 嘗試就地載入 state_dict 到目標 tensorclass。

memmap(prefix: str | None = None, copy_existing: bool =False, *, num_threads: int =0, return_early: bool =False, share_non_tensor: bool =False, existsok: bool =True) → T¶

將所有張量寫入新 tensordict 中的對應記憶體對映張量。

引數:

prefix (str) – 記憶體對映張量將被儲存的目錄字首。目錄樹結構將模仿 tensordict 的結構。
copy_existing (bool) – 如果 False（預設），則如果 tensordict 中的某個條目已是儲存在磁碟上且有關聯檔案的張量，但未按照 prefix 儲存到正確位置，則將引發異常。如果為 True，則任何現有張量將被複制到新位置。

關鍵字引數:

num_threads (int, 可選) – 用於寫入 memmap 張量的執行緒數。預設為 0。
return_early (bool, 可選) – 如果為 True 且 num_threads>0，此方法將返回 tensordict 的 Future。
share_non_tensor (bool, 可選) – 如果為 True，則非張量資料將在程序之間共享，並且在單節點內任何 worker 上的寫入操作（例如就地更新或 set）將更新所有其他 worker 上的值。如果非張量葉子數量很高（例如，共享大量非張量資料堆疊），這可能導致 OOM 或類似錯誤。預設為 False。
existsok (bool, 可選) – 如果為 False，則如果同一路徑下已存在張量，將引發異常。預設為 True。

然後 TensorDict 將被鎖定，這意味著任何非就地寫入操作（例如，重新命名、設定或移除條目）都將丟擲異常。一旦 tensordict 解鎖，記憶體對映屬性將變為 False，因為不再保證跨程序的身份一致性。

返回值:: 如果 return_early=False，則返回一個張量儲存在磁碟上的新 tensordict，否則返回一個 TensorDictFuture 例項。

注意

以這種方式序列化可能對深度巢狀的 tensordict 較慢，因此不建議在訓練迴圈內部呼叫此方法。

memmap_(prefix: str | None = None, copy_existing: bool =False, *, num_threads: int =0, return_early: bool =False, share_non_tensor: bool =False, existsok: bool =True) → T¶

將所有張量就地寫入對應記憶體對映張量。

引數:

prefix (str) – 記憶體對映張量將被儲存的目錄字首。目錄樹結構將模仿 tensordict 的結構。
copy_existing (bool) – 如果 False（預設），則如果 tensordict 中的某個條目已是儲存在磁碟上且有關聯檔案的張量，但未按照 prefix 儲存到正確位置，則將引發異常。如果為 True，則任何現有張量將被複制到新位置。

關鍵字引數:

num_threads (int, 可選) – 用於寫入 memmap 張量的執行緒數。預設為 0。
return_early (bool, 可選) – 如果為 True 且 num_threads>0，此方法將返回 tensordict 的 Future。可以使用 future.result() 查詢結果 tensordict。
share_non_tensor (bool, 可選) – 如果為 True，則非張量資料將在程序之間共享，並且在單節點內任何 worker 上的寫入操作（例如就地更新或 set）將更新所有其他 worker 上的值。如果非張量葉子數量很高（例如，共享大量非張量資料堆疊），這可能導致 OOM 或類似錯誤。預設為 False。
existsok (bool, 可選) – 如果為 False，則如果同一路徑下已存在張量，將引發異常。預設為 True。

然後 TensorDict 將被鎖定，這意味著任何非就地寫入操作（例如，重新命名、設定或移除條目）都將丟擲異常。一旦 tensordict 解鎖，記憶體對映屬性將變為 False，因為不再保證跨程序的身份一致性。

返回值:: 如果 return_early=False，則返回自身，否則返回一個 TensorDictFuture 例項。

注意

以這種方式序列化可能對深度巢狀的 tensordict 較慢，因此不建議在訓練迴圈內部呼叫此方法。

memmap_like(prefix: str | None = None, copy_existing: bool =False, *, existsok: bool =True, num_threads: int =0, return_early: bool =False, share_non_tensor: bool =False) → T¶

建立一個與原始 tensordict 形狀相同但不含內容的記憶體對映 tensordict。

引數:

prefix (str) – 記憶體對映張量將被儲存的目錄字首。目錄樹結構將模仿 tensordict 的結構。
copy_existing (bool) – 如果 False（預設），則如果 tensordict 中的某個條目已是儲存在磁碟上且有關聯檔案的張量，但未按照 prefix 儲存到正確位置，則將引發異常。如果為 True，則任何現有張量將被複制到新位置。

關鍵字引數:

num_threads (int, 可選) – 用於寫入 memmap 張量的執行緒數。預設為 0。
return_early (bool, 可選) – 如果為 True 且 num_threads>0，此方法將返回 tensordict 的 Future。
share_non_tensor (bool, 可選) – 如果為 True，則非張量資料將在程序之間共享，並且在單節點內任何 worker 上的寫入操作（例如就地更新或 set）將更新所有其他 worker 上的值。如果非張量葉子數量很高（例如，共享大量非張量資料堆疊），這可能導致 OOM 或類似錯誤。預設為 False。
existsok (bool, 可選) – 如果為 False，則如果同一路徑下已存在張量，將引發異常。預設為 True。

然後 TensorDict 將被鎖定，這意味著任何非就地寫入操作（例如，重新命名、設定或移除條目）都將丟擲異常。一旦 tensordict 解鎖，記憶體對映屬性將變為 False，因為不再保證跨程序的身份一致性。

返回值:: 如果 return_early=False，則返回一個數據儲存為記憶體對映張量的新 TensorDict 例項，否則返回一個 TensorDictFuture 例項。

注意

這是將一組大型緩衝區寫入磁碟的推薦方法，因為 memmap_() 會複製資訊，這對於大內容來說可能很慢。

示例

>>> td = TensorDict({
...     "a": torch.zeros((3, 64, 64), dtype=torch.uint8),
...     "b": torch.zeros(1, dtype=torch.int64),
... }, batch_size=[]).expand(1_000_000)  # expand does not allocate new memory
>>> buffer = td.memmap_like("/path/to/dataset")

memmap_refresh_()¶

如果記憶體對映 tensordict 具有 saved_path，則重新整理其內容。

如果沒有與其關聯的路徑，此方法將引發異常。

save(prefix: str | None = None, copy_existing: bool =False, *, num_threads: int =0, return_early: bool =False, share_non_tensor: bool =False) → T¶

將 tensordict 儲存到磁碟。

此函式是 memmap() 的代理。

set(key: NestedKey, value: Any, inplace: bool =False, non_blocking: bool =False)¶

設定新的鍵值對。

引數:

key (str, 字串元組) – 要設定的鍵的名稱。如果是字串元組，則相當於鏈式呼叫 getattr，後跟最終的 setattr。
value (Any) – 要儲存在 tensorclass 中的值
inplace (bool, 可選) – 如果為 True，set 將嘗試就地更新值。如果為 False 或者鍵不存在，值將簡單地寫入其目標位置。

返回值:

自身

state_dict(destination=None, prefix='', keep_vars=False, flatten=False) → dict[str, Any]¶: 返回一個 state_dict 字典，可用於儲存和從 tensorclass 載入資料。

to_tensordict(*, retain_none: bool | None =None) → TensorDict¶

將 tensorclass 轉換為常規 TensorDict。

複製所有條目。記憶體對映張量和共享記憶體張量將轉換為常規張量。

引數:

retain_none (bool) –

如果為 True，則 None 值將被寫入 tensordict。否則將被丟棄。預設值：True。

注意

從 v0.8 開始，預設值將切換為 False。

返回值:

包含與 tensorclass 相同值的新 TensorDict 物件。

unbind(dim: int)¶

返回一個沿指定維度解綁的索引 tensorclass 例項元組。

結果 tensorclass 例項將共享初始 tensorclass 例項的儲存。

RewardData¶

文件

教程

資源