Binary¶

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

一種二元離散張量規格（spec）。

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

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

引數：:

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

警告

Binary 中的引數 n 不要與 Categorical 或 OneHot 中的引數 n 混淆，後者表示可採樣的最大元素數量。為清晰起見，請改用 shape。
shape (torch.Size, 可選) – 取樣張量的總形狀。如果提供，最後一個維度必須與 n 匹配。
device (str, int 或 torch.device, 可選) – 張量的裝置。
dtype (str 或 torch.dtype, 可選) – 張量的資料型別（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¶

斷言張量是否屬於該範圍（box），否則引發異常。

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

cardinality() → int¶

該規格（spec）的基數。

這指的是一個規格中所有可能結果的數量。假定組合規格（composite spec）的基數是所有可能結果的笛卡爾積。

clear_device_() T¶

對所有葉子規格（leaf specs）來說是無操作（no-op）（葉子規格必須有裝置）。

對於 Composite 規格（specs），此方法將擦除裝置。

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

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

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

詳見 is_in() 方法的說明。

cpu()¶: 將 TensorSpec 轉換為 ‘cpu’ 裝置。

cuda(device=None)¶: 將 TensorSpec 轉換為 ‘cuda’ 裝置。

device: torch.device | None = None¶

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

根據指定的規格（spec）編碼值，並返回相應的張量。

此方法用於返回可輕鬆對映到 TorchRL 所需領域（domain）的值（例如 numpy 陣列）的環境中。如果值已經是張量，該規格（spec）不會改變其值並按原樣返回。

引數：:: val (np.ndarray 或 torch.Tensor) – 要編碼為張量的值。
關鍵字引數：:: ignore_device (bool, 可選) – 如果為 True，將忽略規格（spec）裝置。這用於將張量型別轉換（casting）分組到 TensorDict(..., device="cuda") 呼叫中，從而提高速度。
返回值：:: 與所需張量規格（specs）匹配的 torch.Tensor。

enumerate() → Tensor¶

返回可以從 TensorSpec 中獲得的所有樣本。

樣本將沿第一個維度堆疊（stacked）。

此方法僅針對離散規格（discrete specs）實現。

expand(*shape)[source]¶

返回一個具有擴充套件形狀的新規格（Spec）。

引數：:: *shape (tuple 或 int 可迭代物件) – 規格（Spec）的新形狀。必須與當前形狀可廣播（broadcastable）：其長度必須至少與當前形狀長度一樣長，並且其最後一個值也必須相容（compliant）；即只有噹噹前維度是單例（singleton）時，它們才能不同。

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

展平（Flattens）一個 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable¶: 為 TensorSpec 註冊一個 torch 函式覆蓋（override）。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

對輸入張量進行索引。

此方法與編碼一個或多個分類變數（categorical variables）（例如 OneHot 或 Categorical）的規格（specs）一起使用，以便在對張量進行索引時無需關心索引的實際表示形式。

引數：:

index (int, torch.Tensor, slice 或 list) – 張量的索引
tensor_to_index – 要索引的張量

返回值：:

被索引的張量

示例

>>> from torchrl.data import OneHot
>>> import torch
>>>
>>> one_hot = OneHot(n=100)
>>> categ = one_hot.to_categorical_spec()
>>> idx_one_hot = torch.zeros((100,), dtype=torch.bool)
>>> idx_one_hot[50] = 1
>>> print(one_hot.index(idx_one_hot, torch.arange(100)))
tensor(50)
>>> idx_categ = one_hot.to_categorical(idx_one_hot)
>>> print(categ.index(idx_categ, torch.arange(100)))
tensor(50)

is_in(val: Tensor) → bool¶

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

更確切地說，is_in 方法檢查值 val 是否在由 space 屬性（即 box）定義的限制範圍內，並且檢查 dtype、device、shape 以及可能的其他元資料是否與規格（spec）的匹配。如果其中任何一項檢查失敗，is_in 方法將返回 False。

引數：:: val (torch.Tensor) – 要檢查的值。
返回值：:: 指示值是否屬於 TensorSpec 範圍（box）的布林值。

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

property ndim: int¶

規格（spec）形狀的維度數量。

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

ndimension() → int¶

規格（spec）形狀的維度數量。

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

one(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回一個在該範圍（box）內的全 1 張量。

注意

即使不能保證 1 屬於該規格（spec）領域（domain），當違反此條件時，此方法也不會引發異常。`one` 的主要用例是生成空資料緩衝區（empty data buffers），而不是有意義的資料。

引數：:: shape (torch.Size) – 全 1 張量的形狀
返回值：:: 在 TensorSpec 範圍（box）內取樣的全 1 張量。

ones(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: one() 的代理（Proxy）。

project(val: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

如果輸入張量不在 TensorSpec 範圍（box）內，則根據某些定義的啟發式方法（heuristic）將其映射回該範圍。

引數：:: val (torch.Tensor) – 要對映到該範圍（box）的張量。
返回值：:: 屬於 TensorSpec 範圍（box）的 torch.Tensor。

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

返回該規格（spec）定義的空間中的隨機張量。

取樣將在該空間上均勻進行，除非範圍（box）無界（unbounded），此時將抽取正態分佈值。

引數：:: shape (torch.Size) – 隨機張量的形狀
返回值：:: 在 TensorSpec 範圍（box）內取樣的隨機張量。

reshape(*shape) → T¶

重塑（Reshapes）一個 TensorSpec。

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

sample(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回該規格（spec）定義的空間中的隨機張量。

詳見 rand() 的說明。

set_provisional_n(n: int)¶

臨時設定 Categorical 規格（spec）的基數（cardinality）。

當 n 為 -1 時，從此規格（spec）取樣之前必須呼叫此方法。

引數：:: n (int) – Categorical 規格（spec）的基數（cardinality）。

squeeze(dim=None)[原始碼]¶

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

當給出 dim 時，擠壓操作僅在該維度上執行。

引數：:: dim (int or None) – 應用擠壓操作的維度

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

將 TensorSpec 轉換為指定的裝置或資料型別。

如果未進行任何更改，則返回相同的 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 操作。

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

unsqueeze(dim: int)[原始碼]¶

返回一個新的 Spec，該 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¶

重塑（Reshapes）一個 TensorSpec。

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

zero(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

在 box 中返回一個填充零的張量。

注意

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

引數：:: shape (torch.Size) – 零張量的形狀
返回值：:: 在 TensorSpec box 中取樣的填充零的張量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: zero() 的代理。

Binary¶

文件

教程

資源