二元¶

class torchrl.data.Binary(n: Optional[int] = None, shape: Optional[Size] = None, device: Optional[Union[device, str, int]] = None, dtype: Union[str, dtype] = torch.int8)[來源]¶

二元離散張量規格。

二元張量規格編碼任意大小的張量，其中值為 0 或 1（或 True 或 False，如果 dtype 為 torch.bool）。

與 OneHot 不同，Binary 在最後一個維度上可以有多個非空元素。

參數:

n (int) –
二元向量的長度。如果與 shape 一起提供，則 shape[-1] 必須與 n 匹配。如果未提供，則必須傳遞 shape。

警告

Binary 中的 n 引數不得與 Categorical 或 OneHot 中的 n 引數混淆，後者表示可以取樣的最大元素數。為清楚起見，請改用 shape。
shape (torch.Size, optional) – 取樣張量的總形狀。如果提供，則最後一個維度必須與 n 匹配。
device (str, int 或 torch.device, 選用) – tensors 的裝置。
dtype (str 或 torch.dtype, 選用) – tensors 的 dtype。預設為 torch.int8。

範例

>>> torch.manual_seed(0)
>>> spec = Binary(n=4, shape=(2, 4))
>>> print(spec.rand())
tensor([[0, 1, 1, 0],
        [1, 1, 1, 1]], dtype=torch.int8)
>>> spec = Binary(shape=(2, 4))
>>> print(spec.rand())
tensor([[1, 1, 1, 0],
        [0, 1, 0, 0]], dtype=torch.int8)
>>> spec = Binary(n=4)
>>> print(spec.rand())
tensor([0, 0, 0, 1], dtype=torch.int8)

assert_is_in(value: Tensor) → None¶

確認 tensor 是否屬於這個範圍 (box)，否則會引發例外。

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

clear_device_() → T¶

對所有 leaf specs 而言都是 no-op (必須要有 device)。

對於 Composite specs，這個方法會清除 device。

clone() → Binary[source]¶: 建立 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 的數值。
Keyword Arguments:: ignore_device (bool, 選用) – 如果為 True，則會忽略 spec device。這用於將 tensor 轉換分組在對 TensorDict(..., device="cuda") 的呼叫中，這樣速度會更快。
傳回：: 符合所需 tensor specs 的 torch.Tensor。

expand(*shape)[source]¶

傳回具有擴展形狀的新 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 屬於 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 轉換為裝置或 dtype。

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

to_categorical(val: Tensor, safe: Optional[bool] = None) → Tensor¶: 對類別資料來說，此操作不做任何事 (No-op)。

to_categorical_spec() → Categorical¶: 對類別資料來說，此操作不做任何事 (No-op)。

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

回傳輸入 tensor 對應的 np.ndarray。

這個函式是為了作為 encode() 的反向操作。

參數:

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

傳回：

一個 np.ndarray。

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

將 spec domain 中的離散 tensor 編碼為其 one-hot 對應形式。

參數:

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

傳回：

one-hot 編碼後的 tensor。

範例

>>> 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 的 tensor。
key (str, optional) – 如果 TensorSpec 有鍵，則將根據指定鍵所指向的 spec 檢查值 dtype。

unflatten(dim: int, sizes: Tuple[int]) → T¶

將 TensorSpec 展開 (Unflatten)。

有關此方法的更多資訊，請查看 unflatten()。

unsqueeze(dim: int)[source]¶

返回一個新的 Spec，在 dim 指示的位置添加一個 singleton 維度。

參數:: dim (int 或 None) – 用於執行 unsqueeze 操作的維度。

update_mask(mask)¶

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

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

參數:: mask (torch.Tensor 或 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¶

傳回 box 中填滿零的 tensor。

注意

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

參數:: shape (torch.Size) – 零 tensor 的形狀
傳回：: 在 TensorSpec box 中取樣的填滿零的 tensor。

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

二元¶

文件

教學課程

資源