Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/configs/grpo_math_1B.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ grpo:

loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
# (default off) loss formulation improvements (docs/guides/grpo.md#loss)
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ grpo:
val_batch_size: 256
loss_fn:
reference_policy_kl_penalty: 0.01
ratio_eps_min: 0.2
ratio_eps_max: 0.2
ratio_clip_min: 0.2
ratio_clip_max: 0.2
use_on_policy_kl_approximation: false
use_importance_sampling_correction: false
checkpointing:
Expand Down
18 changes: 9 additions & 9 deletions nemo_rl/algorithms/loss_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@

class ClippedPGLossConfig(TypedDict):
reference_policy_kl_penalty: float
ratio_eps_min: float
ratio_eps_max: float
ratio_clip_min: float
ratio_clip_max: float
use_on_policy_kl_approximation: bool
use_importance_sampling_correction: bool

Expand All @@ -55,19 +55,19 @@ class ClippedPGLossFn(LossFunction):

- PPO (Clipped) - https://arxiv.org/abs/1707.06347
- GRPO - https://arxiv.org/abs/2402.03300
- REINFORCE/RLOO (set disable_ppo_ratio = True and ignores ratio_eps) - https://arxiv.org/abs/2402.14740
- REINFORCE/RLOO (set disable_ppo_ratio = True and ignores ratio_clip_min/ratio_clip_max) - https://arxiv.org/abs/2402.14740

Formula:
L(θ) = E_t [ min(r_t(θ) * A_t, clip(r_t(θ), 1-ε, 1+ε) * A_t) ] - β * KL(π_θ || π_ref)

where:
- r_t(θ) = π_θ(a_t|s_t) / π_θ_old(a_t|s_t) is the probability ratio
- A_t is the advantage estimate
- ε is the clip parameter (ratio_eps)
- ε is the clip parameter (ratio_clip_min/ratio_clip_max)
- As proposed in the DAPO paper (https://arxiv.org/pdf/2503.14476),
we allow setting a distinct minimum and maximum value for the clip parameter (set to the same value for PPO/GRPO/etc.)
- ratio_eps_min: minimum value for the clip parameter
- ratio_eps_max: maximum value for the clip parameter
- ratio_clip_min: minimum value for the clip parameter
- ratio_clip_max: maximum value for the clip parameter
- β is the KL penalty coefficient (reference_policy_kl_penalty)
- KL(π_θ || π_ref) is the KL divergence between the current policy and reference policy (Schulman Approx.)

Expand All @@ -78,8 +78,8 @@ class ClippedPGLossFn(LossFunction):
"""

def __init__(self, cfg: ClippedPGLossConfig):
self.ratio_eps_min = cfg["ratio_eps_min"]
self.ratio_eps_max = cfg["ratio_eps_max"]
self.ratio_clip_min = cfg["ratio_clip_min"]
self.ratio_clip_max = cfg["ratio_clip_max"]
self.reference_policy_kl_penalty = cfg["reference_policy_kl_penalty"]
self.disable_ppo_ratio = cfg.get("disable_ppo_ratio", False)
self.use_on_policy_kl_approximation = cfg["use_on_policy_kl_approximation"]
Expand Down Expand Up @@ -154,7 +154,7 @@ def __call__(
if not self.disable_ppo_ratio:
ratios = (curr_logprobs - prev_logprobs).exp()
ratios_clamped = ratios.clamp(
1.0 - self.ratio_eps_min, 1.0 + self.ratio_eps_max
1.0 - self.ratio_clip_min, 1.0 + self.ratio_clip_max
)
else:
ratios = curr_logprobs
Expand Down
32 changes: 16 additions & 16 deletions tests/unit/algorithms/test_loss_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -373,10 +373,10 @@ def test_clipped_pg_loss_ppo_clipping():
device = "cuda"
data, seq_len, vocab_size = _setup_clipped_pg_test_data(device=device)

ratio_eps = 0.2
ratio_clip = 0.2
cfg = {
"ratio_eps_min": ratio_eps,
"ratio_eps_max": ratio_eps,
"ratio_clip_min": ratio_clip,
"ratio_clip_max": ratio_clip,
"reference_policy_kl_penalty": 0.0, # Disable KL
"disable_ppo_ratio": False,
"use_on_policy_kl_approximation": False,
Expand Down Expand Up @@ -405,7 +405,7 @@ def test_clipped_pg_loss_ppo_clipping():
)

ratios_clamped = torch.clamp(
ratios, 1.0 - ratio_eps, 1.0 + ratio_eps
ratios, 1.0 - ratio_clip, 1.0 + ratio_clip
) # [0.8, 1.0, 1.2]
assert torch.allclose(
ratios_clamped, torch.tensor([[0.8, 1.0, 1.2]], device=device), rtol=1e-3
Expand Down Expand Up @@ -454,8 +454,8 @@ def test_clipped_pg_loss_reinforce_mode():
cfg = {
"disable_ppo_ratio": True,
"reference_policy_kl_penalty": 0.0,
"ratio_eps_min": 0.0, # Placeholder, ignored
"ratio_eps_max": 0.0, # Placeholder, ignored
"ratio_clip_min": 0.0, # Placeholder, ignored
"ratio_clip_max": 0.0, # Placeholder, ignored
"use_on_policy_kl_approximation": False,
"use_importance_sampling_correction": False,
}
Expand Down Expand Up @@ -501,8 +501,8 @@ def test_clipped_pg_loss_kl_penalty():
kl_beta = 0.1
cfg = {
"reference_policy_kl_penalty": kl_beta,
"ratio_eps_min": 0.2,
"ratio_eps_max": 0.2,
"ratio_clip_min": 0.2,
"ratio_clip_max": 0.2,
"disable_ppo_ratio": False,
"use_on_policy_kl_approximation": False,
"use_importance_sampling_correction": False,
Expand Down Expand Up @@ -572,8 +572,8 @@ def test_clipped_pg_loss_masking():
data["advantages"] = torch.randn_like(data["advantages"]) + 1.0

cfg = {
"ratio_eps_min": 0.2,
"ratio_eps_max": 0.2,
"ratio_clip_min": 0.2,
"ratio_clip_max": 0.2,
"reference_policy_kl_penalty": 0.1,
"disable_ppo_ratio": False,
"use_on_policy_kl_approximation": False,
Expand Down Expand Up @@ -635,8 +635,8 @@ def test_clipped_pg_loss_zero_mask():
dummy_logits = torch.randn(1, seq_len, vocab_size, device=device)

cfg = {
"ratio_eps_min": 0.2,
"ratio_eps_max": 0.2,
"ratio_clip_min": 0.2,
"ratio_clip_max": 0.2,
"reference_policy_kl_penalty": 0.1,
"disable_ppo_ratio": False,
"use_on_policy_kl_approximation": False,
Expand All @@ -661,12 +661,12 @@ def test_clipped_pg_loss_on_policy_kl_importance_sampling():
device = "cuda"
data, seq_len, vocab_size = _setup_clipped_pg_test_data(device=device)

ratio_eps = 0.2
ratio_clip = 0.2
kl_beta = 0.1

cfg = {
"ratio_eps_min": ratio_eps,
"ratio_eps_max": ratio_eps,
"ratio_clip_min": ratio_clip,
"ratio_clip_max": ratio_clip,
"reference_policy_kl_penalty": kl_beta,
"disable_ppo_ratio": False,
"use_on_policy_kl_approximation": True,
Expand Down Expand Up @@ -708,7 +708,7 @@ def test_clipped_pg_loss_on_policy_kl_importance_sampling():
)

ratios_clamped = torch.clamp(
ratios, 1.0 - ratio_eps, 1.0 + ratio_eps
ratios, 1.0 - ratio_clip, 1.0 + ratio_clip
) # [0.8, 1.0, 1.2]
assert torch.allclose(
ratios_clamped, torch.tensor([[0.8, 1.0, 1.2]], device=device), rtol=1e-3
Expand Down