SACLoss

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

SAC 損失函式的 TorchRL 實現。

論文 “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) – 隨機 actor

• qvalue_network (TensorDictModule) –

  Q(s, a) 引數化模型。此模組通常輸出一個 "state_action_value" 條目。如果提供單個 qvalue_network 例項，它將被複制 num_qvalue_nets 次。如果傳遞模組列表，除非它們共享相同的身份（在這種情況下，原始引數將被擴充套件），否則它們的引數將被堆疊。

  警告

  當傳遞引數列表時，它將__不__與策略引數進行比較，所有引數將被視為非繫結的。

• value_network (TensorDictModule, 可選) –

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

  注意

  如果未提供，則假定使用 SAC 的第二個版本，該版本僅需要 Q-Value 網路。

關鍵字引數:

• num_qvalue_nets (integer, 可選) – 使用的 Q-Value 網路數量。預設為 2。

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

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

• min_alpha (float, 可選) – alpha 的最小值。預設為 None (無最小值)。

• max_alpha (float, 可選) – alpha 的最大值。預設為 None (無最大值)。

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

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

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

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

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

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

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

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

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

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) – 包含引數和持久化緩衝區的字典。

• strict (bool, 可選) – 是否嚴格要求 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設為： True

• assign (bool, 可選) – 設定為 False 時，保留當前模組中張量的屬性；設定為 True 時，保留 state dict 中張量的屬性。唯一的例外是 Default: ``False` 的 requires_grad 欄位。

返回:

• missing_keys 是一個字串列表，包含任何預期但

  未在提供的 state_dict 中找到的鍵。

• unexpected_keys 是一個字串列表，包含未

  被此模組預期但存在於提供的 state_dict 中的鍵。

返回型別:

帶有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

如果引數或緩衝區註冊為 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, 可選) – 如果提供，模組的狀態將更新到該字典中並返回同一物件。否則，將建立一個 OrderedDict 並返回。預設為： None。

• prefix (str, 可選) – 新增到引數和緩衝區名稱前的字串字首，用於構成 state_dict 中的鍵。預設為： ''。

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

返回:

一個包含模組整體狀態的字典

返回型別:

dict

示例

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