OneHotDiscreteTensorSpec

class torchrl.data.OneHotDiscreteTensorSpec(*args, **kwargs)

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

assert_is_in(value: Tensor) → None

斷言張量是否屬於此範圍，否則會引發例外。

參數:

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

clear_device_() → T

所有葉節點規格的空操作（必須具有裝置）。

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

clone() → OneHot

建立 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: Union[ndarray, Tensor], space: Optional[CategoricalBox] = None, *, ignore_device: bool = False) → Tensor

根據指定的規格編碼一個值，並傳回對應的張量。

此方法用於回傳一個值（例如 numpy 陣列）的環境，該值可以輕易地對應到 TorchRL 所需的領域。如果該值已經是一個張量，規格將不會改變其值，並原樣傳回。

參數:

val (np.ndarray 或 torch.Tensor) – 要編碼為張量的值。

關鍵字參數：

ignore_device (bool, optional) – 如果 True，規格的裝置將被忽略。 這用於在呼叫 TensorDict(..., device="cuda") 時將張量轉換分組，這樣會更快。

回傳：

符合所需張量規格的 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 函數覆寫。

index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: Tensor) → Tensor

索引輸入張量。

參數:

• 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 shape 的維度數量。

len(spec.shape) 的快捷方式。

ndimension() → int

Spec shape 的維度數量。

len(spec.shape) 的快捷方式。

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

返回邊界框中填滿 1 的 tensor。

注意

即使不能保證 1 屬於 spec 的 domain，當違反此條件時，此方法也不會引發例外。 one 的主要用例是生成空的資料緩衝區，而不是有意義的資料。

參數:

shape (torch.Size) – 填滿 1 的 tensor 的形狀

回傳：

在 TensorSpec 邊界框中採樣的填滿 1 的 tensor。

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

代理到 one()。

project(val: torch.Tensor | tensordict.base.TensorDictBase) → torch.Tensor | tensordict.base.TensorDictBase

如果輸入 tensor 不在 TensorSpec 邊界框中，則根據某些定義的啟發式方法將其映射回邊界框。

參數:

val (torch.Tensor) – 要映射到邊界框的 tensor。

回傳：

屬於 TensorSpec 邊界框的 torch.Tensor。

rand(shape: Optional[Size] = None) → Tensor

返回 spec 定義的空間中的隨機 tensor。

除非邊界框是無界的，否則將在空間上均勻完成採樣，在這種情況下，將抽取 normal 值。

參數:

shape (torch.Size) – 隨機 tensor 的形狀

回傳：

在 TensorSpec 邊界框中採樣的隨機 tensor。

reshape(*shape) → T

重塑 TensorSpec。

有關此方法的更多資訊，請參閱 reshape()。

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

返回 spec 定義的空間中的隨機 tensor。

詳情請參閱rand()。

squeeze(dim=None)

傳回一個新的Spec，其中所有大小為1的維度都被移除。

當提供dim時，只會在該維度上進行squeeze操作。

參數:

dim (int 或 None) – 要套用squeeze操作的維度

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

將 TensorSpec 轉換為 device 或 dtype。

如果沒有進行任何變更，則傳回相同的spec。

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

將給定的 one-hot 張量轉換為 categorical 格式。

參數:

• val (torch.Tensor, optional) – 要轉換為 categorical 格式的 One-hot 張量。

• safe (bool) – 指示是否應對照 spec 的網域對值執行檢查的布林值。預設為 CHECK_SPEC_ENCODE 環境變數的值。

回傳：

categorical 張量。

範例

>>> one_hot = OneHot(3, shape=(2, 3))
>>> one_hot_sample = one_hot.rand()
>>> one_hot_sample
tensor([[False,  True, False],
        [False,  True, False]])
>>> categ_sample = one_hot.to_categorical(one_hot_sample)
>>> categ_sample
tensor([1, 1])

to_categorical_spec() → Categorical

將 spec 轉換為等效的 categorical spec。

範例

>>> one_hot = OneHot(3, shape=(2, 3))
>>> one_hot.to_categorical_spec()
Categorical(
    shape=torch.Size([2]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)

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

傳回輸入張量的對應 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

OneHot 的 No-op。

to_one_hot_spec() → OneHot

OneHot 的 No-op。

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

檢查輸入值 dtype 是否符合 TensorSpec 的 dtype，如果不符合則拋出例外。

參數:

• value (torch.Tensor) – 需要檢查 dtype 的張量 (tensor)。

• key (str, optional) – 如果 TensorSpec 具有鍵 (keys)，則會根據指定鍵所指向的規格檢查值 (value) 的 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，則停用遮罩。否則，遮罩的形狀必須可擴展到 spec 的形狀。False 會遮罩一個結果，而 True 則不遮罩。如果所有可能的結果都被遮罩，則在取樣時會引發錯誤。

範例

>>> mask = torch.tensor([True, False, False])
>>> ts = OneHot(3, (2, 3,), dtype=torch.int64, mask=mask)
>>> # All but one of the three possible outcomes are masked
>>> ts.rand()
tensor([[1, 0, 0],
        [1, 0, 0]])

view(*shape) → T

重塑 TensorSpec。

有關此方法的更多資訊，請參閱 reshape()。

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

傳回 box 中一個填滿零的張量。

注意

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

參數:

shape (torch.Size) – 零張量的形狀

回傳：

在 TensorSpec box 中取樣的一個填滿零的張量。

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

代理至 zero()。