DiscreteSACLoss

class torchrl.objectives.DiscreteSACLoss(*args, **kwargs)

离散 SAC 损失模块。

参数：

• actor_network (ProbabilisticActor) – 要训练的 actor

• qvalue_network (TensorDictModule) – 单个 Q 值网络，将根据需要复制多次。

• action_space (str 或 TensorSpec) – 动作空间。必须是 "one-hot"、"mult_one_hot"、"binary" 或 "categorical" 之一，或者是相应规范的实例 (torchrl.data.OneHot, torchrl.data.MultiOneHot, torchrl.data.Binary 或 torchrl.data.Categorical)。

• num_actions (int, 可选) – 动作空间中的动作数量。如果 target_entropy 设置为“auto”，则需要提供此参数。

• num_qvalue_nets (int, 可选) – 要训练的 Q 值网络的数量。默认为 2。

• loss_function (str, 可选) – 用于 Q 值的损失函数。可以是 “smooth_l1”、“l2”、“l1”之一。默认为“smooth_l1”。

• alpha_init (float, 可选) – 初始熵乘数。默认为 1.0。

• min_alpha (float, 可选) – alpha 的最小值。默认为 None (无最小值)。

• max_alpha (float, 可选) – alpha 的最大值。默认为 None (无最大值)。

• fixed_alpha (bool, 可选) – alpha 是否应训练以匹配目标熵。默认为 False。

• target_entropy_weight (float, 可选) – 目标熵项的权重。

• target_entropy (Union[str, Number], 可选) – 随机策略的目标熵。默认为“auto”。

• delay_qvalue (bool, 可选) – 是否将目标 Q 值网络与用于数据收集的 Q 值网络分开。默认为 False。

• priority_key (str, 可选) – [已弃用，请改用 .set_keys(priority_key=priority_key)] 用于存储优先级回放缓冲区优先级值的键。默认为 “td_error”。

• separate_losses (bool, 可选) – 如果为 True，策略和批评家之间的共享参数将只在策略损失上训练。默认为 False，即梯度会传播到策略和批评家损失的共享参数上。

• reduction (str, 可选) – 指定要应用于输出的缩减方式："none" | "mean" | "sum"。"none"：不应用缩减，"mean"：输出总和将除以输出中的元素数量，"sum"：输出将被求和。默认为："mean"。

• skip_done_states (bool, 可选) – 用于价值计算的 actor 网络是否仅在有效、非终止的下一个状态上运行。如果为 True，则假定 done 状态可以广播到数据的形状，并且掩码数据会产生有效的数据结构。这在 MARL 设置或使用 RNN 时可能不成立。默认为 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()

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)