LazyStackedTensorSpec¶
- class torchrl.data.LazyStackedTensorSpec(*args, **kwargs)[原始碼]¶
torchrl.data.Stacked
的已棄用版本。- assert_is_in(value: Tensor) None ¶
斷言張量是否屬於該框,否則會引發例外。
- 參數:
value (torch.Tensor) – 要檢查的值。
- clear_device_()¶
清除複合體的裝置。
- clone() T ¶
建立 TensorSpec 的副本。
- contains(item: torch.Tensor | tensordict.base.TensorDictBase) bool ¶
如果數值
val
可以由TensorSpec
產生,則回傳True
,否則回傳False
。請參閱
is_in()
以取得更多資訊。
- cpu()¶
將 TensorSpec 轉換為 'cpu' 裝置。
- cuda(device=None)¶
將 TensorSpec 轉換為 'cuda' 裝置。
- encode(val: Union[ndarray, Tensor], *, ignore_device=False) Tensor ¶
根據指定的 spec 編碼數值,並回傳對應的張量。
此方法用於回傳一個可以輕鬆對應到 TorchRL 所需網域的數值 (例如 numpy 陣列) 的環境中。 如果該值已經是張量,則 spec 不會變更其值,並原樣回傳它。
- 參數:
val (np.ndarray 或 torch.Tensor) – 要編碼為張量的數值。
- 關鍵字引數:
ignore_device (bool, optional) – 如果
True
,則會忽略 spec 裝置。 這用於在呼叫TensorDict(..., device="cuda")
時將張量轉換分組,這樣速度更快。- 回傳:
符合所需張量規範的 torch.Tensor。
- expand(*shape)¶
回傳具有擴展形狀的新 Spec。
- 參數:
*shape (tuple 或 int 的 iterable) – Spec 的新形狀。必須可與目前形狀進行廣播:其長度必須至少與目前形狀長度一樣長,並且其最後的值也必須相容;也就是說,只有在目前維度是單例時,它們才能與它不同。
- classmethod implements_for_spec(torch_function: Callable) Callable ¶
為 TensorSpec 註冊 torch 函式覆寫。
- abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: torch.Tensor | tensordict.base.TensorDictBase) torch.Tensor | tensordict.base.TensorDictBase ¶
索引輸入的張量。
- 參數:
index (int, torch.Tensor, slice 或 list) – 張量的索引
tensor_to_index – 要被索引的張量
- 回傳:
被索引的張量
- is_in(value) bool ¶
如果數值
val
可以由TensorSpec
產生,則回傳True
,否則回傳False
。更精確地說,
is_in
方法會檢查數值val
是否在space
屬性(即盒 (box))定義的範圍內,並且dtype
、device
、shape
以及潛在的其他元數據是否與 spec 的匹配。如果任何這些檢查失敗,is_in
方法將返回False
。- 參數:
val (torch.Tensor) – 要檢查的數值。
- 回傳:
布林值,表示數值是否屬於 TensorSpec 的盒。
- make_neg_dim(dim: int)¶
將特定維度轉換為
-1
。
- property ndim¶
spec 形狀的維度數量。
是
len(spec.shape)
的捷徑。
- ndimension()¶
spec 形狀的維度數量。
是
len(spec.shape)
的捷徑。
- one(shape: Optional[Size] = None) TensorDictBase ¶
返回一個在盒中填充 1 的張量。
備註
即使不能保證
1
屬於 spec 域,但此方法在違反此條件時也不會引發例外。one
的主要用例是生成空的資料緩衝區,而不是有意義的資料。- 參數:
shape (torch.Size) – one-tensor 的形狀
- 回傳:
一個在 TensorSpec 盒中採樣的填充 1 的張量。
- ones(shape: Optional[Size] = None) torch.Tensor | tensordict.base.TensorDictBase ¶
是
one()
的代理。
- project(val: torch.Tensor | tensordict.base.TensorDictBase) torch.Tensor | tensordict.base.TensorDictBase ¶
如果輸入的張量不在 TensorSpec 盒中,則會根據某些已定義的啟發式方法將其映射回盒中。
- 參數:
val (torch.Tensor) – 要映射到盒中的張量。
- 回傳:
一個屬於 TensorSpec 盒的 torch.Tensor。
- rand(shape: Optional[Size] = None) TensorDictBase ¶
回傳由 spec 定義的空間中的隨機張量。
除非該範圍是無界的,否則將在該空間上均勻地進行取樣,在無界的情況下,將繪製常態值。
- 參數:
shape (torch.Size) – 隨機張量的形狀
- 回傳:
在 TensorSpec 範圍內取樣的隨機張量。
- sample(shape: Optional[Size] = None) torch.Tensor | tensordict.base.TensorDictBase ¶
回傳由 spec 定義的空間中的隨機張量。
有關詳細資訊,請參閱
rand()
。
- squeeze(dim: Optional[int] = None)¶
回傳一個新的 Spec,其中已移除所有大小為
1
的維度。當給定
dim
時,僅在該維度上進行 squeeze 運算。- 參數:
dim (int 或 None) – 要對其應用 squeeze 運算的維度
- to_numpy(val: Tensor, safe: Optional[bool] = None) dict ¶
回傳輸入張量對應的
np.ndarray
。這旨在成為
encode()
的反向操作。- 參數:
val (torch.Tensor) – 要轉換為 numpy 的張量。
safe (bool) – 布林值,指示是否應針對 spec 的 domain 對值執行檢查。 預設為
CHECK_SPEC_ENCODE
環境變數的值。
- 回傳:
一個 np.ndarray。
- type_check(value: Tensor, key: Optional[NestedKey] = None) None ¶
根據
TensorSpec
dtype
檢查輸入值dtype
,如果它們不匹配,則會引發例外。- 參數:
value (torch.Tensor) – 要檢查其 dtype 的張量。
key (str, optional) – 如果 TensorSpec 具有鍵,則將根據指示鍵指向的 spec 檢查值 dtype。
- unflatten(dim: int, sizes: Tuple[int]) T ¶
將
TensorSpec
解扁平化。請參考
unflatten()
以獲得關於此方法的更多資訊。
- unsqueeze(dim: int)¶
返回一個新的 Spec,在
dim
所指示的位置增加一個單例維度。- 參數:
dim (int or None) – 應用 unsqueeze 操作的維度。
- zero(shape: Optional[Size] = None) TensorDictBase ¶
在框中返回一個填充零的張量。
備註
即使無法保證
0
屬於 spec 域,此方法在違反此條件時也不會引發例外。zero
的主要用例是生成空的數據緩衝區,而不是有意義的數據。- 參數:
shape (torch.Size) – 零張量的形狀
- 回傳:
在 TensorSpec 框中採樣的填充零的張量。
- zeros(shape: Optional[Size] = None) torch.Tensor | tensordict.base.TensorDictBase ¶
代理到
zero()
。