SACLoss¶

class 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 值網路。

關鍵字參數:

num_qvalue_nets (integer, 可選) – 使用的 Q 值網路數量。預設值為 2。
loss_function (str, 可選) – 與值函數損失一起使用的損失函數。預設值為 “smooth_l1”。
alpha_init (float, 可選) – 初始熵乘數。預設值為 1.0。
min_alpha ( float, optional) – alpha 的最小值。預設值為 None (沒有最小值)。
max_alpha ( float, optional) – alpha 的最大值。預設值為 None (沒有最大值)。
action_spec ( TensorSpec, optional) – 行動張量規格 (action tensor spec)。如果未提供且目標熵 (target entropy) 為 "auto"，則將從 actor 檢索它。
fixed_alpha (bool, optional) – 如果 True，alpha 將固定為其初始值。否則，將優化 alpha 以匹配 'target_entropy' 值。預設值為 False。
target_entropy ( float or str, optional) – 隨機策略的目標熵。預設值為 “auto”，其中目標熵計算為 -prod(n_actions)。
delay_actor (bool, optional) – 是否將目標 actor 網路與用於資料收集的 actor 網路分開。預設值為 False。
delay_qvalue (bool, optional) – 是否將目標 Q value 網路與用於資料收集的 Q value 網路分開。預設值為 True。
delay_value (bool, optional) – 是否將目標 value 網路與用於資料收集的 value 網路分開。預設值為 True。
priority_key (str, optional) – [已棄用，請改用 .set_keys(priority_key=priority_key)] Tensordict 鍵，用於寫入優先順序（用於優先順序回放緩衝區使用）。預設為 "td_error"。
separate_losses (bool, optional) – 如果 True，策略和評估器 (critic) 之間的共享參數將僅在策略損失上進行訓練。預設值為 False，即梯度會傳播到策略和評估器損失的共享參數。
reduction (str, optional) – 指定應用於輸出的縮減方式： "none" | "mean" | "sum"。"none"：不應用任何縮減，"mean"：輸出的總和將除以輸出中的元素數量，"sum"：輸出將被求和。預設值："mean"。

範例

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

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, optional) – 是否嚴格強制 state_dict 中的鍵與此模組的 state_dict() 函式所傳回的鍵相符。預設值： True
assign (bool, optional) – 當 False 時，會保留目前模組中張量的屬性；當 True 時，會保留 state dict 中張量的屬性。唯一的例外是 requires_grad 欄位。 Default: ``False`

傳回:

missing_keys 是一個字串列表，包含此模組預期的但在提供的 state_dict 中遺失的任何鍵。
此模組預期的但在提供的 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)[source]¶

值函式建構子。

如果需要非預設值函式，則必須使用此方法建立。

參數:

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) – 預設情況下，state dict 中傳回的 Tensor s 與 autograd 分離。如果將其設定為 True，則不會執行分離。預設值： False。

傳回:

包含模組整個狀態的字典

回傳類型:

dict

範例

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

SACLoss¶

文件

教學課程

資源