]> Piment Noir Git Repositories - freqai-strategies.git/commitdiff
docs(reforcexy): document optuna journal recovery
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 2 Jul 2026 23:50:19 +0000 (01:50 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 2 Jul 2026 23:50:19 +0000 (01:50 +0200)
README.md

index 9b823ea99d3ba683e38f8996b00dd402096021c1..22c71e41d93c47a0b94383a24b9d80e0186b8e49 100644 (file)
--- a/README.md
+++ b/README.md
@@ -181,6 +181,12 @@ The documented list of model tunables is at the top of the
 The rewarding logic and tunables are documented in the
 [reward space analysis](./ReforceXY/reward_space_analysis/README.md).
 
+When `rl_config_optuna` uses `storage=file`, ReforceXY may quarantine a
+corrupt Optuna journal as `<original-journal-filename>.corrupt-<UTC>` and retry
+once with a fresh journal. This only affects file-backed Optuna storage. The
+`sampler`, `model_reward_parameters`, `PBRS`, and `&-action` behavior is
+unchanged.
+
 ## Common workflows
 
 **List running compose services and the containers they created:**