SACLoss

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

TorchRL 中 SAC 损失的实现。

在 “Soft Actor-Critic: Off-Policy Maximum Entropy Deep Reinforcement Learning with a Stochastic Actor” https://arxiv.org/abs/1801.01290 和 “Soft Actor-Critic Algorithms and Applications” https://arxiv.org/abs/1812.05905 中介绍。

参数：

• actor_network (ProbabilisticActor) – 随机执行器

• qvalue_network (TensorDictModule) –

  Q(s, a) 参数模型。该模块通常输出一个 "state_action_value" 条目。如果提供单个 qvalue_network 实例，它将被复制 num_qvalue_nets 次。如果传递了一个模块列表，则它们的参数将被堆叠，除非它们共享相同的标识（在这种情况下，原始参数将被扩展）。

  警告

  当传递参数列表时，它__不会__与策略参数进行比较，并且所有参数都将被视为不绑定。

• value_network (TensorDictModule, 可选) –

  V(s) 参数模型。该模块通常输出一个 "state_value" 条目。

  注意

  如果未提供，则假定第二版 SAC，其中只需要 Q 值网络。

关键字参数：

• num_qvalue_nets (整数, 可选) – 使用的 Q 值网络数量。默认为 2。

• loss_function (str, 可选) – 要与值函数损失一起使用的损失函数。默认值为 “smooth_l1”。

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

• min_alpha (浮点数, 可选) – alpha 的最小值。默认为 None（无最小值）。

• max_alpha (浮点数, 可选) – alpha 的最大值。默认为 None（无最大值）。

• action_spec (TensorSpec, 可选) – 操作张量规范。如果未提供并且目标熵为 "auto"，它将从执行器中检索。

• fixed_alpha (布尔值, 可选) – 如果为 True，alpha 将固定为其初始值。否则，alpha 将被优化以匹配 ‘target_entropy’ 值。默认为 False。

• target_entropy (浮点数 或 str, 可选) – 随机策略的目标熵。默认为 “auto”，其中目标熵计算为 -prod(n_actions)。

• delay_actor (布尔值, 可选) – 是否将目标执行器网络与用于数据收集的执行器网络分开。默认为 False。

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

• delay_value (布尔值, 可选) – 是否将目标值网络与用于数据收集的值网络分开。默认为 True。

• priority_key (str, 可选) – [已弃用，请改为使用 .set_keys(priority_key=priority_key) ] 用于写入优先级的 Tensordict 键（用于优先回放缓冲区使用）。默认为 "td_error"。

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

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

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data import BoundedTensorSpec
>>> from torchrl.modules.distributions import NormalParamExtractor, TanhNormal
>>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator
>>> from torchrl.modules.tensordict_module.common import SafeModule
>>> from torchrl.objectives.sac import SACLoss
>>> from tensordict import TensorDict
>>> n_act, n_obs = 4, 3
>>> spec = BoundedTensorSpec(-torch.ones(n_act), torch.ones(n_act), (n_act,))
>>> net = nn.Sequential(nn.Linear(n_obs, 2 * n_act), NormalParamExtractor())
>>> module = SafeModule(net, in_keys=["observation"], out_keys=["loc", "scale"])
>>> actor = ProbabilisticActor(
...     module=module,
...     in_keys=["loc", "scale"],
...     spec=spec,
...     distribution_class=TanhNormal)
>>> class ValueClass(nn.Module):
...     def __init__(self):
...         super().__init__()
...         self.linear = nn.Linear(n_obs + n_act, 1)
...     def forward(self, obs, act):
...         return self.linear(torch.cat([obs, act], -1))
>>> module = ValueClass()
>>> qvalue = ValueOperator(
...     module=module,
...     in_keys=['observation', 'action'])
>>> module = nn.Linear(n_obs, 1)
>>> value = ValueOperator(
...     module=module,
...     in_keys=["observation"])
>>> loss = SACLoss(actor, qvalue, value)
>>> 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),
        loss_value: 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"] + 执行器、值和 Q 值网络的 in_keys。返回值是按照以下顺序排列的张量元组：["loss_actor", "loss_qvalue", "loss_alpha", "alpha", "entropy"] + 如果使用第一版，则为 "loss_value"。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data import BoundedTensorSpec
>>> from torchrl.modules.distributions import NormalParamExtractor, TanhNormal
>>> from torchrl.modules.tensordict_module.actors import ProbabilisticActor, ValueOperator
>>> from torchrl.modules.tensordict_module.common import SafeModule
>>> from torchrl.objectives.sac import SACLoss
>>> _ = torch.manual_seed(42)
>>> n_act, n_obs = 4, 3
>>> spec = BoundedTensorSpec(-torch.ones(n_act), torch.ones(n_act), (n_act,))
>>> net = nn.Sequential(nn.Linear(n_obs, 2 * n_act), NormalParamExtractor())
>>> module = SafeModule(net, in_keys=["observation"], out_keys=["loc", "scale"])
>>> actor = ProbabilisticActor(
...     module=module,
...     in_keys=["loc", "scale"],
...     spec=spec,
...     distribution_class=TanhNormal)
>>> class ValueClass(nn.Module):
...     def __init__(self):
...         super().__init__()
...         self.linear = nn.Linear(n_obs + n_act, 1)
...     def forward(self, obs, act):
...         return self.linear(torch.cat([obs, act], -1))
>>> module = ValueClass()
>>> qvalue = ValueOperator(
...     module=module,
...     in_keys=['observation', 'action'])
>>> module = nn.Linear(n_obs, 1)
>>> value = ValueOperator(
...     module=module,
...     in_keys=["observation"])
>>> loss = SACLoss(actor, qvalue, value)
>>> batch = [2, ]
>>> action = spec.rand(batch)
>>> 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()

输出键也可以使用 SACLoss.select_out_keys() 方法进行过滤。

示例

>>> _ = 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()

forward(tensordict: TensorDictBase) → TensorDictBase

它旨在读取输入 TensorDict 并返回另一个包含名为 “loss*” 的损失键的 tensordict。

将损失拆分为其组成部分，然后可以被训练器用来在整个训练过程中记录各种损失值。输出 tensordict 中存在的其他标量也将被记录。

参数：

tensordict – 包含计算损失所需的值的输入 tensordict。

返回值：

一个新的没有批次维度的 tensordict，其中包含各种损失标量，这些标量将被命名为 “loss*”。必须使用此名称返回损失，因为它们将在反向传播之前由训练器读取。

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)

将参数和缓冲区从 state_dict 复制到此模块及其子模块。

如果 strict 为 True，则 state_dict 的键必须与该模块的 state_dict() 函数返回的键完全匹配。

警告

如果 assign 为 True，则必须在调用 load_state_dict 后创建优化器，除非 get_swap_module_params_on_conversion() 为 True。

参数：

• state_dict (dict) – 包含参数和持久缓冲区的字典。

• strict (bool, optional) – 是否严格强制 state_dict 中的键与该模块的 state_dict() 函数返回的键匹配。默认值：True

• assign (bool, optional) – 当 False 时，当前模块中张量的属性将被保留，而当 True 时，状态字典中张量的属性将被保留。唯一的例外是 requires_grad 字段 Default: ``False`

返回值：

• missing_keys 是一个包含所有预期键的字符串列表

  但从提供的 state_dict 中丢失。

• unexpected_keys 是一个包含所有不被的键的字符串列表

  此模块期望，但存在于提供的 state_dict 中。

返回类型:

NamedTuple 带有 missing_keys 和 unexpected_keys 字段

注意

如果参数或缓冲区被注册为 None，并且其对应的键存在于 state_dict 中，load_state_dict() 将引发 RuntimeError。

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)

state_dict(*args, destination=None, prefix='', keep_vars=False)

返回一个包含对模块整个状态的引用的字典。

参数和持久缓冲区（例如运行平均值）都包含在内。键是对应的参数和缓冲区名称。设置为 None 的参数和缓冲区不包括在内。

注意

返回的对象是浅层副本。它包含对模块参数和缓冲区的引用。

警告

目前，state_dict() 还接受 destination、prefix 和 keep_vars 的位置参数。但是，这正在被弃用，并且在将来的版本中将强制使用关键字参数。

警告

请避免使用参数 destination，因为它不是为最终用户设计的。

参数：

• destination (dict, optional) – 如果提供，模块的状态将更新到字典中，并返回相同的对象。否则，将创建一个 OrderedDict 并返回。默认值：None。

• prefix (str, optional) – 添加到参数和缓冲区名称之前的缀，用于在 state_dict 中组成键。默认值：''。

• keep_vars (bool, optional) – 默认情况下，Tensor s 在状态字典中返回时将从自动梯度中分离。如果将其设置为 True，则不会执行分离。默认值：False。

返回值：

包含模块整个状态的字典

返回类型:

dict

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']