TensorDict¶

class tensordict.TensorDict(source: Optional[Union[T, dict[tensordict._nestedkey.NestedKey, torch.Tensor]]] = None, batch_size: Optional[Union[Sequence[int], Size, int]] = None, device: Optional[Union[device, str, int]] = None, names: Optional[Sequence[str]] = None, non_blocking: Optional[bool] = None, lock: bool = False, **kwargs: dict[str, Any] | None)¶

一個批次化的 tensors 字典。

TensorDict 是一個 tensor 容器，其中所有 tensors 以鍵值對的形式儲存，並且每個元素共享相同的前 N 個前導維度的形狀，其中是一個任意數字，且 N >= 0。

此外，如果 tensordict 具有指定的裝置，則每個元素必須共享該裝置。

TensorDict 實例支援許多常規的 tensor 操作，但值得注意的是，它不支援代數操作。

形狀操作：當呼叫形狀操作（索引、reshape、view、expand、transpose、permute、unsqueeze、squeeze、masking 等）時，操作的執行方式就像是在與批次大小相同形狀的 tensor 上執行，然後向右擴充，例如：

>>> td = TensorDict({'a': torch.zeros(3, 4, 5)}, batch_size=[3, 4])
>>> # returns a TensorDict of batch size [3, 4, 1]:
>>> td_unsqueeze = td.unsqueeze(-1)
>>> # returns a TensorDict of batch size [12]
>>> td_view = td.view(-1)
>>> # returns a tensor of batch size [12, 4]
>>> a_view = td.view(-1).get("a")

型別轉換操作：可以使用以下方式在不同的裝置上轉換 TensorDict：
```
>>> td_cpu = td.to("cpu")
>>> dictionary = td.to_dict()
```
如果使用 dtype 呼叫 .to() 方法，將會傳回錯誤。
複製 (clone()), 連續 (contiguous());
讀取：td.get(key)、td.get_at(key, index)
內容修改：td.set(key, value)、td.set_(key, value)、td.update(td_or_dict)、td.update_(td_or_dict)、td.fill_(key, value)、td.rename_key_(old_name, new_name) 等。
對多個 tensordict 進行操作：torch.cat(tensordict_list, dim)、torch.stack(tensordict_list, dim)、td1 == td2、td.apply(lambda x+y, other_td) 等。

參數:

source (TensorDict 或 Dict[NestedKey, Union[Tensor, TensorDictBase]]) – 資料來源。如果為空，則 tensordict 可以隨後填入。一個 TensorDict 也可以透過一系列關鍵字引數來建構，就像 dict(...) 的情況一樣。
batch_size (int 的 iterable, optional) – tensordict 的批次大小。只要與其內容相容，批次大小可以隨後修改。如果沒有提供批次大小，則假設為空的批次大小（不會從資料自動推斷）。要自動設定批次大小，請參閱 auto_batch_size_()。
device (torch.device 或 相容型別, optional) – TensorDict 的裝置。如果提供，所有張量將儲存在該裝置上。如果沒有，則允許不同裝置上的張量。
names (str 的 list, optional) – tensordict 維度的名稱。如果提供，其長度必須與 batch_size 的長度相符。預設為 None （沒有維度名稱，或每個維度都為 None）。
non_blocking (bool, optional) – 如果 True 且傳遞了裝置，則 tensordict 在沒有同步的情況下傳遞。這是最快的選項，但僅在從 cpu 轉換為 cuda 時才安全（否則必須由使用者實作同步呼叫）。如果傳遞 False，則每個張量移動都將同步完成。如果 None （預設），裝置轉換將非同步完成，但如果需要，建立後將執行同步。此選項通常應比 False 快，並且可能比 True 慢。
lock (bool, optional) – 如果 True，則產生的 tensordict 將被鎖定。

範例

>>> import torch
>>> from tensordict import TensorDict
>>> source = {'random': torch.randn(3, 4),
...     'zeros': torch.zeros(3, 4, 5)}
>>> batch_size = [3]
>>> td = TensorDict(source, batch_size=batch_size)
>>> print(td.shape)  # equivalent to td.batch_size
torch.Size([3])
>>> td_unqueeze = td.unsqueeze(-1)
>>> print(td_unqueeze.get("zeros").shape)
torch.Size([3, 1, 4, 5])
>>> print(td_unqueeze[0].shape)
torch.Size([1])
>>> print(td_unqueeze.view(-1).shape)
torch.Size([3])
>>> print((td.clone()==td).all())
True

abs() → T¶: 計算 TensorDict 中每個元素的絕對值。

abs_() → T¶: 就地計算 TensorDict 中每個元素的絕對值。

acos() → T¶: 計算 TensorDict 中每個元素的 acos() 值。

acos_() → T¶: 就地計算 TensorDict 中每個元素的 acos() 值。

add(other: tensordict.base.TensorDictBase | torch.Tensor, *, alpha: Optional[float] = None, default: Optional[Union[str, Tensor]] = None) → TensorDictBase¶

將 other（按 alpha 縮放）加到 self。

\[\text{{out}}_i = \text{{input}}_i + \text{{alpha}} \times \text{{other}}_i\]

參數:

other (TensorDictBase 或 torch.Tensor) – 要加到 self 的張量或 TensorDict。

關鍵字引數:

alpha (Number, optional) – other 的乘數。
default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

add_(other: tensordict.base.TensorDictBase | float, *, alpha: Optional[float] = None)¶: add() 的原地 (in-place) 版本。

注意

原地 add 不支援 default 關鍵字參數。

addcdiv(other1: tensordict.base.TensorDictBase | torch.Tensor, other2: tensordict.base.TensorDictBase | torch.Tensor, value: float | None = 1)¶

執行 other1 除以 other2 的元素級別除法，將結果乘以標量 value，然後將其加到 self。

\[\text{out}_i = \text{input}_i + \text{value} \times \frac{\text{tensor1}_i}{\text{tensor2}_i}\]

self、other1 和 other2 的元素的形狀必須是可以廣播的。

對於 FloatTensor 或 DoubleTensor 類型的輸入，value 必須是實數，否則必須是整數。

參數:

other1 ( TensorDict 或 Tensor) – 分子 TensorDict（或 Tensor）
tensor2 ( TensorDict 或 Tensor) – 分母 TensorDict（或 Tensor）

關鍵字引數:

value (Number, 可選) – \(\text{tensor1} / \text{tensor2}\) 的乘數

addcdiv_(other1, other2, *, value: float | None = 1)¶: addcdiv() 的原地版本。

addcmul(other1, other2, *, value: float | None = 1)¶

執行 other1 乘以 other2 的元素級別乘法，將結果乘以標量 value，然後將其加到 self。

\[\text{out}_i = \text{input}_i + \text{value} \times \text{other1}_i \times \text{other2}_i\]

self、other1 和 other2 的形狀必須是可以廣播的。

對於 FloatTensor 或 DoubleTensor 類型的輸入，value 必須是實數，否則必須是整數。

參數:

other1 (TensorDict 或 Tensor) – 要相乘的 tensordict 或 tensor
other2 (TensorDict 或 Tensor) – 要相乘的 tensordict 或 tensor

關鍵字引數:

value (Number, optional) – \(other1 .* other2\) 的乘數

addcmul_(other1, other2, *, value: float | None = 1)¶: addcmul() 的原地 (in-place) 版本。

all(dim: Optional[int] = None) → bool | tensordict.base.TensorDictBase¶

檢查 tensordict 中是否所有值都是 True/非空值 (non-null)。

參數:: dim (int, optional) – 若為 None，則回傳一個布林值，指示是否所有 tensor 都回傳 tensor.all() == True。若為整數，則僅當此維度與 tensordict 形狀相容時，才會對指定的維度呼叫 all。

any(dim: Optional[int] = None) → bool | tensordict.base.TensorDictBase¶

檢查 tensordict 中是否有任何值是 True/非空值 (non-null)。

參數:: dim (int, optional) – 若為 None，則回傳一個布林值，指示是否所有 tensor 都回傳 tensor.any() == True。若為整數，則僅當此維度與 tensordict 形狀相容時，才會對指定的維度呼叫 all。

apply(fn: Callable, *others: T, batch_size: Optional[Sequence[int]] = None, device: torch.device | None = _NoDefault.ZERO, names: Optional[Sequence[str]] = _NoDefault.ZERO, inplace: bool = False, default: Any = _NoDefault.ZERO, filter_empty: Optional[bool] = None, propagate_lock: bool = False, call_on_nested: bool = False, out: Optional[TensorDictBase] = None, **constructor_kwargs) → Optional[T]¶

將一個可呼叫物件 (callable) 應用於 tensordict 中儲存的所有值，並將它們設置到一個新的 tensordict 中。

這個可呼叫物件的簽章 (signature) 必須是 Callable[Tuple[Tensor, ...], Optional[Union[Tensor, TensorDictBase]]]。

參數:

fn (Callable) – 要應用於 tensordict 中 tensors 的函式。
*others (TensorDictBase 實例, 選用) – 如果提供，這些 tensordict 實例的結構應該與 self 的結構相符。 fn 參數應該接收與 tensordict 數量一樣多的未命名輸入，包括 self。如果其他 tensordict 有遺漏的條目，則可以透過 default 關鍵字參數傳遞預設值。

關鍵字引數:

batch_size (int 序列, 選用) – 如果提供，產生的 TensorDict 將具有所需的 batch_size。 batch_size 參數應該與轉換後的 batch_size 相符。這是一個僅限關鍵字的參數。
device (torch.device, 選用) – 結果的裝置 (device)，如果有的話。
names (字串列表, 選用) – 新的維度名稱，以防 batch_size 被修改。
inplace (bool, 選用) – 如果為 True，則會進行原地 (in-place) 更改。預設值為 False。這是一個僅限關鍵字的參數。
default (Any, 選用) – 其他 tensordict 中遺漏條目的預設值。如果未提供，遺漏的條目將引發 KeyError。
filter_empty (bool, optional) – 若為 True，則會濾除空的 tensordict。這也能降低運算成本，因為不會建立和銷毀空的資料結構。非 tensor 的資料會被視為葉節點，因此即使函數沒有更動，也會保留在 tensordict 中。為了向後相容，預設值為 False。
propagate_lock (bool, optional) – 若為 True，則鎖定的 tensordict 會產生另一個鎖定的 tensordict。預設值為 False。

call_on_nested (bool, optional) –

若為 True，則該函數會被調用於第一層的 tensors 和容器（TensorDict 或 tensorclass）。在這種情況下，func 負責將其調用傳播到巢狀層級。這樣可以在將調用傳播到巢狀 tensordict 時實現精細的行為。若為 False，則該函數只會被調用於葉節點，並且 apply 會負責將該函數分派到所有葉節點。

>>> td = TensorDict({"a": {"b": [0.0, 1.0]}, "c": [1.0, 2.0]})
>>> def mean_tensor_only(val):
...     if is_tensor_collection(val):
...         raise RuntimeError("Unexpected!")
...     return val.mean()
>>> td_mean = td.apply(mean_tensor_only)
>>> def mean_any(val):
...     if is_tensor_collection(val):
...         # Recurse
...         return val.apply(mean_any, call_on_nested=True)
...     return val.mean()
>>> td_mean = td.apply(mean_any, call_on_nested=True)

out (TensorDictBase, optional) –
一個用於寫入結果的 tensordict。這可以用來避免建立新的 tensordict
```
>>> td = TensorDict({"a": 0})
>>> td.apply(lambda x: x+1, out=td)
>>> assert (td==1).all()
```
警告

如果對 tensordict 執行的操作需要存取多個鍵才能進行單一計算，則提供一個等於 self 的 out 參數可能會導致該操作產生無提示的錯誤結果。例如
```
>>> td = TensorDict({"a": 1, "b": 1})
>>> td.apply(lambda x: x+td["a"])["b"] # Right!
tensor(2)
>>> td.apply(lambda x: x+td["a"], out=td)["b"] # Wrong!
tensor(3)
```
**constructor_kwargs – 要傳遞給 TensorDict 建構子的額外關鍵字參數。

回傳值:

一個具有 transformed_in tensors 的新 tensordict。

範例

>>> td = TensorDict({
...     "a": -torch.ones(3),
...     "b": {"c": torch.ones(3)}},
...     batch_size=[3])
>>> td_1 = td.apply(lambda x: x+1)
>>> assert (td_1["a"] == 0).all()
>>> assert (td_1["b", "c"] == 2).all()
>>> td_2 = td.apply(lambda x, y: x+y, td)
>>> assert (td_2["a"] == -2).all()
>>> assert (td_2["b", "c"] == 2).all()

注意

如果函數回傳 None，則該條目會被忽略。這可以用來過濾 tensordict 中的資料

>>> td = TensorDict({"1": 1, "2": 2, "b": {"2": 2, "1": 1}}, [])
>>> def filter(tensor):
...     if tensor == 1:
...         return tensor
>>> td.apply(filter)
TensorDict(
    fields={
        1: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        b: TensorDict(
            fields={
                1: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

注意

無論輸入類型為何，apply 方法都會回傳一個 TensorDict 實例。為了保持相同的類型，可以執行

>>> out = td.clone(False).update(td.apply(...))

apply_(fn: Callable, *others, **kwargs) → T¶

將一個可呼叫物件應用於 tensordict 中儲存的所有值，並就地重寫它們。

參數:

fn (Callable) – 要應用於 tensordict 中 tensors 的函式。
*others (TensorDictBase 的序列, optional) – 要使用的其他 tensordict。

關鍵字引數：請參閱 apply()。

回傳值:: self 或應用該函數的 self 的副本

asin() → T¶: 計算 TensorDict 中每個元素的 asin() 值。

asin_() → T¶: 就地計算 TensorDict 中每個元素的 asin() 值。

atan() → T¶: 計算 TensorDict 中每個元素的 atan() 值。

atan_() → T¶: 就地計算 TensorDict 中每個元素的 atan() 值。

auto_batch_size_(batch_dims: Optional[int] = None) → T¶

設定 tensordict 的最大批次大小，最多可達一個可選的 batch_dims。

參數:: batch_dims (int, optional) – 如果提供，則批次大小最多為 batch_dims 的長度。
回傳值:: self

範例

>>> from tensordict import TensorDict
>>> import torch
>>> td = TensorDict({"a": torch.randn(3, 4, 5), "b": {"c": torch.randn(3, 4, 6)}}, batch_size=[])
>>> td.auto_batch_size_()
>>> print(td.batch_size)
torch.Size([3, 4])
>>> td.auto_batch_size_(batch_dims=1)
>>> print(td.batch_size)
torch.Size([3])

auto_device_() → T¶

自動設定裝置，如果它是唯一的。

回傳值：具有已編輯的 device 屬性的 self。

property batch_dims: int¶

tensordict 批次大小的長度。

回傳值:: 描述 tensordict 維度的整數。

property batch_size: Size¶

TensorDict 的形狀（或批次大小）。

tensordict 的形狀對應於其所含張量的共同前 N 個維度，其中 N 是一個任意數字。批次大小與代表張量語義相關形狀的「特徵大小」形成對比。例如，一批影片可能具有形狀 [B, T, C, W, H]，其中 [B, T] 是批次大小（批次和時間維度），而 [C, W, H] 是特徵維度（通道和空間維度）。

TensorDict 的形狀由使用者在初始化時控制（即，它不是從張量形狀推斷出來的）。

如果新大小與 TensorDict 內容兼容，則可以動態編輯 batch_size。例如，始終允許將批次大小設定為空值。

回傳值:: 描述 TensorDict 批次大小的 Size 物件。

範例

>>> data = TensorDict({
...     "key 0": torch.randn(3, 4),
...     "key 1": torch.randn(3, 5),
...     "nested": TensorDict({"key 0": torch.randn(3, 4)}, batch_size=[3, 4])},
...     batch_size=[3])
>>> data.batch_size = () # resets the batch-size to an empty value

bfloat16()¶: 將所有張量轉換為 torch.bfloat16。

bool()¶: 將所有張量轉換為 torch.bool。

bytes(*, count_duplicates: bool = True) → int¶

計算所含張量的位元組數。

關鍵字引數:: count_duplicates (bool) – 是否將重複的張量視為獨立的張量。如果 False，則只會丟棄嚴格相同的張量（來自共同基礎張量的相同視圖但具有不同 ID 將被計算兩次）。預設值為 True（假設每個張量都是單一副本）。

classmethod cat(input, dim=0, *, out=None)¶

沿著給定的維度將 tensordict 串連到單個 tensordict 中。

此呼叫等效於呼叫 torch.cat()，但與 torch.compile 兼容。

cat_from_tensordict(dim: int = 0, *, sorted: Optional[Union[bool, List[NestedKey]]] = None, out: Tensor] = None) → Tensor¶

將 tensordict 的所有條目串連成單個張量。

參數:

dim (int, optional) – 條目應沿其串連的維度。

關鍵字引數:

sorted (bool 或 NestedKeys 的 list) – 如果為 True，條目將按字母順序串聯。如果為 False (預設)，則將使用 dict 的順序。或者，可以提供鍵名稱的 list，並且張量將相應地串聯。這會產生一些額外負擔，因為將針對 tensordict 中的葉節點名稱 list 檢查鍵的 list。
out (torch.Tensor, optional) – cat 運算的選擇性目標張量。

cat_tensors(*keys: NestedKey, out_key: NestedKey, dim: int = 0, keep_entries: bool = False) → T¶

將條目串聯到一個新條目中，並可能移除原始值。

參數:: keys (NestedKey 的 sequence) – 要串聯的條目。

關鍵字引數

out_key (NestedKey): 串聯輸入的新鍵名稱。 keep_entries (bool, optional): 如果 False，keys 中的條目將被刪除。

預設為 False。

dim (int, optional): 串聯必須沿著發生的維度。: 預設為 0。

傳回：self

範例

>>> td = TensorDict(a=torch.zeros(1), b=torch.ones(1))
>>> td.cat_tensors("a", "b", out_key="c")
>>> assert "a" not in td
>>> assert (td["c"] == torch.tensor([0, 1])).all()

ceil() → T¶: 計算 TensorDict 每個元素的 ceil() 值。

ceil_() → T¶: 就地計算 TensorDict 每個元素的 ceil() 值。

chunk(chunks: int, dim: int = 0) → tuple[tensordict.base.TensorDictBase, ...]¶

如果可能，將 tensordict 分割成指定數量的區塊。

每個區塊都是輸入 tensordict 的一個檢視。

參數:

chunks (int) – 要傳回的區塊數量
dim (int, optional) – 沿著哪個維度分割 tensordict。預設值為 0。

範例

>>> td = TensorDict({
...     'x': torch.arange(24).reshape(3, 4, 2),
... }, batch_size=[3, 4])
>>> td0, td1 = td.chunk(dim=-1, chunks=2)
>>> td0['x']
tensor([[[ 0,  1],
         [ 2,  3]],
        [[ 8,  9],
         [10, 11]],
        [[16, 17],
         [18, 19]]])

clamp_max(other: tensordict.base.TensorDictBase | torch.Tensor, *, default: Optional[Union[str, Tensor]] = None) → T¶

如果 self 的元素大於該值，則將其限制為 other。

參數:: other (TensorDict 或 Tensor) – 另一個輸入 tensordict 或 tensor。
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

clamp_max_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: clamp_max() 的原地版本。

注意

Inplace clamp_max 不支援 default 關鍵字引數。

clamp_min(other: tensordict.base.TensorDictBase | torch.Tensor, default: Optional[Union[str, Tensor]] = None) → T¶

如果 self 的元素小於 other，則將其限制為 other 的值。

參數:: other (TensorDict 或 Tensor) – 另一個輸入 tensordict 或 tensor。
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

clamp_min_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: clamp_min() 的原地 (in-place) 版本。

注意

原地 clamp_min 不支援 default 關鍵字引數。

clear() → T¶: 清除 tensordict 的內容。

clear_device_() → T¶

清除 tensordict 的裝置。

傳回：self

clone(recurse: bool = True, **kwargs) → T¶

將 TensorDictBase 子類別的實例複製到相同類型的新 TensorDictBase 子類別中。

若要從任何其他 TensorDictBase 子類型建立 TensorDict 實例，請改為呼叫 to_tensordict() 方法。

參數:: recurse (bool, optional) – 如果 True，則也會複製 TensorDict 中包含的每個張量。否則，只會複製 TensorDict 樹狀結構。預設值為 True。

注意

與許多其他運算（逐點運算、形狀運算等）不同，clone 不會繼承原始鎖定屬性。做出此設計選擇是為了可以創建一個克隆以進行修改，這是最常見的用法。

complex128()¶: 將所有張量轉換為 torch.complex128。

complex32()¶: 將所有張量轉換為 torch.complex32。

complex64()¶: 將所有張量轉換為 torch.complex64。

consolidate(filename: Optional[Union[Path, str]] = None, *, num_threads=0, device: Optional[device] = None, non_blocking: bool = False, inplace: bool = False, return_early: bool = False, use_buffer: bool = False, share_memory: bool = False, pin_memory: bool = False, metadata: bool = False) → None¶

將 tensordict 的內容整合到單一儲存空間，以加快序列化速度。

參數:

filename (Path, optional) – 可選的檔案路徑，用於記憶體對應的 tensor 作為 tensordict 的儲存空間。

關鍵字引數:

num_threads (integer, optional) – 用於填充儲存空間的執行緒數量。
device (torch.device, optional) – 儲存空間必須實例化的可選裝置。
non_blocking (bool, optional) – 傳遞給 copy_() 的 non_blocking 引數。
inplace (bool, optional) – 如果 True，則產生的 tensordict 與 self 相同，但具有更新後的值。預設為 False。
return_early (bool, optional) – 如果 True 且 num_threads>0，則該方法將傳回 tensordict 的 future。可以使用 future.result() 查詢產生的 tensordict。
use_buffer (bool, optional) – 如果 True 且傳遞了檔案名稱，則將在共享記憶體中建立一個中間的本機緩衝區，並且資料將作為最後一步複製到儲存位置。這可能比直接寫入遠端物理記憶體（例如，NFS）更快。預設為 False。
share_memory (bool, optional) – 如果 True，儲存空間將放置在共享記憶體中。預設為 False。
pin_memory (bool, optional) – 是否應將整合後的資料放置在釘選記憶體中。預設為 False。
metadata (bool, optional) – 如果 True，metadata 會與通用儲存空間一起儲存。如果提供了檔名，則此設定無效。當想要控制序列化的實現方式時，儲存 metadata 會很有用，因為如果 metadata 可用或不可用，TensorDict 處理合併的 TD 的 pickle/unpickle 方式會有所不同。

注意

如果 tensordict 已經合併，則所有參數都會被忽略，並返回 self。調用 contiguous() 重新合併。

範例

>>> import pickle
>>> import tempfile
>>> import torch
>>> import tqdm
>>> from torch.utils.benchmark import Timer
>>> from tensordict import TensorDict
>>> data = TensorDict({"a": torch.zeros(()), "b": {"c": torch.zeros(())}})
>>> data_consolidated = data.consolidate()
>>> # check that the data has a single data_ptr()
>>> assert torch.tensor([
...     v.untyped_storage().data_ptr() for v in data_c.values(True, True)
... ]).unique().numel() == 1
>>> # Serializing the tensordict will be faster with data_consolidated
>>> with open("data.pickle", "wb") as f:
...    print("regular", Timer("pickle.dump(data, f)", globals=globals()).adaptive_autorange())
>>> with open("data_c.pickle", "wb") as f:
...     print("consolidated", Timer("pickle.dump(data_consolidated, f)", globals=globals()).adaptive_autorange())

contiguous() → T¶: 返回一個新的 tensordict，其類型相同且具有連續的值（如果值已經是連續的，則返回 self）。

copy()¶

返回 tensordict 的淺拷貝（即，複製結構但不複製資料）。

等效於 TensorDictBase.clone(recurse=False)

copy_(tensordict: T, non_blocking: bool = False) → T¶

請參閱 TensorDictBase.update_。

non-blocking 參數將被忽略，僅為了與 torch.Tensor.copy_() 的相容性而存在。

copy_at_(tensordict: T, idx: Union[None, int, slice, str, Tensor, List[Any], Tuple[Any, ...]], non_blocking: bool = False) → T¶: 請參閱 TensorDictBase.update_at_。

cos() → T¶: 計算 TensorDict 中每個元素的 cos() 值。

cos_() → T¶: 就地計算 TensorDict 中每個元素的 cos() 值。

cosh() → T¶: 計算 TensorDict 中每個元素的 cosh() 值。

cosh_() → T¶: 就地計算 TensorDict 中每個元素的 cosh() 值。

cpu(**kwargs) → T¶

將 tensordict 轉換到 CPU。

此函式也支援 to() 的所有關鍵字引數。

create_nested(key)¶

建立一個與目前 tensordict 具有相同形狀、裝置和維度名稱的巢狀 tensordict。

如果該值已存在，則此操作將會覆寫它。此操作在鎖定的 tensordict 中會被封鎖。

範例

>>> data = TensorDict({}, [3, 4, 5])
>>> data.create_nested("root")
>>> data.create_nested(("some", "nested", "value"))
>>> print(data)
TensorDict(
    fields={
        root: TensorDict(
            fields={
            },
            batch_size=torch.Size([3, 4, 5]),
            device=None,
            is_shared=False),
        some: TensorDict(
            fields={
                nested: TensorDict(
                    fields={
                        value: TensorDict(
                            fields={
                            },
                            batch_size=torch.Size([3, 4, 5]),
                            device=None,
                            is_shared=False)},
                    batch_size=torch.Size([3, 4, 5]),
                    device=None,
                    is_shared=False)},
            batch_size=torch.Size([3, 4, 5]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3, 4, 5]),
    device=None,
    is_shared=False)

cuda(device: Optional[int] = None, **kwargs) → T¶

將 tensordict 轉換為 cuda 裝置（如果尚未在該裝置上）。

參數:: device (int, optional) – 如果提供，tensor 應轉換到的 cuda 裝置。

此函式也支援 to() 的所有關鍵字引數。

property data¶: 傳回包含葉 tensor 的 .data 屬性的 tensordict。

data_ptr(*, storage: bool = False)¶

傳回 tensordict 葉的 data_ptr。

這可用於檢查兩個 tensordict 是否共享相同的 data_ptr()。

關鍵字引數:: storage (bool, optional) – 如果 True，則會呼叫 tensor.untyped_storage().data_ptr()。預設值為 False。

範例

>>> from tensordict import TensorDict
>>> td = TensorDict(a=torch.randn(2), b=torch.randn(2), batch_size=[2])
>>> assert (td0.data_ptr() == td.data_ptr()).all()

注意

LazyStackedTensorDict 實例將顯示為巢狀 tensordict，以反映其葉的真實 data_ptr()

>>> td0 = TensorDict(a=torch.randn(2), b=torch.randn(2), batch_size=[2])
>>> td1 = TensorDict(a=torch.randn(2), b=torch.randn(2), batch_size=[2])
>>> td = TensorDict.lazy_stack([td0, td1])
>>> td.data_ptr()
TensorDict(
    fields={
        0: TensorDict(
            fields={
                a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
                b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=cpu,
            is_shared=False),
        1: TensorDict(
            fields={
                a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
                b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=cpu,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=cpu,
    is_shared=False)

del_(key: NestedKey) → T¶

刪除 tensordict 的鍵。

參數:: key (NestedKey) – 要刪除的鍵
回傳值:: self

densify(layout: layout = torch.strided)¶

嘗試使用連續的 tensor（plain tensors 或巢狀）來表示 lazy stack。

關鍵字引數:: layout (torch.layout) – 巢狀 tensor 的 layout（如果有的話）。預設值為 strided。

property depth: int¶

傳回 tensordict 的深度 - 最大層數。

最小深度為 0（沒有巢狀 tensordict）。

detach() → T¶

分離 tensordict 中的 tensor。

回傳值:: 一個新的 tensordict，沒有需要梯度的 tensor。

detach_() → T¶

就地分離 tensordict 中的 tensor。

回傳值:: self。

property device: torch.device | None¶

tensordict 的裝置。

如果未在建構函式中提供裝置，或未透過 tensordict.to(device) 設定，則傳回 None。

dim() → int¶: 請參閱 batch_dims()。

div(other: tensordict.base.TensorDictBase | torch.Tensor, *, default: Optional[Union[str, Tensor]] = None) → T¶

將輸入 self 的每個元素除以 other 中對應的元素。

\[\text{out}_i = \frac{\text{input}_i}{\text{other}_i}\]

支援廣播 (broadcasting)、類型提升 (type promotion) 以及整數、浮點數、tensordict 或 tensor 輸入。始終將整數類型提升為預設的純量類型 (scalar type)。

參數:: other (TensorDict, Tensor 或 Number) – 除數。
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

div_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: div() 的原地 (in-place) 版本。

注意

原地 div 不支援 default 關鍵字引數。

double()¶: 將所有張量轉換為 torch.bool。

property dtype¶: 如果 tensordict 中的值具有唯一的 dtype，則傳回該 dtype。

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

將 tensordict 儲存到磁碟。

此函式是 memmap() 的代理。

empty(recurse=False, *, batch_size=None, device=_NoDefault.ZERO, names=_NoDefault.ZERO) → T¶

傳回一個新的、空的 tensordict，具有相同的裝置和批次大小 (batch size)。

參數:

recurse (bool, optional) – 如果為 True，則將複製 TensorDict 的整個結構，但不包含內容。否則，只會複製根目錄。預設值為 False。

關鍵字引數:

batch_size (torch.Size, optional) – tensordict 的新批次大小。
device (torch.device, optional) – 新裝置。
names (list of str, optional) – 維度名稱。

entry_class(key: NestedKey) → type¶

傳回條目的類別，可能會避免呼叫 isinstance(td.get(key), type)。

每當 get() 的執行成本很高時，都應優先選擇此方法，而非使用 tensordict.get(key).shape。

erf() → T¶: 計算 TensorDict 中每個元素的 erf() 值。

erf_() → T¶: 就地計算 TensorDict 中每個元素的 erf() 值。

erfc() → T¶: 計算 TensorDict 中每個元素的 erfc() 值。

erfc_() → T¶: 就地計算 TensorDict 中每個元素的 erfc() 值。

exclude(*keys: NestedKey, inplace: bool = False) → T¶

排除 tensordict 的鍵，並傳回一個不含這些條目的新 tensordict。

這些值不會被複製：對原始或新的 tensordict 的 tensor 進行就地修改將導致兩個 tensordict 都發生變化。

參數:

*keys (str) – 要排除的鍵。
inplace (bool) – 如果為 True，則就地修剪 tensordict。預設值為 False。

回傳值:

一個新的 tensordict（如果 inplace=True，則為同一個）不包含被排除的條目。

範例

>>> from tensordict import TensorDict
>>> td = TensorDict({"a": 0, "b": {"c": 1, "d": 2}}, [])
>>> td.exclude("a", ("b", "c"))
TensorDict(
    fields={
        b: TensorDict(
            fields={
                d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> td.exclude("a", "b")
TensorDict(
    fields={
    },
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

exp() → T¶: 計算 TensorDict 中每個元素的 exp() 值。

exp_() → T¶: 就地計算 TensorDict 中每個元素的 exp() 值。

expand(*args, **kwargs) → T¶

根據 expand() 函數展開 tensordict 的每個 tensor，忽略特徵維度。

支援使用可迭代物件來指定形狀。

範例

>>> td = TensorDict({
...     'a': torch.zeros(3, 4, 5),
...     'b': torch.zeros(3, 4, 10)}, batch_size=[3, 4])
>>> td_expand = td.expand(10, 3, 4)
>>> assert td_expand.shape == torch.Size([10, 3, 4])
>>> assert td_expand.get("a").shape == torch.Size([10, 3, 4, 5])

expand_as(other: tensordict.base.TensorDictBase | torch.Tensor) → TensorDictBase¶

將 tensordict 的形狀廣播到 other 的形狀，並據此展開它。

如果輸入是一個 tensor 集合（tensordict 或 tensorclass），則葉節點將逐一展開。

範例

>>> from tensordict import TensorDict
>>> import torch
>>> td0 = TensorDict({
...     "a": torch.ones(3, 1, 4),
...     "b": {"c": torch.ones(3, 2, 1, 4)}},
...     batch_size=[3],
... )
>>> td1 = TensorDict({
...     "a": torch.zeros(2, 3, 5, 4),
...     "b": {"c": torch.zeros(2, 3, 2, 6, 4)}},
...     batch_size=[2, 3],
... )
>>> expanded = td0.expand_as(td1)
>>> assert (expanded==1).all()
>>> print(expanded)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([2, 3, 5, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([2, 3, 2, 6, 4]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([2, 3]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([2, 3]),
    device=None,
    is_shared=False)

expm1() → T¶: 計算 TensorDict 中每個元素的 expm1() 值。

expm1_() → T¶: 就地計算 TensorDict 中每個元素的 expm1() 值。

fill_(key: NestedKey, value: float | bool) → T¶

用給定的純量值填充鍵所指向的 tensor。

參數:

key (str 或 巢狀鍵) – 要填充的條目。
value (Number 或 bool) – 用於填充的值。

回傳值:

self

filter_empty_()¶: 就地過濾掉所有空的 tensordict。

filter_non_tensor_data() → T¶: 濾除所有非 Tensor 資料。

flatten(start_dim=0, end_dim=- 1)¶

將 tensordict 中的所有 tensor 攤平（flatten）。

參數:

start_dim (int) – 要攤平的第一個維度。
end_dim (int) – 要攤平的最後一個維度。

範例

>>> td = TensorDict({
...     "a": torch.arange(60).view(3, 4, 5),
...     "b": torch.arange(12).view(3, 4)}, batch_size=[3, 4])
>>> td_flat = td.flatten(0, 1)
>>> td_flat.batch_size
torch.Size([12])
>>> td_flat["a"]
tensor([[ 0,  1,  2,  3,  4],
        [ 5,  6,  7,  8,  9],
        [10, 11, 12, 13, 14],
        [15, 16, 17, 18, 19],
        [20, 21, 22, 23, 24],
        [25, 26, 27, 28, 29],
        [30, 31, 32, 33, 34],
        [35, 36, 37, 38, 39],
        [40, 41, 42, 43, 44],
        [45, 46, 47, 48, 49],
        [50, 51, 52, 53, 54],
        [55, 56, 57, 58, 59]])
>>> td_flat["b"]
tensor([ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11])

flatten_keys(separator: str = '.', inplace: bool = False, is_leaf: Optional[Callable[[Type], bool]] = None) → T¶

遞迴地將巢狀的 tensordict 轉換為扁平的 tensordict。

TensorDict 型別將會遺失，且結果會是一個簡單的 TensorDict 實例。

參數:

separator (str, optional) – 巢狀項目間的分隔符號。預設為 '.'。
inplace (bool, optional) – 若為 True，則產生的 tensordict 會與呼叫所在的 tensordict 具有相同的識別項。預設為 False。
is_leaf (callable, optional) – 一個針對類別型別的可呼叫物件，回傳一個布林值，指示是否應將此類別視為葉節點。

範例

>>> data = TensorDict({"a": 1, ("b", "c"): 2, ("e", "f", "g"): 3}, batch_size=[])
>>> data.flatten_keys(separator=" - ")
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        b - c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        e - f - g: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

此方法和 unflatten_keys() 在處理 state-dicts 時特別有用，因為它們可以無縫地將扁平的字典轉換為模仿模型結構的資料結構。

範例

>>> model = torch.nn.Sequential(torch.nn.Linear(3 ,4))
>>> ddp_model = torch.ao.quantization.QuantWrapper(model)
>>> state_dict = TensorDict(ddp_model.state_dict(), batch_size=[]).unflatten_keys(".")
>>> print(state_dict)
TensorDict(
    fields={
        module: TensorDict(
            fields={
                0: TensorDict(
                    fields={
                        bias: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.float32, is_shared=False),
                        weight: Tensor(shape=torch.Size([4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
                    batch_size=torch.Size([]),
                    device=None,
                    is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> model_state_dict = state_dict.get("module")
>>> print(model_state_dict)
TensorDict(
    fields={
        0: TensorDict(
            fields={
                bias: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.float32, is_shared=False),
                weight: Tensor(shape=torch.Size([4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> model.load_state_dict(dict(model_state_dict.flatten_keys(".")))

float()¶: 將所有 tensor 轉換為 torch.float。

float16()¶: 將所有 tensor 轉換為 torch.float16。

float32()¶: 將所有 tensor 轉換為 torch.float32。

float64()¶: 將所有 tensor 轉換為 torch.float64。

floor() → T¶: 計算 TensorDict 中每個元素的 floor() 值。

floor_() → T¶: 就地（in-place）計算 TensorDict 中每個元素的 floor() 值。

frac() → T¶: 計算 TensorDict 中每個元素的 frac() 值。

frac_() → T¶: 就地（in-place）計算 TensorDict 中每個元素的 frac() 值。

classmethod from_dict(input_dict, batch_size=None, device=None, batch_dims=None, names=None)¶

傳回一個由字典或另一個 TensorDict 建立的 TensorDict。

如果未指定 batch_size，則傳回可能的最大批次大小。

此函式也適用於巢狀字典，或可用於確定巢狀 tensordict 的批次大小。

參數:

input_dict (dictionary, optional) – 用作資料來源的字典（相容巢狀鍵）。
batch_size (iterable of int, optional) – tensordict 的批次大小。
device (torch.device or compatible type, optional) – TensorDict 的裝置。
batch_dims (int, optional) – batch_dims (即要考慮用於 batch_size 的前導維度的數量)。與 batch_size 互斥。請注意，這是 tensordict 的__最大__批次維度數，容許較小的數字。
names (list of str, optional) – tensordict 的維度名稱。

範例

>>> input_dict = {"a": torch.randn(3, 4), "b": torch.randn(3)}
>>> print(TensorDict.from_dict(input_dict))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)
>>> # nested dict: the nested TensorDict can have a different batch-size
>>> # as long as its leading dims match.
>>> input_dict = {"a": torch.randn(3), "b": {"c": torch.randn(3, 4)}}
>>> print(TensorDict.from_dict(input_dict))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([3, 4]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3, 4]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)
>>> # we can also use this to work out the batch sie of a tensordict
>>> input_td = TensorDict({"a": torch.randn(3), "b": {"c": torch.randn(3, 4)}}, [])
>>> print(TensorDict.from_dict(input_td))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([3, 4]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3, 4]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)

from_dict_instance(input_dict, batch_size=None, device=None, batch_dims=None, names=None)¶

from_dict() 的實例方法版本。

與 from_dict() 不同，此方法會嘗試將 tensordict 類型保留在現有樹狀結構中（對於任何現有的葉節點）。

範例

>>> from tensordict import TensorDict, tensorclass
>>> import torch
>>>
>>> @tensorclass
>>> class MyClass:
...     x: torch.Tensor
...     y: int
>>>
>>> td = TensorDict({"a": torch.randn(()), "b": MyClass(x=torch.zeros(()), y=1)})
>>> print(td.from_dict_instance(td.to_dict()))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: MyClass(
            x=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
            y=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> print(td.from_dict(td.to_dict()))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                x: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
                y: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

classmethod from_h5(filename, mode='r')¶

從 h5 檔案建立一個 PersistentTensorDict。

此函式將自動確定每個巢狀 tensordict 的批次大小。

參數:

filename (str) – h5 檔案的路徑。
mode (str, optional) – 讀取模式。預設為 "r"。

classmethod from_module(module: Module, as_module: bool = False, lock: bool = False, use_state_dict: bool = False, filter_empty: bool = True)¶

將模組的參數和緩衝區複製到 tensordict 中。

參數:

module (nn.Module) – 要從中獲取參數的模組。
as_module (bool, optional) – 如果為 True，則將傳回一個 TensorDictParams 實例，該實例可用於在 torch.nn.Module 中儲存參數。預設為 False。
lock (bool, optional) – 如果為 True，則將鎖定產生的 tensordict。預設為 True。
use_state_dict (bool, optional) –
如果為 True，將使用模組中的 state-dict 並將其解扁平化為具有模型樹狀結構的 TensorDict。預設為 False。

注意

當必須使用 state-dict hook 時，這特別有用。

範例

>>> from torch import nn
>>> module = nn.TransformerDecoder(
...     decoder_layer=nn.TransformerDecoderLayer(nhead=4, d_model=4),
...     num_layers=1
... )
>>> params = TensorDict.from_module(module)
>>> print(params["layers", "0", "linear1"])
TensorDict(
    fields={
        bias: Parameter(shape=torch.Size([2048]), device=cpu, dtype=torch.float32, is_shared=False),
        weight: Parameter(shape=torch.Size([2048, 4]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

classmethod from_modules(*modules, as_module: bool = False, lock: bool = True, use_state_dict: bool = False, lazy_stack: bool = False, expand_identical: bool = False)¶

檢索多個模組的參數，用於 ensebmle 學習/vmap 期望應用程式的功能。

參數:

modules (nn.Module 的序列) – 要從中獲取參數的模組。如果模組的結構不同，則需要一個延遲堆疊（參見下面的 lazy_stack 引數）。

關鍵字引數:

as_module (bool, optional) – 如果為 True，則會回傳一個 TensorDictParams 實例，可用於在 torch.nn.Module 中儲存參數。預設值為 False。
lock (bool, optional) – 如果為 True，則產生的 tensordict 將被鎖定。預設值為 True。
use_state_dict (bool, optional) –
如果為 True，將使用模組中的 state-dict 並將其解扁平化為具有模型樹狀結構的 TensorDict。預設為 False。

注意

當必須使用 state-dict hook 時，這特別有用。
lazy_stack (bool, optional) –
參數應密集堆疊還是延遲堆疊。預設值為 False（密集堆疊）。

注意

lazy_stack 和 as_module 是互斥的功能。

警告

延遲輸出和非延遲輸出之間的一個關鍵區別在於，非延遲輸出會使用所需的批次大小重新實例化參數，而 lazy_stack 只會將參數表示為延遲堆疊。這意味著，當 lazy_stack=True 時，原始參數可以安全地傳遞給優化器，而當它設定為 True 時，則需要傳遞新參數。

警告

雖然可以使用延遲堆疊來保留原始參數引用，但請記住，每次呼叫 get() 時，延遲堆疊都會執行堆疊。這需要記憶體（參數大小的 N 倍，如果建立圖表則更多）和時間來計算。這也意味著優化器將包含更多參數，並且像 step() 或 zero_grad() 這樣的操作將需要更長的時間才能執行。通常，lazy_stack 應保留給非常少的用例。
expand_identical (bool, optional) – 如果為 True 且相同的參數（相同的識別碼）正在堆疊到自身，則會回傳此參數的展開版本。當 lazy_stack=True 時，將忽略此引數。

範例

>>> from torch import nn
>>> from tensordict import TensorDict
>>> torch.manual_seed(0)
>>> empty_module = nn.Linear(3, 4, device="meta")
>>> n_models = 2
>>> modules = [nn.Linear(3, 4) for _ in range(n_models)]
>>> params = TensorDict.from_modules(*modules)
>>> print(params)
TensorDict(
    fields={
        bias: Parameter(shape=torch.Size([2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        weight: Parameter(shape=torch.Size([2, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([2]),
    device=None,
    is_shared=False)
>>> # example of batch execution
>>> def exec_module(params, x):
...     with params.to_module(empty_module):
...         return empty_module(x)
>>> x = torch.randn(3)
>>> y = torch.vmap(exec_module, (0, None))(params, x)
>>> assert y.shape == (n_models, 4)
>>> # since lazy_stack = False, backprop leaves the original params untouched
>>> y.sum().backward()
>>> assert params["weight"].grad.norm() > 0
>>> assert modules[0].weight.grad is None

使用 lazy_stack=True 時，情況略有不同

>>> params = TensorDict.from_modules(*modules, lazy_stack=True)
>>> print(params)
LazyStackedTensorDict(
    fields={
        bias: Tensor(shape=torch.Size([2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        weight: Tensor(shape=torch.Size([2, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
    exclusive_fields={
    },
    batch_size=torch.Size([2]),
    device=None,
    is_shared=False,
    stack_dim=0)
>>> # example of batch execution
>>> y = torch.vmap(exec_module, (0, None))(params, x)
>>> assert y.shape == (n_models, 4)
>>> y.sum().backward()
>>> assert modules[0].weight.grad is not None

classmethod from_namedtuple(named_tuple, *, auto_batch_size: bool = False)¶

以遞迴方式將 namedtuple 轉換為 TensorDict。

關鍵字引數:: auto_batch_size (bool, optional) – 如果為 True，則批次大小將自動計算。預設值為 False。

範例

>>> from tensordict import TensorDict
>>> import torch
>>> data = TensorDict({
...     "a_tensor": torch.zeros((3)),
...     "nested": {"a_tensor": torch.zeros((3)), "a_string": "zero!"}}, [3])
>>> nt = data.to_namedtuple()
>>> print(nt)
GenericDict(a_tensor=tensor([0., 0., 0.]), nested=GenericDict(a_tensor=tensor([0., 0., 0.]), a_string='zero!'))
>>> TensorDict.from_namedtuple(nt, auto_batch_size=True)
TensorDict(
    fields={
        a_tensor: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False),
        nested: TensorDict(
            fields={
                a_string: NonTensorData(data=zero!, batch_size=torch.Size([3]), device=None),
                a_tensor: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)

classmethod from_pytree(pytree, *, batch_size: Optional[Size] = None, auto_batch_size: bool = False, batch_dims: Optional[int] = None)¶

將 pytree 轉換為 TensorDict 實例。

此方法旨在盡可能保留 pytree 的巢狀結構。

新增額外的非張量鍵以追蹤每個層級的識別，提供內建的 pytree 到 tensordict 的雙射轉換 API。

目前接受的類別包括 lists、tuples、named tuples 和 dict。

注意

對於字典，非 NestedKey 鍵會分別註冊為 NonTensorData 實例。

注意

可轉換為張量的類型（例如 int、float 或 np.ndarray）將會轉換為 torch.Tensor 實例。請注意，此轉換是滿射的：將 tensordict 轉換回 pytree 將無法恢復原始類型。

範例

>>> # Create a pytree with tensor leaves, and one "weird"-looking dict key
>>> class WeirdLookingClass:
...     pass
...
>>> weird_key = WeirdLookingClass()
>>> # Make a pytree with tuple, lists, dict and namedtuple
>>> pytree = (
...     [torch.randint(10, (3,)), torch.zeros(2)],
...     {
...         "tensor": torch.randn(
...             2,
...         ),
...         "td": TensorDict({"one": 1}),
...         weird_key: torch.randint(10, (2,)),
...         "list": [1, 2, 3],
...     },
...     {"named_tuple": TensorDict({"two": torch.ones(1) * 2}).to_namedtuple()},
... )
>>> # Build a TensorDict from that pytree
>>> td = TensorDict.from_pytree(pytree)
>>> # Recover the pytree
>>> pytree_recon = td.to_pytree()
>>> # Check that the leaves match
>>> def check(v1, v2):
>>>     assert (v1 == v2).all()
>>>
>>> torch.utils._pytree.tree_map(check, pytree, pytree_recon)
>>> assert weird_key in pytree_recon[1]

classmethod from_struct_array(struct_array: ndarray, device: Optional[device] = None) → T¶

將結構化的 numpy 陣列轉換為 TensorDict。

產生的 TensorDict 的內容將與 numpy 陣列共享相同的記憶體內容（這是零複製操作）。就地變更結構化的 numpy 陣列的值將會影響 TensorDict 的內容。

範例

>>> x = np.array(
...     [("Rex", 9, 81.0), ("Fido", 3, 27.0)],
...     dtype=[("name", "U10"), ("age", "i4"), ("weight", "f4")],
... )
>>> td = TensorDict.from_struct_array(x)
>>> x_recon = td.to_struct_array()
>>> assert (x_recon == x).all()
>>> assert x_recon.shape == x.shape
>>> # Try modifying x age field and check effect on td
>>> x["age"] += 1
>>> assert (td["age"] == np.array([10, 4])).all()

classmethod fromkeys(keys: List[NestedKey], value: Any = 0)¶

從鍵列表和單一值建立 tensordict。

參數:

keys (NestedKey 的列表) – 指定新字典鍵的可迭代物件。
value (相容類型, 選用) – 所有鍵的值。預設為 0。

gather(dim: int, index: Tensor, out: Optional[T] = None) → T¶

沿著 dim 指定的軸收集值。

參數:

dim (int) – 收集元素的維度
index (torch.Tensor) – 一個 long tensor，其維度數量與 tensordict 的維度數量相符，且兩者只有一個維度不同（收集維度）。其元素指向沿所需維度收集的索引。
out (TensorDictBase, 選用) – 目標 tensordict。它必須具有與索引相同的形狀。

範例

>>> td = TensorDict(
...     {"a": torch.randn(3, 4, 5),
...      "b": TensorDict({"c": torch.zeros(3, 4, 5)}, [3, 4, 5])},
...     [3, 4])
>>> index = torch.randint(4, (3, 2))
>>> td_gather = td.gather(dim=1, index=index)
>>> print(td_gather)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3, 2, 5]), device=cpu, dtype=torch.float32, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([3, 2, 5]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3, 2, 5]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3, 2]),
    device=None,
    is_shared=False)

Gather 會保留維度名稱。

範例

>>> td.names = ["a", "b"]
>>> td_gather = td.gather(dim=1, index=index)
>>> td_gather.names
["a", "b"]

gather_and_stack(dst: int, group: 'dist.ProcessGroup' | None = None) → T | None¶

從各種工作節點收集 tensordict，並將它們堆疊到目標工作節點上的 self 中。

參數:

dst (int) – 目的地 worker 的排序，gather_and_stack() 將在此被呼叫。
group (torch.distributed.ProcessGroup, optional) – 如果有設定，指定的 process group 將會被用於通訊。否則，預設的 process group 將會被使用。預設值為 None。

範例

>>> from torch import multiprocessing as mp
>>> from tensordict import TensorDict
>>> import torch
>>>
>>> def client():
...     torch.distributed.init_process_group(
...         "gloo",
...         rank=1,
...         world_size=2,
...         init_method=f"tcp://127.0.0.1:10003",
...     )
...     # Create a single tensordict to be sent to server
...     td = TensorDict(
...         {("a", "b"): torch.randn(2),
...          "c": torch.randn(2)}, [2]
...     )
...     td.gather_and_stack(0)
...
>>> def server():
...     torch.distributed.init_process_group(
...         "gloo",
...         rank=0,
...         world_size=2,
...         init_method=f"tcp://127.0.0.1:10003",
...     )
...     # Creates the destination tensordict on server.
...     # The first dim must be equal to world_size-1
...     td = TensorDict(
...         {("a", "b"): torch.zeros(2),
...          "c": torch.zeros(2)}, [2]
...     ).expand(1, 2).contiguous()
...     td.gather_and_stack(0)
...     assert td["a", "b"] != 0
...     print("yuppie")
...
>>> if __name__ == "__main__":
...     mp.set_start_method("spawn")
...
...     main_worker = mp.Process(target=server)
...     secondary_worker = mp.Process(target=client)
...
...     main_worker.start()
...     secondary_worker.start()
...
...     main_worker.join()
...     secondary_worker.join()

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

取得輸入鍵所儲存的值。

參數:

key (str, tuple of str) – 要查詢的鍵。如果是 str 的 tuple，則相當於鏈式呼叫 getattr。
default –
如果在 tensordict 中找不到鍵時，則使用預設值。

警告

目前，如果 tensordict 中不存在鍵且未傳遞任何預設值，則會引發 KeyError。從 v0.7 開始，此行為將會變更為改為傳回 None 值。若要採用新行為，請設定環境變數 export TD_GET_DEFAULTS_TO_NONE=’1’ 或呼叫 :func`~tensordict.set_get_defaults_to_none`。

範例

>>> td = TensorDict({"x": 1}, batch_size=[])
>>> td.get("x")
tensor(1)
>>> set_get_defaults_to_none(False) # Current default behaviour
>>> td.get("y") # Raises KeyError
>>> set_get_defaults_to_none(True)
>>> td.get("y")
None

get_at(key: NestedKey, index: Union[None, int, slice, str, Tensor, List[Any], Tuple[Any, ...]], default: Tensor = _NoDefault.ZERO) → Tensor¶

從索引 idx 處的鍵 key 取得 tensordict 的值。

參數:

key (str, tuple of str) – 要擷取的鍵。
index (int, slice, torch.Tensor, iterable) – tensor 的索引。
default (torch.Tensor) – 如果 tensordict 中不存在鍵，則傳回的預設值。

回傳值:

索引化的 tensor。

範例

>>> td = TensorDict({"x": torch.arange(3)}, batch_size=[])
>>> td.get_at("x", index=1)
tensor(1)

get_item_shape(key: NestedKey)¶: 傳回條目的形狀，可能會避免遞迴到 get()。

get_non_tensor(key: NestedKey, default=_NoDefault.ZERO)¶

取得非 tensor 值（如果存在），如果找不到非 tensor 值，則取得 default。

此方法對於 tensor/TensorDict 值具有強大的適應性，這意味著如果收集的值是常規 tensor，也會傳回它（雖然此方法會產生一些額外負擔，不應超出其自然範圍使用）。

如需有關如何在 tensordict 中設定非 tensor 值的詳細資訊，請參閱 set_non_tensor()。

參數:

key (NestedKey) – NonTensorData 物件的位置。
default (Any, optional) – 如果找不到鍵，則傳回的值。

傳回值：tensordict.tensorclass.NonTensorData 的內容，: 或對應於 key 的條目（如果它不是 tensordict.tensorclass.NonTensorData），如果找不到條目，則返回 default。

範例

>>> data = TensorDict({}, batch_size=[])
>>> data.set_non_tensor(("nested", "the string"), "a string!")
>>> assert data.get_non_tensor(("nested", "the string")) == "a string!"
>>> # regular `get` works but returns a NonTensorData object
>>> data.get(("nested", "the string"))
NonTensorData(
    data='a string!',
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

屬性 grad¶: 返回一個包含葉張量 .grad 屬性的 tensordict。

half()¶: 將所有張量轉換為 torch.half。

int()¶: 將所有張量轉換為 torch.int。

int16()¶: 將所有張量轉換為 torch.int16。

int32()¶: 將所有張量轉換為 torch.int32。

int64()¶: 將所有張量轉換為 torch.int64。

int8()¶: 將所有張量轉換為 torch.int8。

irecv(src: int, *, group: 'dist.ProcessGroup' | None = None, return_premature: bool = False, init_tag: int = 0, pseudo_rand: bool = False) → tuple[int, list[torch.Future]] | list[torch.Future] | None¶

非同步接收 tensordict 的內容並更新內容。

查看 isend() 方法中的範例以取得上下文。

參數:

src (int) – 來源工作站的等級。

關鍵字引數:

group (torch.distributed.ProcessGroup, optional) – 如果有設定，指定的 process group 將會被用於通訊。否則，預設的 process group 將會被使用。預設值為 None。
return_premature (bool) – 如果 True，則返回一個 futures 清單，以等待 tensordict 更新。預設為 False，即等待更新在呼叫中完成。
init_tag (int) – 來源工作站使用的 init_tag。
pseudo_rand (bool) – 如果為 True，標籤的序列將是偽隨機的，允許從不同的節點發送多個資料而不會重疊。請注意，這些偽隨機數的產生非常耗時 (1e-5 sec/number)，這意味著它可能會降低演算法的運行時間。此值必須與傳遞給 isend() 的值相符。預設為 False。

回傳值:

如果 return_premature=True，則為一個等待直到 tensordict 更新的 futures 清單。: 直到 tensordict 更新。

is_consolidated()¶: 檢查 TensorDict 是否具有合併的儲存空間。

is_contiguous() → bool¶: 返回一個布林值，指示所有張量是否連續。

is_empty()¶: 檢查 tensordict 是否包含任何葉節點。

is_memmap() → bool¶

檢查 tensordict 是否為記憶體映射。

如果 TensorDict 實例是記憶體映射的，它會被鎖定（條目無法重新命名、移除或新增）。如果使用所有記憶體映射的 tensors 建立 TensorDict，這並不代表 is_memmap 會回傳 True（因為新的 tensor 可能是也可能不是記憶體映射的）。只有在呼叫 tensordict.memmap_() 之後，tensordict 才被視為記憶體映射的。

對於 CUDA 裝置上的 tensordicts 而言，這永遠是 True。

is_shared() → bool¶

檢查 tensordict 是否位於共享記憶體中。

如果 TensorDict 實例位於共享記憶體中，它會被鎖定（條目無法重新命名、移除或新增）。如果使用所有位於共享記憶體中的 tensors 建立 TensorDict，這並不代表 is_shared 會回傳 True（因為新的 tensor 可能是也可能不是位於共享記憶體中）。只有在呼叫 tensordict.share_memory_() 或將 tensordict 放置在預設共享內容的裝置上（例如，"cuda"），tensordict 才被視為位於共享記憶體中。

對於 CUDA 裝置上的 tensordicts 而言，這永遠是 True。

isend(dst: int, *, group: 'dist.ProcessGroup' | None = None, init_tag: int = 0, pseudo_rand: bool = False) → int¶

非同步傳送 tensordict 的內容。

參數:

dst (int) – 應傳送內容的目的工作站的排名。

關鍵字引數:

group (torch.distributed.ProcessGroup, optional) – 如果有設定，指定的 process group 將會被用於通訊。否則，預設的 process group 將會被使用。預設值為 None。
init_tag (int) – 用於標記 tensors 的初始標籤。請注意，這將增加 TensorDict 中包含的 tensors 數量。
pseudo_rand (bool) – 如果為 True，標籤序列將是偽隨機的，允許從不同節點傳送多個資料而不會重疊。請注意，產生這些偽隨機數的成本很高 (1e-5 sec/number)，這意味著它可能會降低演算法的執行時間。預設為 False。

範例

>>> import torch
>>> from tensordict import TensorDict
>>> from torch import multiprocessing as mp
>>> def client():
...     torch.distributed.init_process_group(
...         "gloo",
...         rank=1,
...         world_size=2,
...         init_method=f"tcp://127.0.0.1:10003",
...     )
...
...     td = TensorDict(
...         {
...             ("a", "b"): torch.randn(2),
...             "c": torch.randn(2, 3),
...             "_": torch.ones(2, 1, 5),
...         },
...         [2],
...     )
...     td.isend(0)
...
>>>
>>> def server(queue, return_premature=True):
...     torch.distributed.init_process_group(
...         "gloo",
...         rank=0,
...         world_size=2,
...         init_method=f"tcp://127.0.0.1:10003",
...     )
...     td = TensorDict(
...         {
...             ("a", "b"): torch.zeros(2),
...             "c": torch.zeros(2, 3),
...             "_": torch.zeros(2, 1, 5),
...         },
...         [2],
...     )
...     out = td.irecv(1, return_premature=return_premature)
...     if return_premature:
...         for fut in out:
...             fut.wait()
...     assert (td != 0).all()
...     queue.put("yuppie")
...
>>>
>>> if __name__ == "__main__":
...     queue = mp.Queue(1)
...     main_worker = mp.Process(
...         target=server,
...         args=(queue, )
...         )
...     secondary_worker = mp.Process(target=client)
...
...     main_worker.start()
...     secondary_worker.start()
...     out = queue.get(timeout=10)
...     assert out == "yuppie"
...     main_worker.join()
...     secondary_worker.join()

isfinite() → T¶

回傳一個新的 tensordict，其中包含布林元素，表示每個元素是否為有限值。

當實數值不是 NaN、負無窮大或無窮大時，它們是有限值。當複數的實部和虛部都是有限值時，它們是有限值。

isnan() → T¶

回傳一個新的 tensordict，其中包含布林元素，表示輸入的每個元素是否為 NaN。

當複數的實部和/或虛部為 NaN 時，該複數被視為 NaN。

isneginf() → T¶: 測試輸入的每個元素是否為負無窮大。

isposinf() → T¶: 測試輸入的每個元素是否為負無窮大。

isreal() → T¶: 回傳一個新的 tensordict，其中包含布林元素，表示輸入的每個元素是否為實數值。

items(include_nested: bool = False, leaves_only: bool = False, is_leaf: Optional[Callable[[Type], bool]] = None, *, sort: bool = False) → Iterator[tuple[str, torch.Tensor]]¶

傳回 tensordict 的鍵值配對產生器。

參數:

include_nested (bool, optional) – 如果 True，將會傳回巢狀值。預設值為 False。
leaves_only (bool, optional) – 如果 False，只會傳回葉節點。預設值為 False。
is_leaf – 一個可選的可呼叫物件，用於指示一個類別是否應被視為葉節點。

關鍵字引數:

sort (bool, optional) – 是否應該排序鍵。對於巢狀鍵，鍵會根據它們的連接名稱進行排序（例如，("a", "key") 將會被計為 "a.key" 以進行排序）。請注意，在處理大型 tensordict 時，排序可能會產生顯著的額外負擔。預設值為 False。

keys(include_nested: bool = False, leaves_only: bool = False, is_leaf: Optional[Callable[[Type], bool]] = None, *, sort: bool = False) → _TensorDictKeysView¶

傳回 tensordict 鍵的產生器。

警告

TensorDict 的 keys() 方法傳回鍵的延遲視圖。如果查詢了 keys 但沒有對其進行迭代，然後修改了 tensordict，則稍後迭代鍵將會傳回鍵的新配置。

參數:

include_nested (bool, optional) – 如果 True，將會傳回巢狀值。預設值為 False。
leaves_only (bool, optional) – 如果 False，只會傳回葉節點。預設值為 False。
is_leaf – 一個可選的可呼叫物件，用於指示一個類別是否應被視為葉節點。

關鍵字引數:

sort (bool, optional) – 是否應該排序鍵。對於巢狀鍵，鍵會根據它們的連接名稱進行排序（例如，("a", "key") 將會被計為 "a.key" 以進行排序）。請注意，在處理大型 tensordict 時，排序可能會產生顯著的額外負擔。預設值為 False。

範例

>>> from tensordict import TensorDict
>>> data = TensorDict({"0": 0, "1": {"2": 2}}, batch_size=[])
>>> data.keys()
['0', '1']
>>> list(data.keys(leaves_only=True))
['0']
>>> list(data.keys(include_nested=True, leaves_only=True))
['0', '1', ('1', '2')]

classmethod lazy_stack(input, dim=0, *, out=None, **kwargs)¶

建立 tensordict 的延遲堆疊。

詳情請參閱 lazy_stack()。

lerp(end: tensordict.base.TensorDictBase | torch.Tensor, weight: tensordict.base.TensorDictBase | torch.Tensor | float)¶

根據純量或張量 weight，對兩個張量 start (由 self 提供) 和 end 進行線性插值。

\[\text{out}_i = \text{start}_i + \text{weight}_i \times (\text{end}_i - \text{start}_i)\]

start 和 end 的形狀必須是可以廣播的。如果 weight 是一個張量，那麼 weight、start 和 end 的形狀必須是可以廣播的。

參數:

end (TensorDict) – 具有終點的 tensordict。
weight (TensorDict, tensor 或 float) – 插值公式的權重。

lerp_(end: tensordict.base.TensorDictBase | float, weight: tensordict.base.TensorDictBase | float)¶: lerp() 的原地 (in-place) 版本。

lgamma() → T¶: 計算 TensorDict 中每個元素的 lgamma() 值。

lgamma_() → T¶: 計算 TensorDict 中每個元素的 lgamma() 值 (原地)。

classmethod load(prefix: str | pathlib.Path, *args, **kwargs) → T¶

從磁碟載入一個 tensordict。

這個類別方法是 load_memmap() 的代理。

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

將 tensordict 從磁碟載入到目前的 tensordict 中。

這個類別方法是 load_memmap_() 的代理。

classmethod load_memmap(prefix: str | pathlib.Path, device: Optional[device] = None, non_blocking: bool = False, *, out: Optional[TensorDictBase] = None) → T¶

從磁碟載入 memory-mapped tensordict。

參數:

prefix (str 或 資料夾路徑 (Path to folder)) – 應從該路徑提取已儲存 tensordict 的資料夾路徑。
device (torch.device 或 等效物件, 選用) – 如果提供，資料將被非同步轉換到該裝置。支援 “meta” 裝置，在這種情況下，不會載入資料，而是建立一組空的 “meta” tensors。這對於了解總體模型大小和結構很有用，而無需實際打開任何檔案。
non_blocking (bool, 選用) – 如果 True，則在將 tensors 載入到裝置後，將不會呼叫 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()

此方法也允許載入巢狀 tensordicts。

範例

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

tensordict 也可以載入到 “meta” 裝置上，或者作為假張量 (fake tensor)。

範例

>>> 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_memmap_(prefix: str | pathlib.Path)¶

將 memory-mapped tensordict 的內容載入到呼叫 load_memmap_ 的 tensordict 中。

有關更多資訊，請參閱 load_memmap()。

load_state_dict(state_dict: OrderedDict[str, Any], strict=True, assign=False, from_flatten=False) → T¶

將 state-dict（格式如 state_dict() 中）載入到 tensordict 中。

參數:

state_dict (OrderedDict) – 要複製的 state_dict。
strict (bool, 選用) – 是否嚴格強制執行 state_dict 中的鍵與此 tensordict 的 torch.nn.Module.state_dict() 函數傳回的鍵是否匹配。預設值：True
assign (bool, 選用) – 是否將 state dictionary 中的項目分配給 tensordict 中的相應鍵，而不是將它們就地複製到 tensordict 的當前 tensors 中。當 False 時，會保留目前模組中 tensors 的屬性，而當 True 時，會保留 state dict 中 tensors 的屬性。預設值：False
from_flatten (bool, 選用) – 如果 True，則假定輸入的 state_dict 已被扁平化。預設為 False。

範例

>>> data = TensorDict({"1": 1, "2": 2, "3": {"3": 3}}, [])
>>> data_zeroed = TensorDict({"1": 0, "2": 0, "3": {"3": 0}}, [])
>>> sd = data.state_dict()
>>> data_zeroed.load_state_dict(sd)
>>> print(data_zeroed["3", "3"])
tensor(3)
>>> # with flattening
>>> data_zeroed = TensorDict({"1": 0, "2": 0, "3": {"3": 0}}, [])
>>> data_zeroed.load_state_dict(data.state_dict(flatten=True), from_flatten=True)
>>> print(data_zeroed["3", "3"])
tensor(3)

lock_() → T¶

鎖定 tensordict 以進行非 in-place 操作。

諸如 set()、__setitem__()、update()、rename_key_() 等新增或移除條目的函式或其他操作將會被阻擋。

這個方法可以作為裝飾器使用。

範例

>>> from tensordict import TensorDict
>>> td = TensorDict({"a": 1, "b": 2, "c": 3}, batch_size=[])
>>> with td.lock_():
...     assert td.is_locked
...     try:
...         td.set("d", 0) # error!
...     except RuntimeError:
...         print("td is locked!")
...     try:
...         del td["d"]
...     except RuntimeError:
...         print("td is locked!")
...     try:
...         td.rename_key_("a", "d")
...     except RuntimeError:
...         print("td is locked!")
...     td.set("a", 0, inplace=True)  # No storage is added, moved or removed
...     td.set_("a", 0) # No storage is added, moved or removed
...     td.update({"a": 0}, inplace=True)  # No storage is added, moved or removed
...     td.update_({"a": 0})  # No storage is added, moved or removed
>>> assert not td.is_locked

log() → T¶: 計算 TensorDict 中每個元素的 log() 值。

log10() → T¶: 計算 TensorDict 中每個元素的 log10() 值。

log10_() → T¶: 就地 (in-place) 計算 TensorDict 中每個元素的 log10() 值。

log1p() → T¶: 計算 TensorDict 中每個元素的 log1p() 值。

log1p_() → T¶: 就地 (in-place) 計算 TensorDict 中每個元素的 log1p() 值。

log2() → T¶: 計算 TensorDict 中每個元素的 log2() 值。

log2_() → T¶: 就地 (in-place) 計算 TensorDict 中每個元素的 log2() 值。

log_() → T¶: 就地 (in-place) 計算 TensorDict 中每個元素的 log() 值。

make_memmap(key: NestedKey, shape: torch.Size | torch.Tensor, *, dtype: Optional[dtype] = None) → MemoryMappedTensor¶

根據形狀 (shape) 及可能的資料類型 (dtype) 建立一個空的記憶體對應張量。

警告

此方法的設計本質上並非鎖定安全 (lock-safe)。存在於多個節點上的記憶體對應 TensorDict 實例，需要使用 memmap_refresh_() 方法進行更新。

寫入現有條目將導致錯誤。

參數:

key (NestedKey) – 要寫入的新條目的鍵。如果該鍵已存在於 tensordict 中，則會引發例外。
shape (torch.Size 或等效項，巢狀張量的 torch.Tensor) – 要寫入的張量的形狀。

關鍵字引數:

dtype (torch.dtype，可選) – 新張量的資料類型。

回傳值:

一個新的記憶體對應張量。

make_memmap_from_storage(key: NestedKey, storage: UntypedStorage, shape: torch.Size | torch.Tensor, *, dtype: Optional[dtype] = None) → MemoryMappedTensor¶

給定一個 storage、shape 和 dtype（可選），建立一個空的記憶體映射張量。

警告

此方法的設計本質上並非鎖定安全 (lock-safe)。存在於多個節點上的記憶體對應 TensorDict 實例，需要使用 memmap_refresh_() 方法進行更新。

注意

如果 storage 有關聯的檔名，則必須與該檔案的新檔名相符。如果 storage 沒有關聯的檔名，但 tensordict 有關聯的路徑，則會導致例外情況。

參數:

key (NestedKey) – 要寫入的新條目的鍵。如果該鍵已存在於 tensordict 中，則會引發例外。
storage (torch.UntypedStorage) – 用於新 MemoryMappedTensor 的 storage。必須為實體記憶體 storage。
shape (torch.Size 或等效項，巢狀張量的 torch.Tensor) – 要寫入的張量的形狀。

關鍵字引數:

dtype (torch.dtype，可選) – 新張量的資料類型。

回傳值:

一個具有給定 storage 的新記憶體映射張量。

make_memmap_from_tensor(key: NestedKey, tensor: Tensor, *, copy_data: bool = True, existsok: bool = True) → MemoryMappedTensor¶

給定一個張量，建立一個空的記憶體映射張量。

警告

此方法的設計本質上並非鎖定安全 (lock-safe)。存在於多個節點上的記憶體對應 TensorDict 實例，需要使用 memmap_refresh_() 方法進行更新。

如果 copy_data 為 True，此方法始終複製 storage 內容（即 storage 不共享）。

參數:

key (NestedKey) – 要寫入的新條目的鍵。如果該鍵已存在於 tensordict 中，則會引發例外。
tensor (torch.Tensor) – 要在實體記憶體上複製的張量。

關鍵字引數:

copy_data (bool, optionaL) – 如果 False，則新的張量將共享輸入的中繼資料，例如 shape 和 dtype，但內容將為空。預設值為 True。

回傳值:

一個具有給定 storage 的新記憶體映射張量。

map(fn: Callable[[TensorDictBase], TensorDictBase | None], dim: int = 0, num_workers: int | None = None, *, out: TensorDictBase | None = None, chunksize: int | None = None, num_chunks: int | None = None, pool: mp.Pool | None = None, generator: torch.Generator | None = None, max_tasks_per_child: int | None = None, worker_threads: int = 1, index_with_generator: bool = False, pbar: bool = False, mp_start_method: str | None = None)¶

將函式映射到 tensordict 在單一維度上的分割。

此方法會將 tensordict 實例分割成大小相等的 tensordict，並將操作分派到所需數量的 worker，藉此將函式應用於該 tensordict 實例。

函式簽章應為 Callabe[[TensorDict], Union[TensorDict, Tensor]]。輸出必須支援 torch.cat() 操作。該函式必須可序列化。

注意

當處理儲存在磁碟上的大型資料集（例如，記憶體映射的 tensordict）時，此方法特別有用，因為 chunk 將會是原始資料的零複製切片，並且可以近乎零成本地傳遞到各個程序。這使得能夠以極低的成本處理非常大的資料集（例如，超過 Tb 大小）。

參數:

fn (callable) – 要應用於 tensordict 的函式。支援類似於 Callabe[[TensorDict], Union[TensorDict, Tensor]] 的簽章。
dim (int, optional) – 將 tensordict 分割的維度。
num_workers (int, optional) – worker 的數量。與 pool 互斥。如果未提供，worker 的數量將設定為可用 CPU 的數量。

關鍵字引數:

out (TensorDictBase, optional) – 輸出的可選容器。沿著提供的 dim 維度的批次大小必須與 self.ndim 相符。如果它是共享的或記憶體映射的（is_shared() 或 is_memmap() 返回 True），它將在遠端進程中填充，避免資料的內部傳輸。否則，來自 self 切片的資料將被發送到該進程，在當前進程中收集，並就地寫入 out。
chunksize (int, optional) – 每個資料塊的大小。chunksize 為 0 將沿著所需的維度解綁 tensordict，並在應用該函數後重新堆疊它，而 chunksize>0 將拆分 tensordict 並在生成的 tensordict 列表上調用 torch.cat()。如果未提供，則資料塊的數量將等於 worker 的數量。對於非常大的 tensordict，這麼大的資料塊可能無法放入記憶體中以完成操作，可能需要更多的資料塊才能使操作在實際上可行。此參數與 num_chunks 互斥。
num_chunks (int, optional) – 將 tensordict 分割成的資料塊數量。如果未提供，則資料塊的數量將等於 worker 的數量。對於非常大的 tensordict，這麼大的資料塊可能無法放入記憶體中以完成操作，可能需要更多的資料塊才能使操作在實際上可行。此參數與 chunksize 互斥。
pool (mp.Pool, optional) – 用於執行任務的多進程 Pool 實例。如果未提供，將在 map 方法中創建一個 pool。
generator (torch.Generator, optional) –
用於設定種子的產生器。將從中生成一個基本種子，並且 pool 的每個 worker 將使用提供的種子加上從 0 到 num_workers 的唯一整數來設定種子。如果未提供產生器，則將使用隨機整數作為種子。為了與未設定種子的 worker 一起使用，應該單獨創建一個 pool 並直接傳遞給 map()。

注意

提供低值的種子時應謹慎，因為這可能導致實驗之間的自相關，例如：如果請求了 8 個 worker 並且種子是 4，則 worker 的種子範圍將從 4 到 11。如果種子是 5，則 worker 的種子範圍將從 5 到 12。這兩個實驗將有 7 個種子的重疊，這可能對結果產生意想不到的影響。

注意

設定 worker 種子的目的是在每個 worker 上擁有獨立的種子，而不是在 map 方法的呼叫中獲得可重現的結果。換句話說，兩個實驗可能並且很可能會返回不同的結果，因為無法知道哪個 worker 會選擇哪個任務。但是，我們可以確保每個 worker 都有不同的種子，並且每個 worker 上的偽隨機操作將是不相關的。
max_tasks_per_child (int, optional) – 每個子進程選取的最大任務數。默認值為 None，即對任務數沒有限制。
worker_threads (int, optional) – worker 的執行緒數。預設值為 1。
index_with_generator (bool, optional) – 如果為 True，則 tensordict 的分割/分塊將在查詢期間完成，從而節省初始化時間。請注意，chunk() 和 split() 比索引（在產生器中使用）效率高得多，因此在初始化時間節省處理時間可能會對總運行時間產生負面影響。預設值為 False。
pbar (bool, optional) – 如果為 True，將顯示進度條。需要提供 tqdm。預設值為 False。
mp_start_method (str, optional) – 多進程的啟動方法。如果未提供，將使用預設啟動方法。接受的字串為 "fork" 和 "spawn"。請記住，"cuda" 張量不能在使用 "fork" 啟動方法的進程之間共享。如果將 pool 傳遞給 map 方法，則此設定無效。

範例

>>> import torch
>>> from tensordict import TensorDict
>>>
>>> def process_data(data):
...     data.set("y", data.get("x") + 1)
...     return data
>>> if __name__ == "__main__":
...     data = TensorDict({"x": torch.zeros(1, 1_000_000)}, [1, 1_000_000]).memmap_()
...     data = data.map(process_data, dim=1)
...     print(data["y"][:, :10])
...
tensor([[1., 1., 1., 1., 1., 1., 1., 1., 1., 1.]])

map_iter(fn: Callable[[TensorDictBase], TensorDictBase | None], dim: int = 0, num_workers: int | None = None, *, shuffle: bool = False, chunksize: int | None = None, num_chunks: int | None = None, pool: mp.Pool | None = None, generator: torch.Generator | None = None, max_tasks_per_child: int | None = None, worker_threads: int = 1, index_with_generator: bool = True, pbar: bool = False, mp_start_method: str | None = None)¶

將函數以迭代方式映射到 tensordict 在一個維度上的分割。

這是 map() 的可迭代版本。

此方法會將函數應用於 tensordict 實例，方法是將其分塊成大小相等的 tensordict，並將操作分派到所需數量的 worker 上。它會一次產生一個結果。

函數簽章應為 Callabe[[TensorDict], Union[TensorDict, Tensor]]。該函數必須可序列化。

注意

當處理儲存在磁碟上的大型資料集（例如，記憶體映射的 tensordict）時，此方法特別有用，因為 chunk 將會是原始資料的零複製切片，並且可以近乎零成本地傳遞到各個程序。這使得能夠以極低的成本處理非常大的資料集（例如，超過 Tb 大小）。

注意

此函數可用於表示數據集並從中加載，以類似 dataloader 的方式。

參數:

fn (callable) – 要應用於 tensordict 的函式。支援類似於 Callabe[[TensorDict], Union[TensorDict, Tensor]] 的簽章。
dim (int, optional) – 將 tensordict 分割的維度。
num_workers (int, optional) – worker 的數量。與 pool 互斥。如果未提供，worker 的數量將設定為可用 CPU 的數量。

關鍵字引數:

shuffle (bool, optional) – 指示是否應全局洗牌索引。如果為 True，則每個批次都將包含非連續樣本。如果 index_with_generator=False 且 shuffle=True`，則會引發錯誤。預設值為 False。
chunksize (int, optional) – 每個資料塊的大小。chunksize 為 0 將沿著所需的維度解綁 tensordict，並在應用該函數後重新堆疊它，而 chunksize>0 將拆分 tensordict 並在生成的 tensordict 列表上調用 torch.cat()。如果未提供，則資料塊的數量將等於 worker 的數量。對於非常大的 tensordict，這麼大的資料塊可能無法放入記憶體中以完成操作，可能需要更多的資料塊才能使操作在實際上可行。此參數與 num_chunks 互斥。
num_chunks (int, optional) – 將 tensordict 分割成的資料塊數量。如果未提供，則資料塊的數量將等於 worker 的數量。對於非常大的 tensordict，這麼大的資料塊可能無法放入記憶體中以完成操作，可能需要更多的資料塊才能使操作在實際上可行。此參數與 chunksize 互斥。
pool (mp.Pool, optional) – 用於執行任務的多進程 Pool 實例。如果未提供，將在 map 方法中創建一個 pool。
generator (torch.Generator, optional) –
用於設定種子的產生器。將從中生成一個基本種子，並且 pool 的每個 worker 將使用提供的種子加上從 0 到 num_workers 的唯一整數來設定種子。如果未提供產生器，則將使用隨機整數作為種子。為了與未設定種子的 worker 一起使用，應該單獨創建一個 pool 並直接傳遞給 map()。

注意

提供低值的種子時應謹慎，因為這可能導致實驗之間的自相關，例如：如果請求了 8 個 worker 並且種子是 4，則 worker 的種子範圍將從 4 到 11。如果種子是 5，則 worker 的種子範圍將從 5 到 12。這兩個實驗將有 7 個種子的重疊，這可能對結果產生意想不到的影響。

注意

設定 worker 種子的目的是在每個 worker 上擁有獨立的種子，而不是在 map 方法的呼叫中獲得可重現的結果。換句話說，兩個實驗可能並且很可能會返回不同的結果，因為無法知道哪個 worker 會選擇哪個任務。但是，我們可以確保每個 worker 都有不同的種子，並且每個 worker 上的偽隨機操作將是不相關的。
max_tasks_per_child (int, optional) – 每個子進程選取的最大任務數。默認值為 None，即對任務數沒有限制。
worker_threads (int, optional) – worker 的執行緒數。預設值為 1。
index_with_generator (bool, optional) –
如果 True，則 tensordict 的分割/分塊將在查詢期間完成，從而節省初始化時間。請注意，chunk() 和 split() 比索引（在 generator 中使用）效率更高，因此在初始化時節省處理時間可能會對總運行時間產生負面影響。預設值為 True。

注意

index_with_generator 的預設值對於 map_iter 和 map 而言是不同的，前者假設在記憶體中儲存分割版本的 TensorDict 的成本非常高。
pbar (bool, optional) – 如果為 True，將顯示進度條。需要提供 tqdm。預設值為 False。
mp_start_method (str, optional) – 多進程的啟動方法。如果未提供，將使用預設啟動方法。接受的字串為 "fork" 和 "spawn"。請記住，"cuda" 張量不能在使用 "fork" 啟動方法的進程之間共享。如果將 pool 傳遞給 map 方法，則此設定無效。

範例

>>> import torch
>>> from tensordict import TensorDict
>>>
>>> def process_data(data):
...     data.unlock_()
...     data.set("y", data.get("x") + 1)
...     return data
>>> if __name__ == "__main__":
...     data = TensorDict({"x": torch.zeros(1, 1_000_000)}, [1, 1_000_000]).memmap_()
...     for sample in data.map_iter(process_data, dim=1, chunksize=5):
...         print(sample["y"])
...         break
...
tensor([[1., 1., 1., 1., 1.]])

masked_fill(mask: Tensor, value: float | bool) → T¶

masked_fill 的異地版本。

參數:

mask (boolean torch.Tensor) – 要填充的值的遮罩。形狀必須與 tensordict 的 batch-size 相符。
value – 用於填充張量的值。

回傳值:

self

範例

>>> td = TensorDict(source={'a': torch.zeros(3, 4)},
...     batch_size=[3])
>>> mask = torch.tensor([True, False, False])
>>> td1 = td.masked_fill(mask, 1.0)
>>> td1.get("a")
tensor([[1., 1., 1., 1.],
        [0., 0., 0., 0.],
        [0., 0., 0., 0.]])

masked_fill_(mask: Tensor, value: float | int | bool) → T¶

使用所需的值填充與遮罩對應的值。

參數:

mask (boolean torch.Tensor) – 要填充的值的遮罩。形狀必須與 tensordict 的 batch-size 相符。
value – 用於填充張量的值。

回傳值:

self

範例

>>> td = TensorDict(source={'a': torch.zeros(3, 4)},
...     batch_size=[3])
>>> mask = torch.tensor([True, False, False])
>>> td.masked_fill_(mask, 1.0)
>>> td.get("a")
tensor([[1., 1., 1., 1.],
        [0., 0., 0., 0.],
        [0., 0., 0., 0.]])

masked_select(mask: Tensor) → T¶

遮罩 TensorDict 的所有張量，並傳回一個新的 TensorDict 實例，該實例具有指向遮罩值的相似鍵。

參數:: mask (torch.Tensor) – 用於張量的布林遮罩。形狀必須與 TensorDict 的 batch_size 相符。

範例

>>> td = TensorDict(source={'a': torch.zeros(3, 4)},
...    batch_size=[3])
>>> mask = torch.tensor([True, False, False])
>>> td_mask = td.masked_select(mask)
>>> td_mask.get("a")
tensor([[0., 0., 0., 0.]])

maximum(other: tensordict.base.TensorDictBase | torch.Tensor, *, default: Optional[Union[str, Tensor]] = None) → T¶

計算 self 和 other 的元素級最大值。

參數:: other (TensorDict 或 Tensor) – 另一個輸入 tensordict 或 tensor。
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

maximum_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: maximum() 的原地版本。

注意

原地 maximum 不支援 default 關鍵字引數。

classmethod maybe_dense_stack(input, dim=0, *, out=None, **kwargs)¶

嘗試建立 tensordict 的密集堆疊，並在需要時回退到惰性堆疊。

有關詳細資訊，請參閱 maybe_dense_stack()。

mean(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, dtype: Optional[dtype] = None, reduce: Optional[bool] = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有元素的平均值。

參數:

dim (int, int 的元組, optional) – 如果 None，則傳回一個無維度的 tensordict，其中包含所有葉節點的平均值（如果可以計算）。如果是整數或整數元組，則僅當此維度與 tensordict 形狀相容時，才會對指定的維度呼叫 mean。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

dtype (torch.dtype, optional) – 傳回張量所需之資料類型。如果指定，則在執行運算之前，輸入張量會先轉換為 dtype。這對於防止資料類型溢位很有用。預設值： None。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

memmap(prefix: Optional[str] = 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 中的項目已經是儲存在磁碟上的張量，且具有關聯的檔案，但未根據前綴儲存在正確的位置，則會引發例外。如果 True，任何現有的張量將被複製到新的位置。

關鍵字引數:

num_threads (int, optional) – 用於寫入記憶體對應張量的執行緒數目。預設值為 0。
return_early (bool, optional) – 如果 True 且 num_threads>0，則方法將傳回 tensordict 的 future。
share_non_tensor (bool, optional) – 如果 True，則非 Tensor 資料將在各個程序之間共享，並且在單一節點內的任何 worker 上進行寫入操作（例如原地更新或設定）將會更新所有其他 worker 上的值。如果非 Tensor 葉節點的數量很多（例如，共享大量的非 Tensor 資料堆疊），這可能會導致記憶體不足 (OOM) 或類似的錯誤。預設值為 False。
existsok (bool, optional) – 如果 False，如果 Tensor 已經存在於相同的路徑中，則會引發例外。預設值為 True。

然後 TensorDict 會被鎖定，表示任何非原地 (in-place) 的寫入操作都會拋出例外（例如，重新命名、設定或移除項目）。一旦 tensordict 被解鎖，memory-mapped 屬性會變更為 False，因為跨程序的識別已不再保證。

回傳值:: 如果 return_early=False，則會產生一個新的 tensordict，其 Tensor 儲存在磁碟上，否則會產生一個 TensorDictFuture 實例。

注意

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

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

將所有 Tensor 原地寫入到對應的記憶體對應 Tensor。

參數:

prefix (str) – 儲存記憶體對應張量的目錄前綴。目錄樹狀結構將模仿 tensordict 的結構。
copy_existing (bool) – 如果為 False（預設值），如果 tensordict 中的項目已經是儲存在磁碟上的張量，且具有關聯的檔案，但未根據前綴儲存在正確的位置，則會引發例外。如果 True，任何現有的張量將被複製到新的位置。

關鍵字引數:

num_threads (int, optional) – 用於寫入記憶體對應張量的執行緒數目。預設值為 0。
return_early (bool, optional) – 如果 True 且 num_threads>0，則該方法將傳回 tensordict 的 future。可以使用 future.result() 查詢產生的 tensordict。
share_non_tensor (bool, optional) – 如果 True，則非 Tensor 資料將在各個程序之間共享，並且在單一節點內的任何 worker 上進行寫入操作（例如原地更新或設定）將會更新所有其他 worker 上的值。如果非 Tensor 葉節點的數量很多（例如，共享大量的非 Tensor 資料堆疊），這可能會導致記憶體不足 (OOM) 或類似的錯誤。預設值為 False。
existsok (bool, optional) – 如果 False，如果 Tensor 已經存在於相同的路徑中，則會引發例外。預設值為 True。

然後 TensorDict 會被鎖定，表示任何非原地 (in-place) 的寫入操作都會拋出例外（例如，重新命名、設定或移除項目）。一旦 tensordict 被解鎖，memory-mapped 屬性會變更為 False，因為跨程序的識別已不再保證。

回傳值:: 如果 return_early=False，則傳回 self，否則傳回 TensorDictFuture 實例。

注意

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

memmap_like(prefix: Optional[str] = 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 中的項目已經是儲存在磁碟上的張量，且具有關聯的檔案，但未根據前綴儲存在正確的位置，則會引發例外。如果 True，任何現有的張量將被複製到新的位置。

關鍵字引數:

num_threads (int, optional) – 用於寫入記憶體對應張量的執行緒數目。預設值為 0。
return_early (bool, optional) – 如果 True 且 num_threads>0，則方法將傳回 tensordict 的 future。
share_non_tensor (bool, optional) – 如果 True，則非 Tensor 資料將在各個程序之間共享，並且在單一節點內的任何 worker 上進行寫入操作（例如原地更新或設定）將會更新所有其他 worker 上的值。如果非 Tensor 葉節點的數量很多（例如，共享大量的非 Tensor 資料堆疊），這可能會導致記憶體不足 (OOM) 或類似的錯誤。預設值為 False。
existsok (bool, optional) – 如果 False，如果 Tensor 已經存在於相同的路徑中，則會引發例外。預設值為 True。

然後 TensorDict 會被鎖定，表示任何非原地 (in-place) 的寫入操作都會拋出例外（例如，重新命名、設定或移除項目）。一旦 tensordict 被解鎖，memory-mapped 屬性會變更為 False，因為跨程序的識別已不再保證。

回傳值:: 如果 return_early=False，則會產生一個新的 TensorDict 實例，其資料儲存為記憶體對應 Tensor，否則會產生一個 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_()¶

如果 memory-mapped tensordict 有 saved_path，則重新整理其內容。

如果沒有路徑與其關聯，此方法將引發例外。

minimum(other: tensordict.base.TensorDictBase | torch.Tensor, *, default: Optional[Union[str, Tensor]] = None) → T¶

計算 self 和 other 的元素級最小值。

參數:: other (TensorDict 或 Tensor) – 另一個輸入 tensordict 或 tensor。
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

minimum_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: minimum() 的原地 (in-place) 版本。

注意

Inplace minimum 不支援 default 關鍵字引數。

mul(other: tensordict.base.TensorDictBase | torch.Tensor, *, default: Optional[Union[str, Tensor]] = None) → T¶

將 other 乘以 self。

\[\text{{out}}_i = \text{{input}}_i \times \text{{other}}_i\]

支援廣播 (broadcasting)、型別提升 (type promotion) 以及整數、浮點數和複數輸入。

參數:: other (TensorDict, Tensor 或 Number) – 要從 self 減去的張量 (tensor) 或數字。
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

mul_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: mul() 的原地 (in-place) 版本。

注意

Inplace mul 不支援 default 關鍵字引數。

named_apply(fn: Callable, *others: T, nested_keys: bool = False, batch_size: Optional[Sequence[int]] = None, device: torch.device | None = _NoDefault.ZERO, names: Optional[Sequence[str]] = _NoDefault.ZERO, inplace: bool = False, default: Any = _NoDefault.ZERO, filter_empty: Optional[bool] = None, propagate_lock: bool = False, call_on_nested: bool = False, out: Optional[TensorDictBase] = None, **constructor_kwargs) → Optional[T]¶

將一個鍵條件化的可呼叫物件應用於 tensordict 中儲存的所有值，並將它們設定在一個新的 atensordict 中。

該可呼叫物件的簽名必須是 Callable[Tuple[str, Tensor, ...], Optional[Union[Tensor, TensorDictBase]]]。

參數:

fn (Callable) – 要應用於 tensordict 中的 (名稱, 張量) 對的函數。對於每個葉節點，只會使用其葉節點名稱（而不是完整的 NestedKey）。
*others (TensorDictBase 實例, 選用) – 如果提供，這些 tensordict 實例的結構應該與 self 的結構相符。 fn 參數應該接收與 tensordict 數量一樣多的未命名輸入，包括 self。如果其他 tensordict 有遺漏的條目，則可以透過 default 關鍵字參數傳遞預設值。
nested_keys (bool, optional) – 如果 True，則會使用葉節點的完整路徑。預設為 False，即只將最後一個字串傳遞給函數。
batch_size (int 序列, 選用) – 如果提供，產生的 TensorDict 將具有所需的 batch_size。 batch_size 參數應該與轉換後的 batch_size 相符。這是一個僅限關鍵字的參數。
device (torch.device, 選用) – 結果的裝置 (device)，如果有的話。
names (字串列表, 選用) – 新的維度名稱，以防 batch_size 被修改。
inplace (bool, optional) – 如果為 True，則變更會就地進行。預設值為 False。這是一個僅限關鍵字的引數。
default (Any, 選用) – 其他 tensordict 中遺漏條目的預設值。如果未提供，遺漏的條目將引發 KeyError。
filter_empty (bool, optional) – 如果 True，則會濾除空的 tensordict。這也降低了計算成本，因為不會建立和銷毀空的資料結構。為了向後相容性，預設值為 False。
propagate_lock (bool, optional) – 如果 True，鎖定的 tensordict 將會產生另一個鎖定的 tensordict。預設值為 False。

call_on_nested (bool, optional) –

若為 True，則該函數會被調用於第一層的 tensors 和容器（TensorDict 或 tensorclass）。在這種情況下，func 負責將其調用傳播到巢狀層級。這樣可以在將調用傳播到巢狀 tensordict 時實現精細的行為。若為 False，則該函數只會被調用於葉節點，並且 apply 會負責將該函數分派到所有葉節點。

>>> td = TensorDict({"a": {"b": [0.0, 1.0]}, "c": [1.0, 2.0]})
>>> def mean_tensor_only(val):
...     if is_tensor_collection(val):
...         raise RuntimeError("Unexpected!")
...     return val.mean()
>>> td_mean = td.apply(mean_tensor_only)
>>> def mean_any(val):
...     if is_tensor_collection(val):
...         # Recurse
...         return val.apply(mean_any, call_on_nested=True)
...     return val.mean()
>>> td_mean = td.apply(mean_any, call_on_nested=True)

out (TensorDictBase, optional) –
一個用於寫入結果的 tensordict。這可以用來避免建立新的 tensordict
```
>>> td = TensorDict({"a": 0})
>>> td.apply(lambda x: x+1, out=td)
>>> assert (td==1).all()
```
警告

如果對 tensordict 執行的操作需要存取多個鍵才能進行單一計算，則提供一個等於 self 的 out 參數可能會導致該操作產生無提示的錯誤結果。例如
```
>>> td = TensorDict({"a": 1, "b": 1})
>>> td.apply(lambda x: x+td["a"])["b"] # Right!
tensor(2)
>>> td.apply(lambda x: x+td["a"], out=td)["b"] # Wrong!
tensor(3)
```
**constructor_kwargs – 要傳遞給 TensorDict 建構子的額外關鍵字參數。

回傳值:

一個具有 transformed_in tensors 的新 tensordict。

範例

>>> td = TensorDict({
...     "a": -torch.ones(3),
...     "nested": {"a": torch.ones(3), "b": torch.zeros(3)}},
...     batch_size=[3])
>>> def name_filter(name, tensor):
...     if name == "a":
...         return tensor
>>> td.named_apply(name_filter)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False),
        nested: TensorDict(
            fields={
                a: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)
>>> def name_filter(name, *tensors):
...     if name == "a":
...         r = 0
...         for tensor in tensors:
...             r = r + tensor
...         return tensor
>>> out = td.named_apply(name_filter, td)
>>> print(out)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False),
        nested: TensorDict(
            fields={
                a: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([3]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)
>>> print(out["a"])
tensor([-1., -1., -1.])

注意

如果函數回傳 None，則該條目會被忽略。這可以用來過濾 tensordict 中的資料

>>> td = TensorDict({"1": 1, "2": 2, "b": {"2": 2, "1": 1}}, [])
>>> def name_filter(name, tensor):
...     if name == "1":
...         return tensor
>>> td.named_apply(name_filter)
TensorDict(
    fields={
        1: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        b: TensorDict(
            fields={
                1: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

property names¶

tensordict 的維度名稱。

名稱可以在建構時使用 names 參數設定。

另請參閱 refine_names() 以了解如何在建構後設定名稱的詳細資訊。

nanmean(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, dtype: Optional[dtype] = None, reduce: Optional[bool] = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有非 NaN 元素的平均值。

參數:

dim (int, int 的元組, optional) – 如果 None，則傳回一個無維度的 tensordict，其中包含所有葉節點的平均值（如果可以計算）。如果是整數或整數元組，則僅當此維度與 tensordict 形狀相容時，才會對指定的維度呼叫 mean。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

dtype (torch.dtype, optional) – 傳回張量所需之資料類型。如果指定，則在執行運算之前，輸入張量會先轉換為 dtype。這對於防止資料類型溢位很有用。預設值： None。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

nansum(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, dtype: Optional[dtype] = None, reduce: Optional[bool] = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有非 NaN 元素的總和。

參數:

dim (int, int 的 tuple, optional) – 如果 None，則傳回一個無維度的 tensordict，其中包含所有 leaves 的總和值（如果可以計算）。如果是整數或整數的 tuple，則只有在該維度與 tensordict 形狀相容時，才會對指定的維度呼叫 sum 。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

dtype (torch.dtype, optional) – 傳回張量所需之資料類型。如果指定，則在執行運算之前，輸入張量會先轉換為 dtype。這對於防止資料類型溢位很有用。預設值： None。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

property ndim: int¶: 請參閱 batch_dims()。

ndimension() → int¶: 請參閱 batch_dims()。

neg() → T¶: 計算 TensorDict 每個元素的 neg() 值。

neg_() → T¶: 就地計算 TensorDict 每個元素的 neg() 值。

new_empty(*size: Size, dtype: Optional[dtype] = None, device: Union[device, str, int] = _NoDefault.ZERO, requires_grad: bool = False, layout: layout = torch.strided, pin_memory: Optional[bool] = None)¶

傳回一個大小為 size 且帶有空 tensors 的 TensorDict。

預設情況下，傳回的 TensorDict 具有與此 tensordict 相同的 torch.dtype 和 torch.device。

參數:

size (int...) – 一個列表、元組或 torch.Size 的整數，用於定義輸出 tensor 的形狀。

關鍵字引數:

dtype (torch.dtype, optional) – 所需的傳回 tensordict 類型。預設值：如果 None，則 torch.dtype 將保持不變。
device (torch.device, optional) – 所需的傳回 tensordict 裝置。預設值：如果 None，則 torch.device 將保持不變。
requires_grad (bool, optional) – 如果 autograd 應該記錄傳回的 tensors 上的操作。預設值：False。
layout (torch.layout, optional) – 所需的傳回 TensorDict 值的 layout。預設值：torch.strided。
pin_memory (bool, optional) – 如果設定，傳回的 tensor 將被分配在 pinned memory 中。僅適用於 CPU tensors。預設值：False。

new_full(size: Size, fill_value, *, dtype: Optional[dtype] = None, device: Union[device, str, int] = _NoDefault.ZERO, requires_grad: bool = False, layout: layout = torch.strided, pin_memory: Optional[bool] = None)¶

傳回一個大小為 size 且填滿 1 的 TensorDict。

預設情況下，傳回的 TensorDict 具有與此 tensordict 相同的 torch.dtype 和 torch.device。

參數:

size (整數序列) – 定義輸出張量形狀的整數列表、元組或 torch.Size。
fill_value (純量) – 用於填充輸出張量的數字。

關鍵字引數:

dtype (torch.dtype, optional) – 所需的傳回 tensordict 類型。預設值：如果 None，則 torch.dtype 將保持不變。
device (torch.device, optional) – 所需的傳回 tensordict 裝置。預設值：如果 None，則 torch.device 將保持不變。
requires_grad (bool, optional) – 如果 autograd 應該記錄傳回的 tensors 上的操作。預設值：False。
layout (torch.layout, optional) – 所需的傳回 TensorDict 值的 layout。預設值：torch.strided。
pin_memory (bool, optional) – 如果設定，傳回的 tensor 將被分配在 pinned memory 中。僅適用於 CPU tensors。預設值：False。

new_ones(*size: Size, dtype: Optional[dtype] = None, device: Union[device, str, int] = _NoDefault.ZERO, requires_grad: bool = False, layout: layout = torch.strided, pin_memory: Optional[bool] = None)¶

傳回一個大小為 size 且填滿 1 的 TensorDict。

預設情況下，傳回的 TensorDict 具有與此 tensordict 相同的 torch.dtype 和 torch.device。

參數:

size (int...) – 一個列表、元組或 torch.Size 的整數，用於定義輸出 tensor 的形狀。

關鍵字引數:

dtype (torch.dtype, optional) – 所需的傳回 tensordict 類型。預設值：如果 None，則 torch.dtype 將保持不變。
device (torch.device, optional) – 所需的傳回 tensordict 裝置。預設值：如果 None，則 torch.device 將保持不變。
requires_grad (bool, optional) – 如果 autograd 應該記錄傳回的 tensors 上的操作。預設值：False。
layout (torch.layout, optional) – 所需的傳回 TensorDict 值的 layout。預設值：torch.strided。
pin_memory (bool, optional) – 如果設定，傳回的 tensor 將被分配在 pinned memory 中。僅適用於 CPU tensors。預設值：False。

new_tensor(data: torch.Tensor | tensordict.base.TensorDictBase, *, dtype: Optional[dtype] = None, device: Union[device, str, int] = _NoDefault.ZERO, requires_grad: bool = False, pin_memory: Optional[bool] = None)¶

傳回一個新的 TensorDict，其資料為張量 data。

預設情況下，傳回的 TensorDict 值具有與此張量相同的 torch.dtype 和 torch.device。

data 也可以是張量集合（TensorDict 或 tensorclass），在這種情況下，new_tensor 方法會迭代 self 和 data 的張量對。

參數:

data (torch.Tensor 或 TensorDictBase) – 要複製的資料。

關鍵字引數:

dtype (torch.dtype, optional) – 所需的傳回 tensordict 類型。預設值：如果 None，則 torch.dtype 將保持不變。
device (torch.device, optional) – 所需的傳回 tensordict 裝置。預設值：如果 None，則 torch.device 將保持不變。
requires_grad (bool, optional) – 如果 autograd 應該記錄傳回的 tensors 上的操作。預設值：False。
pin_memory (bool, optional) – 如果設定，傳回的 tensor 將被分配在 pinned memory 中。僅適用於 CPU tensors。預設值：False。

new_zeros(*size: Size, dtype: Optional[dtype] = None, device: Union[device, str, int] = _NoDefault.ZERO, requires_grad: bool = False, layout: layout = torch.strided, pin_memory: Optional[bool] = None)¶

傳回一個大小為 size 並以 0 填充的 TensorDict。

預設情況下，傳回的 TensorDict 具有與此 tensordict 相同的 torch.dtype 和 torch.device。

參數:

size (int...) – 一個列表、元組或 torch.Size 的整數，用於定義輸出 tensor 的形狀。

關鍵字引數:

dtype (torch.dtype, optional) – 所需的傳回 tensordict 類型。預設值：如果 None，則 torch.dtype 將保持不變。
device (torch.device, optional) – 所需的傳回 tensordict 裝置。預設值：如果 None，則 torch.device 將保持不變。
requires_grad (bool, optional) – 如果 autograd 應該記錄傳回的 tensors 上的操作。預設值：False。
layout (torch.layout, optional) – 所需的傳回 TensorDict 值的 layout。預設值：torch.strided。
pin_memory (bool, optional) – 如果設定，傳回的 tensor 將被分配在 pinned memory 中。僅適用於 CPU tensors。預設值：False。

non_tensor_items(include_nested: bool = False)¶: 傳回所有非張量葉節點，可以遞迴處理。

norm(*, out=None, dtype: torch.dtype | None = None)¶

計算 tensordict 中每個 tensor 的範數。

關鍵字引數:

out (TensorDict, optional) – 輸出 tensordict。
dtype (torch.dtype, optional) – 輸出資料類型 (torch>=2.4)。

numel() → int¶

批次中元素的總數。

下限為 1，因為具有空形狀的兩個 tensordict 的堆疊將有兩個元素，因此我們認為 tensordict 至少有 1 個元素大。

numpy()¶

將 tensordict 轉換為 numpy 陣列的（可能是巢狀的）字典。

非 tensor 資料會以其原始形式呈現。

範例

>>> from tensordict import TensorDict
>>> import torch
>>> data = TensorDict({"a": {"b": torch.zeros(()), "c": "a string!"}})
>>> print(data)
TensorDict(
    fields={
        a: TensorDict(
            fields={
                b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
                c: NonTensorData(data=a string!, batch_size=torch.Size([]), device=None)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> print(data.numpy())
{'a': {'b': array(0., dtype=float32), 'c': 'a string!'}}

param_count(*, count_duplicates: bool = True) → int¶

計算參數的數量（可索引項目的總數），僅計算 tensor。

關鍵字引數:: count_duplicates (bool) – 是否將重複的張量視為獨立的張量。如果 False，則只會丟棄嚴格相同的張量（來自共同基礎張量的相同視圖但具有不同 ID 將被計算兩次）。預設值為 True（假設每個張量都是單一副本）。

permute(*args, **kwargs)¶

傳回一個 tensordict 的視圖，其批次維度根據 dims 重新排列。

參數:

*dims_list (int) – tensordict 批次維度的新排序。或者，可以提供一個整數的單一可迭代物件。
dims (list of int) – 調用 permute(…) 的替代方法。

回傳值:

一個新的 tensordict，其批次維度按所需順序排列。

範例

>>> tensordict = TensorDict({"a": torch.randn(3, 4, 5)}, [3, 4])
>>> print(tensordict.permute([1, 0]))
PermutedTensorDict(
    source=TensorDict(
        fields={
            a: Tensor(torch.Size([3, 4, 5]), dtype=torch.float32)},
        batch_size=torch.Size([3, 4]),
        device=cpu,
        is_shared=False),
    op=permute(dims=[1, 0]))
>>> print(tensordict.permute(1, 0))
PermutedTensorDict(
    source=TensorDict(
        fields={
            a: Tensor(torch.Size([3, 4, 5]), dtype=torch.float32)},
        batch_size=torch.Size([3, 4]),
        device=cpu,
        is_shared=False),
    op=permute(dims=[1, 0]))
>>> print(tensordict.permute(dims=[1, 0]))
PermutedTensorDict(
    source=TensorDict(
        fields={
            a: Tensor(torch.Size([3, 4, 5]), dtype=torch.float32)},
        batch_size=torch.Size([3, 4]),
        device=cpu,
        is_shared=False),
    op=permute(dims=[1, 0]))

pin_memory(num_threads: Optional[int] = None, inplace: bool = False) → T¶

在儲存的 tensors 上呼叫 pin_memory()。

參數:

num_threads (int or str) – 如果提供，則用於在葉子上呼叫 pin_memory 的執行緒數。預設為 None，這會在 ThreadPoolExecutor(max_workers=None) 中設定大量執行緒。要在主執行緒上執行對 pin_memory() 的所有呼叫，請傳遞 num_threads=0。
inplace (bool, optional) – 如果 True，則就地修改 tensordict。預設為 False。

pin_memory_(num_threads: int | str = 0) → T¶

在儲存的 tensors 上呼叫 pin_memory() 並傳回就地修改的 TensorDict。

參數:: num_threads (int or str) – 如果提供，則用於在葉子上呼叫 pin_memory 的執行緒數。如果傳遞 "auto"，則會自動確定執行緒數。

pop(key: NestedKey, default: Any = _NoDefault.ZERO) → Tensor¶

從 tensordict 中移除並傳回一個值。

如果該值不存在且沒有提供預設值，則會拋出 KeyError。

參數:

key (str 或 nested key) – 要尋找的條目。
default (Any, optional) – 如果找不到鍵，則傳回的值。

範例

>>> td = TensorDict({"1": 1}, [])
>>> one = td.pop("1")
>>> assert one == 1
>>> none = td.pop("1", default=None)
>>> assert none is None

popitem() → Tuple[NestedKey, Tensor]¶

移除最後插入 TensorDict 的項目。

popitem 將只會傳回非巢狀 (non-nested) 的值。

pow(other: tensordict.base.TensorDictBase | torch.Tensor, *, default: Optional[Union[str, Tensor]] = None) → T¶

計算 self 中每個元素與 other 的次方，並傳回包含結果的 tensor。

other 可以是一個單一的 float 數字、一個 Tensor 或一個 TensorDict。

當 other 是一個 tensor 時，input 和 other 的形狀必須是可廣播的 (broadcastable)。

參數:: other (float, tensor 或 tensordict) – 指數值
關鍵字引數:: default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

pow_(other: tensordict.base.TensorDictBase | torch.Tensor) → T¶: pow() 的原地 (in-place) 版本。

注意

原地 pow 不支援 default 關鍵字引數。

prod(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, dtype: Optional[dtype] = None, reduce: Optional[bool] = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有元素的乘積。

參數:

dim (int, int 的 tuple, optional) – 如果 None，則傳回一個無維度的 tensordict，其中包含所有葉節點的乘積值（如果可以計算）。如果是整數或整數的 tuple，則僅當此維度與 tensordict 形狀相容時，才對指定的維度調用 prod。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

dtype (torch.dtype, optional) – 傳回張量所需之資料類型。如果指定，則在執行運算之前，輸入張量會先轉換為 dtype。這對於防止資料類型溢位很有用。預設值： None。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

qint32()¶: 將所有張量轉換為 torch.qint32。

qint8()¶: 將所有張量轉換為 torch.qint8。

quint4x2()¶: 將所有張量轉換為 torch.quint4x2。

quint8()¶: 將所有張量轉換為 torch.quint8。

reciprocal() → T¶: 計算 TensorDict 中每個元素的 reciprocal() 值。

reciprocal_() → T¶: 原地計算 TensorDict 中每個元素的 reciprocal() 值。

record_stream(stream: Stream)¶

將 tensordict 標記為已被此流使用。

當 tensordict 被釋放時，確保在釋放時排隊在 stream 上的所有工作完成之前，張量記憶體不會被其他張量重複使用。

有關更多資訊，請參閱 record_stream()。

recv(src: int, *, group: 'dist.ProcessGroup' | None = None, init_tag: int = 0, pseudo_rand: bool = False) → int¶

接收 tensordict 的內容並使用它更新內容。

查看 send 方法中的範例以獲取上下文。

參數:

src (int) – 來源工作站的等級。

關鍵字引數:

group (torch.distributed.ProcessGroup, optional) – 如果有設定，指定的 process group 將會被用於通訊。否則，預設的 process group 將會被使用。預設值為 None。
init_tag (int) – 來源工作站使用的 init_tag。
pseudo_rand (bool) – 如果為 True，標籤序列將會是虛擬隨機的，允許從不同節點傳送多筆資料而不會重疊。請注意，產生這些虛擬隨機數字的成本很高（1e-5 秒/數字），這意味著它可能會降低您演算法的執行速度。此值必須與傳遞給 send() 的值相符。預設值為 False。

reduce(dst, op=None, async_op=False, return_premature=False, group=None)¶

將 tensordict 在所有機器上進行縮減。

只有 rank 為 dst 的進程會收到最終結果。

refine_names(*names) → T¶

根據名稱細化 self 的維度名稱。

細化是一種特殊的重新命名，它會「提升」未命名的維度。None 維度可以被細化為具有任何名稱；命名的維度只能被細化為具有相同的名稱。

因為命名的 tensors 可以與未命名的 tensors 共存，所以細化名稱提供了一種很好的方式來編寫同時適用於命名和未命名 tensors 的命名 tensors 感知程式碼。

names 最多可以包含一個 Ellipsis (…)。Ellipsis 會被貪婪地展開；它會被就地展開，以使用來自 self.names 對應索引的名稱，將 names 填滿至與 self.dim() 相同的長度。

傳回值：與輸入一致命名的維度的相同 tensordict。

範例

>>> td = TensorDict({}, batch_size=[3, 4, 5, 6])
>>> tdr = td.refine_names(None, None, None, "d")
>>> assert tdr.names == [None, None, None, "d"]
>>> tdr = td.refine_names("a", None, None, "d")
>>> assert tdr.names == ["a", None, None, "d"]

rename(*names, **rename_map)¶

傳回具有重新命名維度的 tensordict 的複製品。

範例

>>> td = TensorDict({}, batch_size=[1, 2, 3 ,4])
>>> td.names = list("abcd")
>>> td_rename = td.rename(c="g")
>>> assert td_rename.names == list("abgd")

rename_(*names, **rename_map)¶

與 rename() 相同，但就地執行重新命名。

範例

>>> td = TensorDict({}, batch_size=[1, 2, 3 ,4])
>>> td.names = list("abcd")
>>> assert td.rename_(c="g")
>>> assert td.names == list("abgd")

rename_key_(old_key: NestedKey, new_key: NestedKey, safe: bool = False) → T¶

使用新字串重新命名鍵，並傳回具有更新鍵名稱的相同 tensordict。

參數:

old_key (str 或 巢狀鍵) – 要重新命名的鍵。
new_key (str 或 巢狀鍵) – 條目的新名稱。
safe (bool, optional) – 如果 True，當新鍵已存在於 TensorDict 中時，會拋出錯誤。

回傳值:

self

replace(*args, **kwargs)¶

建立 tensordict 的淺層複本，其中條目已被取代。

接受一個未命名的引數，該引數必須是 TensorDictBase 子類的字典。此外，可以使用命名的關鍵字引數更新第一級條目。

回傳值:: 如果輸入不為空，則傳回 self 的複本，其中包含更新的條目。如果提供空的 dict 或未提供 dict，且 kwargs 為空，則會傳回 self。

requires_grad_(requires_grad=True) → T¶

變更 autograd 是否應記錄此 tensor 上的操作：就地設定此 tensor 的 requires_grad 屬性。

傳回此 tensordict。

參數:: requires_grad (bool, optional) – autograd 是否應記錄此 tensordict 上的操作。預設值為 True。

reshape(*args, **kwargs) → T¶

返回具有所需形狀的連續、重塑的張量。

參數:: *shape (int) – 結果 tensordict 的新形狀。
回傳值:: 具有重塑鍵的 TensorDict

範例

>>> td = TensorDict({
...     'x': torch.arange(12).reshape(3, 4),
... }, batch_size=[3, 4])
>>> td = td.reshape(12)
>>> print(td['x'])
torch.Tensor([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11])

round() → T¶: 計算 TensorDict 中每個元素的 round() 值。

round_() → T¶: 就地計算 TensorDict 中每個元素的 round() 值。

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

將 tensordict 儲存到磁碟。

此函式是 memmap() 的代理。

property saved_path¶

返回儲存 memmap 已儲存的 TensorDict 的路徑。

只要 is_memmap() 返回 False（例如，當 tensordict 解鎖時），此引數就會消失。

select(*keys: NestedKey, inplace: bool = False, strict: bool = True) → T¶

選取 tensordict 的鍵，並傳回僅包含選定鍵的新 tensordict。

這些值不會被複製：對原始或新的 tensordict 的 tensor 進行就地修改將導致兩個 tensordict 都發生變化。

參數:

*keys (str) – 要選取的鍵
inplace (bool) – 如果為 True，則就地修剪 tensordict。預設值為 False。
strict (bool, optional) – 選取不存在的鍵是否會傳回錯誤。預設值：True。

回傳值:

一個新的 tensordict (如果 inplace=True，則為同一個)，僅包含選定的鍵。

注意

若要在 tensordict 中選取鍵，並傳回一個移除這些鍵的 tensordict 版本，請參閱 split_keys() 方法。

範例

>>> from tensordict import TensorDict
>>> td = TensorDict({"a": 0, "b": {"c": 1, "d": 2}}, [])
>>> td.select("a", ("b", "c"))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> td.select("a", "b")
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
                d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> td.select("this key does not exist", strict=False)
TensorDict(
    fields={
    },
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

send(dst: int, *, group: 'dist.ProcessGroup' | None = None, init_tag: int = 0, pseudo_rand: bool = False) → None¶

將 tensordict 的內容傳送給遠端工作者。

參數:

dst (int) – 應傳送內容的目的工作站的排名。

關鍵字引數:

group (torch.distributed.ProcessGroup, optional) – 如果有設定，指定的 process group 將會被用於通訊。否則，預設的 process group 將會被使用。預設值為 None。
init_tag (int) – 用於標記 tensors 的初始標籤。請注意，這將增加 TensorDict 中包含的 tensors 數量。
pseudo_rand (bool) – 如果為 True，標籤序列將是偽隨機的，允許從不同節點傳送多個資料而不會重疊。請注意，產生這些偽隨機數的成本很高 (1e-5 sec/number)，這意味著它可能會降低演算法的執行時間。預設為 False。

範例

>>> from torch import multiprocessing as mp
>>> from tensordict import TensorDict
>>> import torch
>>>
>>>
>>> def client():
...     torch.distributed.init_process_group(
...         "gloo",
...         rank=1,
...         world_size=2,
...         init_method=f"tcp://127.0.0.1:10003",
...     )
...
...     td = TensorDict(
...         {
...             ("a", "b"): torch.randn(2),
...             "c": torch.randn(2, 3),
...             "_": torch.ones(2, 1, 5),
...         },
...         [2],
...     )
...     td.send(0)
...
>>>
>>> def server(queue):
...     torch.distributed.init_process_group(
...         "gloo",
...         rank=0,
...         world_size=2,
...         init_method=f"tcp://127.0.0.1:10003",
...     )
...     td = TensorDict(
...         {
...             ("a", "b"): torch.zeros(2),
...             "c": torch.zeros(2, 3),
...             "_": torch.zeros(2, 1, 5),
...         },
...         [2],
...     )
...     td.recv(1)
...     assert (td != 0).all()
...     queue.put("yuppie")
...
>>>
>>> if __name__=="__main__":
...     queue = mp.Queue(1)
...     main_worker = mp.Process(target=server, args=(queue,))
...     secondary_worker = mp.Process(target=client)
...
...     main_worker.start()
...     secondary_worker.start()
...     out = queue.get(timeout=10)
...     assert out == "yuppie"
...     main_worker.join()
...     secondary_worker.join()

set(key: NestedKey, item: Tensor, inplace: bool = False, *, non_blocking: bool = False, **kwargs: Any) → T¶

設定新的鍵值對。

參數:

key (str, str 的 tuple) – 要設定的鍵的名稱。
item (torch.Tensor 或等效項目, TensorDictBase 實例) – 要儲存在 tensordict 中的值。
inplace (bool, optional) – 如果 True 且鍵與 tensordict 中的現有鍵匹配，則該鍵值對的更新將就地發生。如果 inplace 為 True 且找不到該條目，則會新增它。對於更嚴格的就地操作，請改用 set_()。預設值為 False。

關鍵字引數:

non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。

回傳值:

self

範例

>>> td = TensorDict({}, batch_size[3, 4])
>>> td.set("x", torch.randn(3, 4))
>>> y = torch.randn(3, 4, 5)
>>> td.set("y", y, inplace=True) # works, even if 'y' is not present yet
>>> td.set("y", torch.zeros_like(y), inplace=True)
>>> assert (y==0).all() # y values are overwritten
>>> td.set("y", torch.ones(5), inplace=True) # raises an exception as shapes mismatch

set_(key: NestedKey, item: Tensor, *, non_blocking: bool = False) → T¶

設定現有鍵的值，同時保留原始儲存空間。

參數:

key (str) – 值的名稱
item (torch.Tensor 或相容類型, TensorDictBase) – 要儲存在 tensordict 中的值

關鍵字引數:

non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。

回傳值:

self

範例

>>> td = TensorDict({}, batch_size[3, 4])
>>> x = torch.randn(3, 4)
>>> td.set("x", x)
>>> td.set_("x", torch.zeros_like(x))
>>> assert (x == 0).all()

set_at_(key: NestedKey, value: Tensor, index: Union[None, int, slice, str, Tensor, List[Any], Tuple[Any, ...]], *, non_blocking: bool = False) → T¶

在 index 指示的索引處就地設定值。

參數:

key (str, str 的 tuple) – 要修改的鍵。
value (torch.Tensor) – 要在索引 index 處設定的值
index ( int, tensor 或 tuple) – 寫入值的索引。

關鍵字引數:

non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。

回傳值:

self

範例

>>> td = TensorDict({}, batch_size[3, 4])
>>> x = torch.randn(3, 4)
>>> td.set("x", x)
>>> td.set_at_("x", value=torch.ones(1, 4), index=slice(1))
>>> assert (x[0] == 1).all()

set_non_tensor(key: NestedKey, value: Any)¶

使用 tensordict.tensorclass.NonTensorData 在 tensordict 中註冊一個非 tensor 值。

該值可以使用 TensorDictBase.get_non_tensor() 檢索，或直接使用 get 檢索，後者會回傳 tensordict.tensorclass.NonTensorData 物件。

return: self

範例

>>> data = TensorDict({}, batch_size=[])
>>> data.set_non_tensor(("nested", "the string"), "a string!")
>>> assert data.get_non_tensor(("nested", "the string")) == "a string!"
>>> # regular `get` works but returns a NonTensorData object
>>> data.get(("nested", "the string"))
NonTensorData(
    data='a string!',
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

setdefault(key: NestedKey, default: Tensor, inplace: bool = False) → Tensor¶

如果 key 不在 tensordict 中，則插入一個 key 條目，其值為 default。

如果 key 在 tensordict 中，則回傳 key 的值，否則回傳 default。

參數:

key ( str 或 nested key) – 值的名稱。
default ( torch.Tensor 或 相容的類型, TensorDictBase) – 如果鍵尚未存在，則要儲存在 tensordict 中的值。

回傳值:

tensordict 中鍵的值。如果先前未設定該鍵，則將為預設值。

範例

>>> td = TensorDict({}, batch_size=[3, 4])
>>> val = td.setdefault("a", torch.zeros(3, 4))
>>> assert (val == 0).all()
>>> val = td.setdefault("a", torch.ones(3, 4))
>>> assert (val == 0).all() # output is still 0

property shape: Size¶: 請參閱 batch_size。

share_memory_() → T¶

將所有 tensors 放置在共享記憶體中。

然後 TensorDict 會被鎖定，這意味著任何非 in-place 的寫入操作都會拋出例外（例如，重新命名、設定或移除一個條目）。相反地，一旦 tensordict 被解鎖，share_memory 屬性就會變更為 False，因為不再保證跨程序的識別。

回傳值:: self

sigmoid() → T¶: 計算 TensorDict 中每個元素的 sigmoid() 值。

sigmoid_() → T¶: In-place 計算 TensorDict 中每個元素的 sigmoid() 值。

sign() → T¶: 計算 TensorDict 中每個元素的 sign() 值。

sign_() → T¶: In-place 計算 TensorDict 中每個元素的 sign() 值。

sin() → T¶: 計算 TensorDict 中每個元素的 sin() 值。

sin_() → T¶: In-place 計算 TensorDict 中每個元素的 sin() 值。

sinh() → T¶: 計算 TensorDict 中每個元素的 sinh() 值。

sinh_() → T¶: 原地 (in-place) 計算 TensorDict 中每個元素的 sinh() 值。

size(dim: Optional[int] = None) → torch.Size | int¶

返回 dim 指示的維度的大小。

如果未指定 dim，則返回 TensorDict 的 batch_size 屬性。

property sorted_keys: list[tensordict._nestedkey.NestedKey]¶

返回按字母順序排序的鍵 (keys)。

不支持額外的參數。

如果 TensorDict 被鎖定，則鍵會被緩存，直到 TensorDict 被解鎖以加快執行速度。

split(split_size: int | list[int], dim: int = 0) → list[tensordict.base.TensorDictBase]¶

像 torch.split 一樣，使用指定的大小在給定的維度中分割 TensorDict 中的每個張量 (tensor)。

返回一個 TensorDict 實例列表，其中包含分割區塊項目的視圖 (view)。

參數:

split_size (int 或 List(int)) – 單個區塊的大小，或每個區塊的大小列表。
dim (int) – 沿其分割張量的維度。

回傳值:

一個 TensorDict 列表，其中包含給定維度中指定的大小。

範例

>>> td = TensorDict({
...     'x': torch.arange(12).reshape(3, 4),
... }, batch_size=[3, 4])
>>> td0, td1 = td.split([1, 2], dim=0)
>>> print(td0['x'])
torch.Tensor([[0, 1, 2, 3]])

split_keys(*key_sets, inplace=False, strict: bool = True, reproduce_struct: bool = False)¶

將 tensordict 分割成給定的一組或多組鍵 (keys) 的子集。

該方法將返回 N+1 個 tensordict，其中 N 是提供的參數的數量。

參數:

inplace (bool, optional) – 如果 True，則鍵會從 self 中原地移除。預設為 False。
strict (bool, optional) – 如果 True，則在缺少鍵時會引發異常。預設為 True。
reproduce_struct (bool, optional) – 如果 True，所有回傳的 tensordict 都會有跟 self 一樣的樹狀結構，即使有些子 tensordict 不包含任何葉節點。

注意

None 非張量的值將會被忽略且不會被回傳。

注意

此方法不會檢查所提供的列表中是否有重複的項目。

範例

>>> td = TensorDict(
...     a=0,
...     b=0,
...     c=0,
...     d=0,
... )
>>> td_a, td_bc, td_d = td.split_keys(["a"], ["b", "c"])
>>> print(td_bc)

sqrt()¶: 計算 self 的逐元素平方根。

sqrt_()¶: sqrt() 的原地 (in-place) 版本。

squeeze(*args, **kwargs)¶

壓縮介於 -self.batch_dims+1 和 self.batch_dims-1 之間的所有維度的張量，並將它們回傳在一個新的 tensordict 中。

參數:: dim (Optional[int]) – 要沿其壓縮的維度。如果 dim 是 None，則所有 singleton 維度都將被壓縮。預設值為 None。

範例

>>> td = TensorDict({
...     'x': torch.arange(24).reshape(3, 1, 4, 2),
... }, batch_size=[3, 1, 4])
>>> td = td.squeeze()
>>> td.shape
torch.Size([3, 4])
>>> td.get("x").shape
torch.Size([3, 4, 2])

此操作也可以用作上下文管理器。對原始 tensordict 的更改將發生在外部 (out-place)，也就是說，原始張量的內容將不會被更改。這也假設 tensordict 沒有被鎖定（否則，需要解鎖 tensordict）。此功能與隱式壓縮不相容。

>>> td = TensorDict({
...     'x': torch.arange(24).reshape(3, 1, 4, 2),
... }, batch_size=[3, 1, 4])
>>> with td.squeeze(1) as tds:
...     tds.set("y", torch.zeros(3, 4))
>>> assert td.get("y").shape == [3, 1, 4]

classmethod stack(input, dim=0, *, out=None)¶

沿給定維度將 tensordict 堆疊到單個 tensordict 中。

此呼叫等效於呼叫 torch.stack()，但與 torch.compile 相容。

stack_from_tensordict(dim: int = 0, *, sorted: Optional[Union[bool, List[NestedKey]]] = None, out: Tensor = None) → Tensor¶

將 tensordict 的所有條目堆疊到單個張量中。

參數:

dim (int, optional) – 條目應沿其堆疊的維度。

關鍵字引數:

sorted (bool or list of NestedKeys) – 如果 True，條目將按字母順序堆疊。如果 False（預設），將使用 dict 順序。或者，可以提供金鑰名稱列表，並且張量將相應地堆疊。這會產生一些額外負擔，因為將針對 tensordict 中的葉名稱列表檢查金鑰列表。
out (torch.Tensor, optional) – stack 操作的可選目標張量。

stack_tensors(*keys: NestedKey, out_key: NestedKey, dim: int = 0, keep_entries: bool = False) → T¶

將條目堆疊到一個新條目中，並可能刪除原始值。

參數:: keys (sequence of NestedKey) – 要堆疊的條目。

關鍵字引數

out_key (NestedKey): 堆疊輸入的新金鑰名稱。 keep_entries (bool, optional): 如果 False，則 keys 中的條目將被刪除。

預設為 False。

dim (int, optional): 堆疊必須沿其發生的維度。: 預設為 0。

傳回：self

範例

>>> td = TensorDict(a=torch.zeros(()), b=torch.ones(()))
>>> td.stack_tensors("a", "b", out_key="c")
>>> assert "a" not in td
>>> assert (td["c"] == torch.tensor([0, 1])).all()

state_dict(destination=None, prefix='', keep_vars=False, flatten=False) → OrderedDict[str, Any]¶

從 tensordict 產生一個 state_dict。

state_dict 的結構仍然會是巢狀的，除非 flatten 設定為 True。

tensordict state_dict 包含重建 tensordict 所需的所有 tensors 和 meta-data（目前不支援名稱）。

參數:

destination (dict, optional) – 如果提供，tensordict 的狀態將更新到 dict 中，並傳回相同的物件。否則，將建立並傳回一個 OrderedDict。預設值：None。
prefix (str, optional) – 添加到 tensor 名稱的前綴，用於組成 state_dict 中的鍵。預設值：''。
keep_vars (bool, optional) – 預設情況下，在 state dict 中傳回的 torch.Tensor 項目會與 autograd 分離。如果設定為 True，則不會執行分離。預設值：False。
flatten (bool, optional) – 是否應使用 "." 字元來展平結構。預設為 False。

範例

>>> data = TensorDict({"1": 1, "2": 2, "3": {"3": 3}}, [])
>>> sd = data.state_dict()
>>> print(sd)
OrderedDict([('1', tensor(1)), ('2', tensor(2)), ('3', OrderedDict([('3', tensor(3)), ('__batch_size', torch.Size([])), ('__device', None)])), ('__batch_size', torch.Size([])), ('__device', None)])
>>> sd = data.state_dict(flatten=True)
OrderedDict([('1', tensor(1)), ('2', tensor(2)), ('3.3', tensor(3)), ('__batch_size', torch.Size([])), ('__device', None)])

std(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, correction: int = 1, reduce: Optional[bool] = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有元素的標準差值。

參數:

dim (int, int 的 tuple, optional) – 如果為 None，則傳回一個無維度的 tensordict，其中包含所有 leaves 的總和值（如果可以計算）。如果為整數或整數的 tuple，則僅當此維度與 tensordict 形狀相容時，才對指定的維度呼叫 std。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

correction (int) – 樣本大小與樣本自由度之間的差異。預設為 Bessel 的校正，correction=1。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

sub(other: tensordict.base.TensorDictBase | float, *, alpha: Optional[float] = None, default: Optional[Union[str, Tensor]] = None)¶

從 self 減去 other，並將其乘以 alpha。

\[\text{{out}}_i = \text{{input}}_i - \text{{alpha}} \times \text{{other}}_i\]

支援廣播 (broadcasting)、型別提升 (type promotion) 以及整數、浮點數和複數輸入。

參數:

other (TensorDict, Tensor 或 Number) – 要從 self 減去的張量 (tensor) 或數字。

關鍵字引數:

alpha (Number) – other 的乘數。
default ( torch.Tensor 或 str, 可選) – 用於獨佔條目的預設值。如果未提供，則兩個 TensorDict 的鍵列表必須完全匹配。如果傳遞 default="intersection"，則僅考慮相交的鍵集，其他鍵將被忽略。在所有其他情況下，default 將用於運算符號兩側所有缺失的條目。

sub_(other: tensordict.base.TensorDictBase | float, alpha: Optional[float] = None)¶: sub() 的原地 (in-place) 版本。

注意

原地 sub 不支援 default 關鍵字引數。

sum(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, dtype: Optional[dtype] = None, reduce: bool = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有元素的總和值。

參數:

dim (int, int 的 tuple, optional) – 如果 None，則傳回一個無維度的 tensordict，其中包含所有 leaves 的總和值（如果可以計算）。如果是整數或整數的 tuple，則只有在該維度與 tensordict 形狀相容時，才會對指定的維度呼叫 sum 。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

dtype (torch.dtype, optional) – 傳回張量所需之資料類型。如果指定，則在執行運算之前，輸入張量會先轉換為 dtype。這對於防止資料類型溢位很有用。預設值： None。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

tan() → T¶: 計算 TensorDict 中每個元素的 tan() 值。

tan_() → T¶: 計算 TensorDict 中每個元素的 tan() 值，並原地 (in-place) 執行。

tanh() → T¶: 計算 TensorDict 中每個元素的 tanh() 值。

tanh_() → T¶: 就地計算 TensorDict 中每個元素的 tanh() 值。

to(*args, **kwargs) → T¶

將 TensorDictBase 子類別映射到另一個裝置、dtype 或另一個 TensorDictBase 子類別 (如果允許)。

不允許將 tensors 轉換為新的 dtype，因為 tensordicts 並不一定包含單一 tensor dtype。

參數:

device (torch.device, optional) – tensordict 期望的裝置。
dtype (torch.dtype, optional) – tensordict 期望的浮點數或複數 dtype。
tensor (torch.Tensor, optional) – Tensor，其 dtype 和裝置是此 TensorDict 中所有 tensors 期望的 dtype 和裝置。

關鍵字引數:

non_blocking (bool, optional) – 操作是否應為 blocking。
memory_format (torch.memory_format, optional) – 此 tensordict 中 4D 參數和緩衝區的期望記憶體格式。
batch_size (torch.Size, optional) – 輸出 tensordict 的結果 batch-size。
other (TensorDictBase, optional) –
TensorDict 實例，其 dtype 和裝置是此 TensorDict 中所有 tensors 期望的 dtype 和裝置。

注意

由於 TensorDictBase 實例沒有 dtype，因此 dtype 是從範例 leaves 中收集的。如果有多個 dtype，則不會進行 dtype 轉換。
non_blocking_pin (bool, optional) –
如果 True，則在將 tensors 發送到裝置之前將其 pinned。這將以非同步方式完成，但可以透過 num_threads 參數進行控制。

注意

呼叫 tensordict.pin_memory().to("cuda") 通常比 tensordict.to("cuda", non_blocking_pin=True) 慢得多，因為在第二種情況下，pin_memory 是以非同步方式呼叫的。如果 tensors 很大且數量眾多，則多線程 pin_memory 通常是有益的：當要發送的 tensors 太少時，產生線程和收集資料的開銷超過了多線程的優勢，並且如果 tensors 很小，則迭代長列表的開銷也非常大。
num_threads (int or None, optional) – 如果 non_blocking_pin=True，則用於 pin_memory 的線程數。預設情況下，將會產生 max(1, torch.get_num_threads()) 個線程。 num_threads=0 將取消 pin_memory() 呼叫的任何多線程。

回傳值:

如果裝置與 tensordict 裝置不同，和/或傳遞了 dtype，則為新的 tensordict 實例。否則為相同的 tensordict。只有 batch_size 的修改才會就地完成。

注意

如果 TensorDict 已 consolidated，則產生的 TensorDict 也將被 consolidated。每個新的 tensor 將是在 consolidated 儲存上 cast 到所需裝置的 view。

範例

>>> data = TensorDict({"a": 1.0}, [], device=None)
>>> data_cuda = data.to("cuda:0")  # casts to cuda
>>> data_int = data.to(torch.int)  # casts to int
>>> data_cuda_int = data.to("cuda:0", torch.int)  # multiple casting
>>> data_cuda = data.to(torch.randn(3, device="cuda:0"))  # using an example tensor
>>> data_cuda = data.to(other=TensorDict({}, [], device="cuda:0"))  # using a tensordict example

to_dict(*, retain_none: bool = True) → dict[str, Any]¶

傳回一個字典，其鍵值對與 tensordict 的鍵值對匹配。

參數:: retain_none (bool) – 如果 True，則 tensorclass 實例中的 None 值將被寫入字典中。否則，它們將被丟棄。預設值：True。

to_h5(filename, **kwargs)¶

將 tensordict 轉換為具有 h5 backend 的 PersistentTensorDict。

參數:

filename (str or path) – h5 檔案的路徑。
device (torch.device or compatible, optional) – tensor 期望返回時所在的裝置。預設為 None (預設在 cpu 上)。
**kwargs – 傳遞給 h5py.File.create_dataset() 的 kwargs。

回傳值:

一個連結到新建立檔案的 PersitentTensorDict 實例。

範例

>>> import tempfile
>>> import timeit
>>>
>>> from tensordict import TensorDict, MemoryMappedTensor
>>> td = TensorDict({
...     "a": MemoryMappedTensor.from_tensor(torch.zeros(()).expand(1_000_000)),
...     "b": {"c": MemoryMappedTensor.from_tensor(torch.zeros(()).expand(1_000_000, 3))},
... }, [1_000_000])
>>>
>>> file = tempfile.NamedTemporaryFile()
>>> td_h5 = td.to_h5(file.name, compression="gzip", compression_opts=9)
>>> print(td_h5)
PersistentTensorDict(
    fields={
        a: Tensor(shape=torch.Size([1000000]), device=cpu, dtype=torch.float32, is_shared=False),
        b: PersistentTensorDict(
            fields={
                c: Tensor(shape=torch.Size([1000000, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([1000000]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([1000000]),
    device=None,
    is_shared=False)

to_module(module: Module, *, inplace: bool | None = None, return_swap: bool = True, swap_dest=None, use_state_dict: bool = False, non_blocking: bool = False, memo=None)¶

遞迴地將 TensorDictBase 實例的內容寫入給定的 nn.Module 屬性中。

to_module 也可以用作上下文管理器，以臨時使用一組參數/緩衝區填充模組（請參閱下面的範例）。

參數:

module (nn.Module) – 要將參數寫入的模組。

關鍵字引數:

inplace (bool, optional) – 如果為 True，則模組中的參數或張量會就地更新。預設為 False。
return_swap (bool, optional) – 如果為 True，則會傳回舊的參數配置。預設為 False。
swap_dest (TensorDictBase, optional) – 如果 return_swap 為 True，則應將交換寫入的 tensordict。
use_state_dict (bool, optional) – 如果為 True，則將使用 state-dict API 來載入參數（包括 state-dict hooks）。預設為 False。
non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。

範例

>>> from torch import nn
>>> module = nn.TransformerDecoder(
...     decoder_layer=nn.TransformerDecoderLayer(nhead=4, d_model=4),
...     num_layers=1)
>>> params = TensorDict.from_module(module)
>>> params.data.zero_()
>>> params.to_module(module)
>>> assert (module.layers[0].linear1.weight == 0).all()

將 tensordict 用作上下文管理器對於進行函數式呼叫很有用： .. rubric:: 範例

>>> from tensordict import from_module
>>> module = nn.TransformerDecoder(
...     decoder_layer=nn.TransformerDecoderLayer(nhead=4, d_model=4),
...     num_layers=1)
>>> params = TensorDict.from_module(module)
>>> params = params.data * 0 # Use TensorDictParams to remake these tensors regular nn.Parameter instances
>>> with params.to_module(module):
...     # Call the module with zeroed params
...     y = module(*inputs)
>>> # The module is repopulated with its original params
>>> assert (TensorDict.from_module(module) != 0).any()

回傳值:: 如果 return_swap 為 True，則包含模組值的 tensordict；否則為 None。

to_namedtuple(dest_cls: Optional[type] = None)¶

將 tensordict 轉換為 namedtuple。

參數:: dest_cls (Type, optional) – 要使用的可選 namedtuple 類別。

範例

>>> from tensordict import TensorDict
>>> import torch
>>> data = TensorDict({
...     "a_tensor": torch.zeros((3)),
...     "nested": {"a_tensor": torch.zeros((3)), "a_string": "zero!"}}, [3])
>>> data.to_namedtuple()
GenericDict(a_tensor=tensor([0., 0., 0.]), nested=GenericDict(a_tensor=tensor([0., 0., 0.]), a_string='zero!'))

to_padded_tensor(padding=0.0, mask_key: Optional[NestedKey] = None)¶

將所有巢狀張量轉換為填充版本，並相應地調整批次大小。

參數:

padding (float) – tensordict 中張量的填充值。預設為 0.0。
mask_key (NestedKey, optional) – 如果提供，則將寫入有效值的遮罩的金鑰。如果異質維度不是 tensordict 批次大小的一部分，則會導致錯誤。預設為 None

to_pytree()¶

將 tensordict 轉換為 PyTree。

如果 tensordict 不是從 pytree 建立的，則此方法只會傳回 self 而不進行修改。

請參閱 from_pytree() 以取得更多資訊和範例。

to_struct_array()¶

將 tensordict 轉換為 numpy 結構化陣列。

在 from_struct_array() - to_struct_array() 迴圈中，輸入和輸出陣列的內容應相符。但是，to_struct_array 不會保留原始陣列的記憶體內容。

請參閱 from_struct_array() 以取得更多資訊。

to_tensordict(*, retain_none: Optional[bool] = None) → T¶

從 TensorDictBase 回傳一個標準的 TensorDict 實例。

參數:

retain_none (bool) –

如果 True, 來自 tensorclass 實例的 None 值將會寫入 tensordict。否則，它們將被捨棄。預設值：True。

注意

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

回傳值:

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

transpose(dim0, dim1)¶

回傳一個轉置版本的 tensordict。給定的維度 dim0 和 dim1 會被交換。

對轉置 tensordict 的原地 (In-place) 或非原地 (out-place) 修改也會影響原始的 tensordict，因為記憶體是共享的，並且操作會映射回原始的 tensordict。

範例

>>> tensordict = TensorDict({"a": torch.randn(3, 4, 5)}, [3, 4])
>>> tensordict_transpose = tensordict.transpose(0, 1)
>>> print(tensordict_transpose.shape)
torch.Size([4, 3])
>>> tensordict_transpose.set("b",, torch.randn(4, 3))
>>> print(tensordict.get("b").shape)
torch.Size([3, 4])

trunc() → T¶: 計算 TensorDict 中每個元素的 trunc() 值。

trunc_() → T¶: 計算 TensorDict 中每個元素的 trunc() 值，原地 (in-place) 執行。

type(dst_type)¶

將所有 tensors 轉換為 dst_type。

參數:: dst_type (type or string) – 期望的型別

uint16()¶: 將所有 tensors 轉換為 torch.uint16。

uint32()¶: 將所有 tensors 轉換為 torch.uint32。

uint64()¶: 將所有 tensors 轉換為 torch.uint64。

uint8()¶: 將所有 tensors 轉換為 torch.uint8。

unbind(dim: int) → tuple[T, ...]¶

回傳一個沿著指定維度解綁的索引 tensordicts 的 tuple。

範例

>>> td = TensorDict({
...     'x': torch.arange(12).reshape(3, 4),
... }, batch_size=[3, 4])
>>> td0, td1, td2 = td.unbind(0)
>>> td0['x']
tensor([0, 1, 2, 3])
>>> td1['x']
tensor([4, 5, 6, 7])

unflatten(dim, unflattened_size)¶

展開 (Unflattens) 一個 tensordict 維度，將其擴展到所需的形狀。

參數:

dim (int) – 指定要展開的輸入 tensor 的維度。
unflattened_size (shape) – 是 tensordict 展開維度的新形狀。

範例

>>> td = TensorDict({
...     "a": torch.arange(60).view(3, 4, 5),
...     "b": torch.arange(12).view(3, 4)},
...     batch_size=[3, 4])
>>> td_flat = td.flatten(0, 1)
>>> td_unflat = td_flat.unflatten(0, [3, 4])
>>> assert (td == td_unflat).all()

unflatten_keys(separator: str = '.', inplace: bool = False) → T¶

將扁平的 (flat) tensordict 轉換為巢狀的 (nested) tensordict，遞迴地進行。

TensorDict的類型將會遺失，結果會變成一個簡單的TensorDict實例。巢狀tensordict的中繼資料將會從根目錄推斷：資料樹中的所有實例都將共享相同的批次大小、維度名稱和裝置。

參數:

separator (str, optional) – 巢狀項目間的分隔符號。預設為 '.'。
inplace (bool, optional) – 若為 True，則產生的 tensordict 會與呼叫所在的 tensordict 具有相同的識別項。預設為 False。

範例

>>> data = TensorDict({"a": 1, "b - c": 2, "e - f - g": 3}, batch_size=[])
>>> data.unflatten_keys(separator=" - ")
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False),
        b: TensorDict(
            fields={
                c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False),
        e: TensorDict(
            fields={
                f: TensorDict(
                    fields={
                        g: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False)},
                    batch_size=torch.Size([]),
                    device=None,
                    is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

此方法和 unflatten_keys() 在處理 state-dicts 時特別有用，因為它們可以無縫地將扁平的字典轉換為模仿模型結構的資料結構。

範例

>>> model = torch.nn.Sequential(torch.nn.Linear(3 ,4))
>>> ddp_model = torch.ao.quantization.QuantWrapper(model)
>>> state_dict = TensorDict(ddp_model.state_dict(), batch_size=[]).unflatten_keys(".")
>>> print(state_dict)
TensorDict(
    fields={
        module: TensorDict(
            fields={
                0: TensorDict(
                    fields={
                        bias: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.float32, is_shared=False),
                        weight: Tensor(shape=torch.Size([4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
                    batch_size=torch.Size([]),
                    device=None,
                    is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> model_state_dict = state_dict.get("module")
>>> print(model_state_dict)
TensorDict(
    fields={
        0: TensorDict(
            fields={
                bias: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.float32, is_shared=False),
                weight: Tensor(shape=torch.Size([4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
            batch_size=torch.Size([]),
            device=None,
            is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> model.load_state_dict(dict(model_state_dict.flatten_keys(".")))

unlock_() → T¶

解鎖 tensordict 以進行非原地 (non in-place) 操作。

可以作為裝飾器使用。

更多細節請參閱 lock_()。

unsqueeze(*args, **kwargs)¶

針對介於 -td.batch_dims 和 td.batch_dims 之間的所有維度，將所有 tensors 進行 unsqueeze 操作，並將它們回傳到一個新的 tensordict 中。

參數:: dim (int) – 要進行 unsqueeze 操作的維度。

範例

>>> td = TensorDict({
...     'x': torch.arange(24).reshape(3, 4, 2),
... }, batch_size=[3, 4])
>>> td = td.unsqueeze(-2)
>>> td.shape
torch.Size([3, 1, 4])
>>> td.get("x").shape
torch.Size([3, 1, 4, 2])

此操作也可以用作上下文管理器。對原始 tensordict 的更改將會是異地 (out-place) 發生，也就是說，原始 tensors 的內容不會被更改。這也假設 tensordict 沒有被鎖定（否則，必須先解鎖 tensordict）。

>>> td = TensorDict({
...     'x': torch.arange(24).reshape(3, 4, 2),
... }, batch_size=[3, 4])
>>> with td.unsqueeze(-2) as tds:
...     tds.set("y", torch.zeros(3, 1, 4))
>>> assert td.get("y").shape == [3, 4]

update(input_dict_or_td: Union[dict[str, torch.Tensor], T], clone: bool = False, inplace: bool = False, *, non_blocking: bool = False, keys_to_update: Optional[Sequence[NestedKey]] = None, is_leaf: Optional[Callable[[Type], bool]] = None) → T¶

使用字典或另一個 TensorDict 中的值更新 TensorDict。

參數:

input_dict_or_td (TensorDictBase 或 dict) – 要寫入 self 的輸入資料。
clone (bool, optional) – 是否應在設定前複製輸入 (tensor) 字典中的 tensors。預設為 False。
inplace (bool, optional) – 如果為 True 且鍵與 tensordict 中的現有鍵匹配，則該鍵值對的更新將會原地 (in-place) 發生。如果找不到該條目，則會新增它。預設為 False。

關鍵字引數:

keys_to_update (NestedKeys 序列, optional) – 如果有提供，則只會更新 key_to_update 中的鍵列表。目的是避免呼叫 data_dest.update(data_src.select(*keys_to_update))。
non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。
is_leaf (Callable[[Type], bool], optional) – 一個可呼叫物件，用於指示是否要將物件類型視為葉節點並進行交換，或是 tensor 集合。

回傳值:

self

範例

>>> td = TensorDict({}, batch_size=[3])
>>> a = torch.randn(3)
>>> b = torch.randn(3, 4)
>>> other_td = TensorDict({"a": a, "b": b}, batch_size=[])
>>> td.update(other_td, inplace=True) # writes "a" and "b" even though they can't be found
>>> assert td['a'] is other_td['a']
>>> other_td = other_td.clone().zero_()
>>> td.update(other_td)
>>> assert td['a'] is not other_td['a']

update_(input_dict_or_td: Union[dict[str, torch.Tensor], T], clone: bool = False, *, non_blocking: bool = False, keys_to_update: Optional[Sequence[NestedKey]] = None) → T¶

使用字典或另一個 TensorDict 的值，就地更新 TensorDict。

與 update() 不同，如果 self 不知道該鍵，此函數將拋出錯誤。

參數:

input_dict_or_td (TensorDictBase 或 dict) – 要寫入 self 的輸入資料。
clone (bool, optional) – 是否應在設定前複製輸入 (tensor) 字典中的 tensors。預設為 False。

關鍵字引數:

keys_to_update (NestedKeys 的序列, 選用) – 如果提供，則只會更新 key_to_update 中的鍵列表。這旨在避免呼叫 data_dest.update_(data_src.select(*keys_to_update))。
non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。

回傳值:

self

範例

>>> a = torch.randn(3)
>>> b = torch.randn(3, 4)
>>> td = TensorDict({"a": a, "b": b}, batch_size=[3])
>>> other_td = TensorDict({"a": a*0, "b": b*0}, batch_size=[])
>>> td.update_(other_td)
>>> assert td['a'] is not other_td['a']
>>> assert (td['a'] == other_td['a']).all()
>>> assert (td['a'] == 0).all()

update_at_(input_dict_or_td: Union[dict[str, torch.Tensor], T], idx: Union[None, int, slice, str, Tensor, List[Any], Tuple[Any, ...]], clone: bool = False, *, non_blocking: bool = False, keys_to_update: Optional[Sequence[NestedKey]] = None) → T¶

使用字典或另一個 TensorDict 的值，就地更新指定索引的 TensorDict。

與 TensorDict.update 不同，如果 TensorDict 不知道該鍵，此函數將拋出錯誤。

參數:

input_dict_or_td (TensorDictBase 或 dict) – 要寫入 self 的輸入資料。
idx (int, torch.Tensor, iterable, slice) – 應該進行更新的 tensordict 的索引。
clone (bool, optional) – 是否應在設定之前複製輸入（tensor）字典中的 tensors。預設值為 False。

關鍵字引數:

keys_to_update (NestedKeys 的序列, 選用) – 如果提供，則只會更新 key_to_update 中的鍵列表。
non_blocking (bool, optional) – 如果 True 且此複製發生在不同裝置之間，則複製可能會相對於主機以非同步方式發生。

回傳值:

self

範例

>>> td = TensorDict({
...     'a': torch.zeros(3, 4, 5),
...     'b': torch.zeros(3, 4, 10)}, batch_size=[3, 4])
>>> td.update_at_(
...     TensorDict({
...         'a': torch.ones(1, 4, 5),
...         'b': torch.ones(1, 4, 10)}, batch_size=[1, 4]),
...    slice(1, 2))
TensorDict(
    fields={
        a: Tensor(torch.Size([3, 4, 5]), dtype=torch.float32),
        b: Tensor(torch.Size([3, 4, 10]), dtype=torch.float32)},
    batch_size=torch.Size([3, 4]),
    device=None,
    is_shared=False)
>>> assert (td[1] == 1).all()

values(include_nested: bool = False, leaves_only: bool = False, is_leaf: Optional[Callable[[Type], bool]] = None, *, sort: bool = False) → Iterator[tuple[str, torch.Tensor]]¶

傳回一個產生器，表示 tensordict 的值。

參數:

include_nested (bool, optional) – 如果 True，將會傳回巢狀值。預設值為 False。
leaves_only (bool, optional) – 如果 False，只會傳回葉節點。預設值為 False。
is_leaf – 一個可選的可呼叫物件，用於指示一個類別是否應被視為葉節點。

關鍵字引數:

sort (bool, optional) – 是否應該排序鍵。對於巢狀鍵，鍵會根據它們的連接名稱進行排序（例如，("a", "key") 將會被計為 "a.key" 以進行排序）。請注意，在處理大型 tensordict 時，排序可能會產生顯著的額外負擔。預設值為 False。

var(dim: Union[int, Tuple[int]] = _NoDefault.ZERO, keepdim: bool = _NoDefault.ZERO, *, correction: int = 1, reduce: Optional[bool] = None) → tensordict.base.TensorDictBase | torch.Tensor¶

傳回輸入 tensordict 中所有元素的變異數值。

參數:

dim (int, int 的 tuple, optional) – 如果 None，則傳回一個無維度的 tensordict，其中包含所有葉節點的總和值（如果可以計算）。如果是整數或整數的 tuple，則只有在該維度與 tensordict 形狀相容時，才對指定的維度調用 var。
keepdim (bool) – 輸出張量是否保留 dim 維度。

關鍵字引數:

correction (int) – 樣本大小與樣本自由度之間的差異。預設為 Bessel 的校正，correction=1。
reduce (bool, optional) – 如果 True，將會對所有 TensorDict 值執行歸約，並傳回單一歸約張量。預設為 False。

view(*shape: int, size: list | tuple | torch.Size | None = None, batch_size: torch.Size | None = None)¶

傳回一個 tensordict，其中包含根據與 tensordict batch_size 相容的新形狀的 tensors 檢視。

或者，可以提供 dtype 作為第一個未命名的引數。在這種情況下，所有 tensors 都將以相應的 dtype 檢視。請注意，這假設新形狀將與提供的 dtype 相容。有關 dtype 檢視的更多資訊，請參閱 view()。

參數:

*shape (int) – 結果 tensordict 的新形狀。
dtype (torch.dtype) – 另一個選項是，用於表示張量內容的 dtype。
size – 可迭代物件

關鍵字引數:

batch_size (torch.Size, optional) – 如果提供了 dtype，可以使用此關鍵字引數重設 batch-size。如果使用形狀呼叫 view，則這不會產生任何影響。

回傳值:

一個具有所需 batch_size 的新 tensordict。

範例

>>> td = TensorDict(source={'a': torch.zeros(3,4,5),
...    'b': torch.zeros(3,4,10,1)}, batch_size=torch.Size([3, 4]))
>>> td_view = td.view(12)
>>> print(td_view.get("a").shape)  # torch.Size([12, 5])
>>> print(td_view.get("b").shape)  # torch.Size([12, 10, 1])
>>> td_view = td.view(-1, 4, 3)
>>> print(td_view.get("a").shape)  # torch.Size([1, 4, 3, 5])
>>> print(td_view.get("b").shape)  # torch.Size([1, 4, 3, 10, 1])

where(condition, other, *, out=None, pad=None)¶

傳回一個 TensorDict，其中的元素是根據 condition 從 self 或 other 中選取的。

參數:

condition (BoolTensor) – 當 True (非零) 時，產生 self，否則產生 other。
other (TensorDictBase 或 Scalar) – 值 (如果 other 是一個純量) 或在 condition 為 False 的索引處選取的值。

關鍵字引數:

out (TensorDictBase, optional) – 輸出 TensorDictBase 實例。
pad (scalar, optional) – 如果提供，則來源或目的地 tensordict 中遺失的鍵將寫為 torch.where(mask, self, pad) 或 torch.where(mask, pad, other)。預設值為 None，即不容許遺失的鍵。

zero_() → T¶: 就地將 tensordict 中的所有張量歸零。

zero_grad(set_to_none: bool = True) → T¶

以遞迴方式將 TensorDict 的所有梯度歸零。

參數:: set_to_none (bool, optional) – 如果 True，tensor.grad 將為 None，否則為 0。預設值為 True。

TensorDict¶

文件

教學

資源