DiscreteSACLoss¶

class torchrl.objectives.DiscreteSACLoss(*args, **kwargs)[原始碼]¶

離散 SAC Loss 模組。

引數:

actor_network (ProbabilisticActor) – 要訓練的 actor。
qvalue_network (TensorDictModule) – 單個 Q 值網路，將根據需要進行多次乘法。
action_space (str 或 TensorSpec) – 操作空間。必須是 "one-hot"、"mult_one_hot"、"binary" 或 "categorical" 之一，或者相應 spec 的例項（torchrl.data.OneHot、torchrl.data.MultiOneHot、torchrl.data.Binary 或 torchrl.data.Categorical）。
num_actions (int, optional) – 操作空間中的運算元。如果 target_entropy 設定為“auto”，則必須提供。
num_qvalue_nets (int, optional) – 要訓練的 Q 值網路的數量。預設為 2。
loss_function (str, optional) – 用於 Q 值的損失函式。可以是“smooth_l1”、“l2”、“l1”之一，預設為“smooth_l1”。
alpha_init (float, optional) – 初始熵乘數。預設為 1.0。
min_alpha (float, optional) – alpha 的最小值。預設為 None（無最小值）。
max_alpha (float, optional) – alpha 的最大值。預設為 None（無最大值）。
fixed_alpha (bool, optional) – alpha 是否應訓練為匹配目標熵。預設為 False。
target_entropy_weight (float, optional) – 目標熵項的權重。
target_entropy (Union[str, Number], optional) – 隨機策略的目標熵。預設為“auto”。
delay_qvalue (bool, optional) – 目標 Q 值網路是否應與用於資料收集的 Q 值網路分開。預設為 False。
priority_key (str, optional) – [已棄用，請改用 .set_keys(priority_key=priority_key)] 用於優先回放緩衝區寫入優先順序值的鍵。預設為“td_error”。
separate_losses (bool, 可選) – 如果為 True，則策略和評估器之間的共享引數將僅針對策略損失進行訓練。預設為 False，即梯度將傳播到策略和評估器損失的共享引數。
reduction (str, optional) – 指定應用於輸出的約簡："none" | "mean" | "sum"。"none"：不應用約簡，"mean"：輸出的總和將除以輸出中的元素數量，"sum"：將對輸出進行求和。預設為 "mean"。
skip_done_states (bool, optional) – 用於值計算的 actor 網路是否應僅在有效的、非終止的下一狀態上執行。如果 True，則假定 done 狀態可以廣播到資料的形狀，並且遮蔽資料會產生一個有效的資料結構。除其他外，這在 MARL 設定或使用 RNN 時可能不成立。預設為 False。
deactivate_vmap (bool, 可選) – 是否停用 vmap 呼叫並用普通 for 迴圈替換它們。預設為 False。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data.tensor_specs import OneHot
>>> from torchrl.modules.distributions import NormalParamExtractor, OneHotCategorical
>>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator
>>> from torchrl.modules.tensordict_module.common import SafeModule
>>> from torchrl.objectives.sac import DiscreteSACLoss
>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule
>>> n_act, n_obs = 4, 3
>>> spec = OneHot(n_act)
>>> module = TensorDictModule(nn.Linear(n_obs, n_act), in_keys=["observation"], out_keys=["logits"])
>>> actor = ProbabilisticActor(
...     module=module,
...     in_keys=["logits"],
...     out_keys=["action"],
...     spec=spec,
...     distribution_class=OneHotCategorical)
>>> qvalue = TensorDictModule(
...     nn.Linear(n_obs, n_act),
...     in_keys=["observation"],
...     out_keys=["action_value"],
... )
>>> loss = DiscreteSACLoss(actor, qvalue, action_space=spec, num_actions=spec.space.n)
>>> batch = [2,]
>>> action = spec.rand(batch)
>>> data = TensorDict({
...     "observation": torch.randn(*batch, n_obs),
...     "action": action,
...     ("next", "done"): torch.zeros(*batch, 1, dtype=torch.bool),
...     ("next", "terminated"): torch.zeros(*batch, 1, dtype=torch.bool),
...     ("next", "reward"): torch.randn(*batch, 1),
...     ("next", "observation"): torch.randn(*batch, n_obs),
...     }, batch)
>>> loss(data)
TensorDict(
fields={
    alpha: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
    entropy: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
    loss_actor: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
    loss_alpha: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
    loss_qvalue: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
batch_size=torch.Size([]),
device=None,
is_shared=False)

此類也相容非 tensordict 的模組，可以在不依賴任何 tensordict 相關原語的情況下使用。在這種情況下，預期的關鍵字引數為：["action", "next_reward", "next_done", "next_terminated"] + actor 和 qvalue 網路的 in_keys。返回值是一個張量元組，順序如下：``[“loss_actor”, “loss_qvalue”, “loss_alpha”

“alpha”, “entropy”]``

也可以使用 DiscreteSACLoss.select_out_keys() 方法過濾輸出鍵。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data.tensor_specs import OneHot
>>> from torchrl.modules.distributions import NormalParamExtractor, OneHotCategorical
>>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator
>>> from torchrl.modules.tensordict_module.common import SafeModule
>>> from torchrl.objectives.sac import DiscreteSACLoss
>>> n_act, n_obs = 4, 3
>>> spec = OneHot(n_act)
>>> net = nn.Sequential(nn.Linear(n_obs, 2 * n_act), NormalParamExtractor())
>>> module = SafeModule(net, in_keys=["observation"], out_keys=["logits"])
>>> actor = ProbabilisticActor(
...     module=module,
...     in_keys=["logits"],
...     out_keys=["action"],
...     spec=spec,
...     distribution_class=OneHotCategorical)
>>> class ValueClass(nn.Module):
...     def __init__(self):
...         super().__init__()
...         self.linear = nn.Linear(n_obs, n_act)
...     def forward(self, obs):
...         return self.linear(obs)
>>> module = ValueClass()
>>> qvalue = ValueOperator(
...     module=module,
...     in_keys=['observation'])
>>> loss = DiscreteSACLoss(actor, qvalue, num_actions=actor.spec["action"].space.n)
>>> batch = [2, ]
>>> action = spec.rand(batch)
>>> # filter output keys to "loss_actor", and "loss_qvalue"
>>> _ = loss.select_out_keys("loss_actor", "loss_qvalue")
>>> loss_actor, loss_qvalue = loss(
...     observation=torch.randn(*batch, n_obs),
...     action=action,
...     next_done=torch.zeros(*batch, 1, dtype=torch.bool),
...     next_terminated=torch.zeros(*batch, 1, dtype=torch.bool),
...     next_observation=torch.zeros(*batch, n_obs),
...     next_reward=torch.randn(*batch, 1))
>>> loss_actor.backward()

actor_loss(tensordict: TensorDictBase = None) → tuple[torch.Tensor, dict[str, torch.Tensor]][原始碼]¶

計算離散 SAC 的 actor loss。

此方法計算 actor loss，它鼓勵策略最大化預期的 Q 值，同時保持離散操作的高熵。

引數:

tensordict (TensorDictBase) – 包含計算 actor loss 所需資料的 tensordict。應包含 observation 和 actor 網路所需的其他鍵。

返回:

actor loss 張量
包含操作對數機率的元資料字典

返回型別:

一個包含的元組

alpha_loss(log_prob: Tensor) → Tensor[原始碼]¶

計算離散 SAC 的 alpha loss。

此方法計算 alpha loss，它會調整熵係數以保持離散操作的目標熵水平。

引數:: log_prob (Tensor) – actor 網路生成的操作的對數機率。
返回:: alpha loss 張量

default_keys¶: 別名：_AcceptedKeys

forward(tensordict: TensorDictBase = None) → TensorDictBase[原始碼]¶

它旨在讀取一個輸入的 TensorDict 並返回另一個包含名為“loss*”的損失鍵的 tensordict。

將損失分解為其組成部分可以被訓練器用於在訓練過程中記錄各種損失值。輸出 tensordict 中存在的其他標量也將被記錄。

引數:: tensordict – 一個輸入的 tensordict，包含計算損失所需的值。
返回:: 一個沒有批處理維度的新 tensordict，其中包含各種損失標量，這些標量將被命名為“loss*”。重要的是，損失必須以這個名稱返回，因為它們將在反向傳播之前被訓練器讀取。

make_value_estimator(value_type: Optional[ValueEstimators] = None, **hyperparams)[原始碼]¶

值函式建構函式。

如果需要非預設值函式，必須使用此方法構建。

引數:

value_type (ValueEstimators) – 一個 ValueEstimators 列舉型別，指示要使用的值函式。如果未提供，將使用儲存在 default_value_estimator 屬性中的預設值。生成的估值器類將註冊在 self.value_type 中，以便將來進行改進。
**hyperparams – 用於值函式的超引數。如果未提供，將使用 default_value_kwargs() 中指示的值。

示例

>>> from torchrl.objectives import DQNLoss
>>> # initialize the DQN loss
>>> actor = torch.nn.Linear(3, 4)
>>> dqn_loss = DQNLoss(actor, action_space="one-hot")
>>> # updating the parameters of the default value estimator
>>> dqn_loss.make_value_estimator(gamma=0.9)
>>> dqn_loss.make_value_estimator(
...     ValueEstimators.TD1,
...     gamma=0.9)
>>> # if we want to change the gamma value
>>> dqn_loss.make_value_estimator(dqn_loss.value_type, gamma=0.9)

qvalue_loss(tensordict: TensorDictBase = None) → tuple[torch.Tensor, dict[str, torch.Tensor]][原始碼]¶

計算離散 SAC 的 Q 值 loss。

此方法計算 Q 值 loss，它訓練 Q 網路來估計離散操作空間中狀態-動作對的預期回報。

引數:

tensordict (TensorDictBase) – 包含計算 Q 值 loss 所需資料的 tensordict。應包含 observation、action、reward、done 和 terminated 鍵。

返回:

Q 值 loss 張量
包含 TD 誤差的元資料字典

返回型別:

一個包含的元組

DiscreteSACLoss¶

文件

教程

資源