DiscreteSACLoss

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

离散 SAC 损失模块。

参数:

• actor_network (ProbabilisticActor) – 要训练的 actor

• qvalue_network (TensorDictModule) – 一个 Q 值网络，将被复制多次。

• action_space (str or 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, optional) – 如果为 True，则策略和 critic 之间的共享参数将仅在策略损失上进行训练。默认为 False，即梯度会同时从策略和 critic 损失传播到共享参数。

• 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()

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 属性中存储的默认值。生成的 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)