BinaryDiscreteTensorSpec¶

class torchrl.data.BinaryDiscreteTensorSpec(*args, **kwargs)[來源]¶

torchrl.data.Binary 的已棄用版本。

assert_is_in(value: Tensor) → None¶

斷言張量是否屬於該框，否則會引發例外。

參數:: value (torch.Tensor) – 要檢查的值。

clear_device_() → T¶

所有葉節點規格的無運算 (必須具有裝置)。

對於 Composite 規格，此方法將會清除裝置。

clone() → Binary¶: 建立 TensorSpec 的副本。

contains(item: torch.Tensor | tensordict.base.TensorDictBase) → bool¶

如果數值 val 可能由 TensorSpec 產生，則傳回 True，否則傳回 False。

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

cpu()¶: 將 TensorSpec 轉換到 'cpu' 裝置。

cuda(device=None)¶: 將 TensorSpec 轉換到 'cuda' 裝置。

device: torch.device | None = None¶

encode(val: numpy.ndarray | torch.Tensor | tensordict.base.TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | tensordict.base.TensorDictBase¶

根據指定的 spec 編碼一個值，並傳回對應的 tensor。

此方法用於環境回傳一個值（例如，一個 numpy 陣列），該值可以輕鬆對應到 TorchRL 所需的網域的情況。如果該值已經是一個 tensor，則 spec 不會更改其值並按原樣傳回。

參數:: val (np.ndarray 或 torch.Tensor) – 要編碼為 tensor 的值。
關鍵字引數：: ignore_device (bool, optional) – 如果 True，則將忽略 spec 裝置。這用於在呼叫 TensorDict(..., device="cuda") 時將 tensor 轉換分組，這樣會更快。
傳回：: 符合所需 tensor 規格的 torch.Tensor。

expand(*shape)¶

傳回具有展開形狀的新 Spec。

參數:: *shape (tuple 或 int 的 iterable) – Spec 的新形狀。必須與目前的形狀可廣播：其長度必須至少與目前的形狀長度一樣長，並且其最後的值也必須相容；即，只有在目前維度是單例時，它們才能與之不同。

flatten(start_dim: int, end_dim: int) → T¶

展平一個 TensorSpec。

請查看 flatten() 以獲取有關此方法的更多資訊。

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(val: Tensor) → bool¶

如果數值 val 可能由 TensorSpec 產生，則傳回 True，否則傳回 False。

更精確地說，is_in 方法會檢查數值 val 是否在 space 屬性（框）定義的範圍內，並且 dtype、device、shape 以及可能的其他元數據是否與 spec 的匹配。如果這些檢查中任一項失敗，is_in 方法將返回 False。

參數:: val (torch.Tensor) – 要檢查的值。
傳回：: 布林值，指示數值是否屬於 TensorSpec 框。

make_neg_dim(dim: int) → T¶: 將特定維度轉換為 -1。

property ndim: int¶

Spec 形狀的維度數量。

len(spec.shape) 的捷徑。

ndimension() → int¶

Spec 形狀的維度數量。

len(spec.shape) 的捷徑。

one(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.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) → Tensor¶

回傳由該 spec 定義的空間中的隨機張量。

除非該空間無界，否則將在空間上均勻地進行採樣，在無界的情況下，將繪製常態值。

參數:: shape (torch.Size) – 隨機張量的形狀
傳回：: 在 TensorSpec 範圍內採樣的隨機張量。

reshape(*shape) → T¶

重新塑形一個 TensorSpec。

查看 reshape() 以取得關於這個方法的更多資訊。

sample(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

回傳由該 spec 定義的空間中的隨機張量。

請參閱 rand() 以了解更多細節。

squeeze(dim=None)¶

回傳一個新的 Spec，並移除所有尺寸為 1 的維度。

當提供 dim 時，僅在該維度上執行 squeeze 操作。

參數:: dim (int 或 None) – 套用 squeeze 操作的維度

to(dest: Union[dtype, device, str, int]) → Binary¶

將 TensorSpec 轉換為 device 或 dtype。

如果未進行任何更改，則回傳相同的 spec。

to_categorical(val: Tensor, safe: Optional[bool] = None) → Tensor¶: 對於 categorical，無操作。

to_categorical_spec() → Categorical¶: 對於 categorical，無操作。

to_numpy(val: Tensor, safe: Optional[bool] = None) → dict¶

回傳輸入張量對應的 np.ndarray。

這旨在作為 encode() 的反向操作。

參數:

val (torch.Tensor) – 要轉換為 numpy 的張量。
safe (bool) – 布林值，指示是否應針對 spec 的域對該值執行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

傳回：

一個 np.ndarray。

to_one_hot(val: Tensor, safe: Optional[bool] = None) → Tensor¶

將來自 spec 域的離散張量編碼為其 one-hot 對應項。

參數:

val (torch.Tensor, optional) – 要進行 one-hot 編碼的張量。
safe (bool) – 布林值，指示是否應針對 spec 的域對該值執行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

傳回：

One-hot 編碼後的張量。

範例

>>> categ = Categorical(3)
>>> categ_sample = categ.zero()
>>> categ_sample
tensor(0)
>>> onehot_sample = categ.to_one_hot(categ_sample)
>>> onehot_sample
tensor([ True, False, False])

to_one_hot_spec() → OneHot¶

將 spec 轉換為等效的 one-hot spec。

範例

>>> categ = Categorical(3)
>>> categ.to_one_hot_spec()
OneHot(
    shape=torch.Size([3]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

type_check(value: Tensor, key: Optional[NestedKey] = None) → None¶

檢查輸入值 dtype 是否符合 TensorSpec 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 運算的維度。

update_mask(mask)¶

設定一個遮罩，以防止取樣時出現某些可能的結果。

也可以在初始化 spec 期間設定遮罩。

參數:: mask (torch.Tensor or None) – 布林遮罩。如果為 None，則停用遮罩。否則，遮罩的形狀必須可擴展到等效 one-hot spec 的形狀。False 會遮罩一個結果，而 True 則會取消遮罩該結果。如果所有可能的結果都被遮罩，則在取樣時會引發錯誤。

範例

>>> mask = torch.tensor([True, False, True])
>>> ts = Categorical(3, (10,), dtype=torch.int64, mask=mask)
>>> # One of the three possible outcomes is masked
>>> ts.rand()
tensor([0, 2, 2, 0, 2, 0, 2, 2, 0, 2])

view(*shape) → T¶

重新塑形一個 TensorSpec。

查看 reshape() 以取得關於這個方法的更多資訊。

zero(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

在框中返回一個填滿零的張量。

注意

即使無法保證 0 屬於 spec 域，此方法也不會在違反此條件時引發例外。zero 的主要使用案例是產生空的資料緩衝區，而不是有意義的資料。

參數:: shape (torch.Size) – 零張量的形狀
傳回：: 在 TensorSpec 框中採樣的一個全零張量。

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 指向 zero() 的代理。

BinaryDiscreteTensorSpec¶

文件

Tutorials

Resources