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, optional) –

  V(s) 引數化模型。此模組通常輸出一個 "state_value" 條目。

  注意

  如果未提供，則假定為 SAC 的第二種版本，在這種版本中只需要 Q 值網路。

關鍵字引數:

• num_qvalue_nets (integer, optional) – 使用的 Q 值網路的數量。預設為 2。

• loss_function (str, optional) – 要用於值函式損失的損失函式。預設為 “smooth_l1”。

• alpha_init (float, optional) – 初始熵乘數。預設為 1.0。

• min_alpha (float, optional) – alpha 的最小值。預設為 None（無最小值）。

• max_alpha (float, optional) – alpha 的最大值。預設為 None（無最大值）。

• action_spec (TensorSpec, 可選) – 動作張量規範。如果未提供且目標熵為 "auto"，則將從策略中檢索。

• fixed_alpha (bool, 可選) – 如果為 True，則 alpha 將固定為其初始值。否則，alpha 將被最佳化以匹配“target_entropy”值。預設為 False。

• target_entropy (float 或 str, 可選) – 隨機策略的目標熵。預設為“auto”，此時目標熵計算為 -prod(n_actions)。

• delay_actor (bool, optional) – 是否將目標 actor 網路與用於資料收集的 actor 網路分開。預設為 False。

• delay_qvalue (bool, 可選) – 是否將目標 Q 值網路與用於資料收集的 Q 值網路分開。預設為 True。

• delay_value (bool, optional) – 是否將目標 value 網路與用於資料收集的 value 網路分開。預設為 True。

• priority_key (str, optional) – [已棄用，請改用 .set_keys(priority_key=priority_key) ] 寫入優先順序（用於優先回放緩衝區）的 Tensordict 鍵。預設為 "td_error"。

• separate_losses (bool, 可選) – 如果為 True，則策略和評估器之間的共享引數將僅針對策略損失進行訓練。預設為 False，即梯度將傳播到策略和評估器損失的共享引數。

• reduction (str, optional) – 指定應用於輸出的約簡："none" | "mean" | "sum"。"none"：不應用約簡，"mean"：輸出的總和將除以輸出中的元素數量，"sum"：將對輸出進行求和。預設為 "mean"。

• skip_done_states (bool, optional) – 用於計算值的 actor 網路是否應僅在有效的、非終止的下一個狀態上執行。如果為 True，則假定完成狀態可以廣播到資料的形狀，並且對資料進行掩碼會產生有效的資料結構。除其他外，這在 MARL 設定或使用 RNN 時可能不成立。預設為 False。

• deactivate_vmap (bool, 可選) – 是否停用 vmap 呼叫並用普通 for 迴圈替換它們。預設為 False。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data import Bounded
>>> 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 = Bounded(-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"] + actor、value 和 qvalue 網路的 in_keys。返回值是一個元組，順序如下：["loss_actor", "loss_qvalue", "loss_alpha", "alpha", "entropy"] + 如果使用版本一，則為 "loss_value"。

示例

>>> import torch
>>> from torch import nn
>>> from torchrl.data import Bounded
>>> 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 = Bounded(-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()

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

計算 SAC 的 actor 損失。

此方法計算 actor 損失，鼓勵策略最大化預期的 Q 值，同時保持高熵。

引數:

tensordict (TensorDictBase) – 包含計算 actor 損失所需資料的 tensordict。應包含 actor 網路的觀測值和其他必需的鍵。

返回:

• actor 損失張量

• 一個包含元資料的字典，包括動作的對數機率

返回型別:

一個包含的元組

alpha_loss(log_prob: Tensor) → Tensor

計算 SAC 的 alpha 損失。

此方法計算 alpha 損失，該損失會調整熵係數以維持目標熵水平。

引數:

log_prob (Tensor) – actor 網路產生的動作的對數機率。

返回:

alpha 損失張量

default_keys

別名：_AcceptedKeys

forward(tensordict: TensorDictBase = None) → 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) – 包含引數和持久 buffer 的字典。

• strict (bool, optional) – 是否嚴格強制 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設值：True

• assign (bool, optional) – 當設定為 False 時，將保留當前模組中張量的屬性；當設定為 True 時，將保留 state_dict 中張量的屬性。唯一的例外是 Parameter 的 requires_grad 欄位，此時將保留模組的值。預設值：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)

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

計算 SAC 的 Q 值損失。

此方法計算 Q 值損失，該損失訓練 Q 網路來估計狀態-動作對的預期回報。

引數:

tensordict (TensorDictBase) – 包含計算 Q 值損失所需資料的 tensordict。應包含觀察值、動作、獎勵、完成和終止鍵。

返回:

• Q 值損失張量

• 一個包含元資料的字典，包括 TD 誤差

返回型別:

一個包含的元組

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

返回一個字典，其中包含對模組整個狀態的引用。

引數和持久緩衝區（例如，執行平均值）都包含在內。鍵是相應的引數和緩衝區名稱。設定為 None 的引數和緩衝區不包含在內。

注意

返回的物件是淺複製。它包含對模組引數和緩衝區的引用。

警告

當前 state_dict() 還接受 destination、prefix 和 keep_vars 的位置引數，順序為。但是，這正在被棄用，並且在未來的版本中將強制使用關鍵字引數。

警告

請避免使用引數 destination，因為它不是為終端使用者設計的。

引數:

• destination (dict, optional) – 如果提供，模組的狀態將更新到 dict 中，並返回相同的物件。否則，將建立一個 OrderedDict 並返回。預設為 None。

• prefix (str, optional) – a prefix added to parameter and buffer names to compose the keys in state_dict. Default: ''。

• keep_vars (bool, optional) – 預設情況下，state dict 中返回的 Tensors 會從 autograd 中分離。如果設定為 True，則不會執行分離。預設為 False。

返回:

包含模組整體狀態的字典

返回型別:

dict

示例

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

value_loss(tensordict: TensorDictBase = None) → tuple[torch.Tensor, dict[str, torch.Tensor]]

計算 SAC 的 value loss（僅版本 1）。

此方法計算 value loss，該損失訓練 value 網路來估計狀態的預期回報。這僅在 SAC 版本 1 中使用。

引數:

tensordict (TensorDictBase) – 包含計算 value loss 所需資料的 tensordict。應包含 value 網路的觀察值和其他必需的鍵。

返回:

• value 損失張量

• 一個空字典（value loss 無元資料）

返回型別:

一個包含的元組

丟擲:

RuntimeError – 如果在 SAC 版本 2 上呼叫（不使用 value 網路）