]> Piment Noir Git Repositories - freqai-strategies.git/commitdiff
docs(reforcexy): improve win_reward_factor documentation
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Mon, 6 Oct 2025 23:11:04 +0000 (01:11 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Mon, 6 Oct 2025 23:11:04 +0000 (01:11 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
ReforceXY/reward_space_analysis/README.md
ReforceXY/reward_space_analysis/reward_space_analysis.py

index 683ab273695f8dfe7cf11bae735d75f6acab8849..d657c78e4416863fef93455d875b9a718ba7f457 100644 (file)
@@ -268,7 +268,7 @@ _Efficiency configuration:_
 
 _Profit factor configuration:_
 
-- `win_reward_factor` (default: 2.0) - Amplification for PnL above target (no upper bound; effective profit_target_factor ∈ [1, 1 + win_reward_factor] because tanh ≤ 1)
+- `win_reward_factor` (default: 2.0) - Asymptotic bonus multiplier for PnL above target. Raw `profit_target_factor` ∈ [1, 1 + win_reward_factor] (tanh bounds it); overall amplification may exceed this once multiplied by `efficiency_factor`.
 - `pnl_factor_beta` (default: 0.5) - Sensitivity of amplification around target
 
 _Invariant / safety controls:_
@@ -704,7 +704,7 @@ Before simulation (early in `main()`), `validate_reward_parameters` enforces num
 | `exit_half_life` | 1e-6 | — | Half-life in duration ratio units |
 | `efficiency_weight` | 0.0 | 2.0 | Blend weight |
 | `efficiency_center` | 0.0 | 1.0 | Linear pivot (efficiency ratio center) |
-| `win_reward_factor` | 0.0 | — | Amplification for pnl above target |
+| `win_reward_factor` | 0.0 | — | Asymptotic bonus multiplier for pnl above target |
 | `pnl_factor_beta` | 1e-6 | — | Sensitivity ≥ tiny positive |
 
 Non-finite inputs are reset to the applicable minimum (or 0.0 if only a maximum is declared) and logged as adjustments.
index 17fdc55073f9b74b46cafe19226e54f2bc8a935c..cdddc640b9ba0346f541292fe5bcf1900a2ee84e 100644 (file)
@@ -166,7 +166,7 @@ DEFAULT_MODEL_REWARD_PARAMETERS_HELP: Dict[str, str] = {
     "exit_half_life": "Half-life for exponential decay exit mode.",
     "efficiency_weight": "Weight for efficiency factor in exit reward.",
     "efficiency_center": "Pivot (in [0,1]) for linear efficiency factor; efficiency_ratio above this increases factor, below decreases.",
-    "win_reward_factor": "Amplification for pnl above target (no hard cap; asymptotic).",
+    "win_reward_factor": "Asymptotic bonus multiplier for pnl above target: approaches (1 + win_reward_factor); combined with efficiency_factor the final product can exceed this bound.",
     "pnl_factor_beta": "Sensitivity of amplification around target.",
     "check_invariants": "Boolean flag (true/false) to enable runtime invariant & safety checks.",
     "exit_factor_threshold": "If |exit factor| exceeds this threshold, emit warning.",