docs(rho_setting): document grad-rho options + flag sep-rho/reduced-costs-rho deprecations#680
Open
DLWoodruff wants to merge 1 commit into
Open
docs(rho_setting): document grad-rho options + flag sep-rho/reduced-costs-rho deprecations#680DLWoodruff wants to merge 1 commit into
DLWoodruff wants to merge 1 commit into
Conversation
The --grad-rho section previously documented only --grad-rho-multiplier out of six gradient-rho options. Add a bullet list covering all five previously-undocumented options (--grad-order-stat, --grad-rho-relative-bound, --eval-at-xhat, --indep-denom, plus the already-mentioned multiplier) with their defaults and a one-line operational description. Add a .. note:: deprecation notice to the --sep-rho and --reduced-costs-rho sections referencing Pyomo#673 so users can plan migration; both rho setters now emit a DeprecationWarning at instantiation as part of the same issue's cleanup. grad_rho.rst stays a brief pointer; deeper algorithmic content is planned for after the academic paper lands. Add a .. _grad_rho: cross-reference label so rho_setting.rst can link to it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #680 +/- ##
==========================================
+ Coverage 71.02% 71.03% +0.01%
==========================================
Files 154 154
Lines 19248 19248
==========================================
+ Hits 13670 13672 +2
+ Misses 5578 5576 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Doc-only follow-up to #679. Two changes:
Document the gradient-rho options.
rho_setting.rstpreviouslydescribed only
--grad-rho-multiplierout of the six optionscfg.gradient_args()registers. Add a bullet list covering allfive undocumented options:
--grad-order-stat(default0.5) — order statistic acrossscenarios; 0 = min, 1 = max, 0.5 = mean, with linear interpolation
in the open intervals.
--grad-rho-relative-bound(default100) — floor on theprimal-residual denominator relative to xbar.
--eval-at-xhat(default off) — evaluate the gradient at thebest xhat from an xhat-producing spoke instead of at the latest
subproblem iterate.
--indep-denom(default off) — use a singleprobability-weighted, MPI-Allreduced denominator across scenarios.
--grad-rho-multiplier(default1.0) — scalar multiplierapplied to every computed rho (already documented; left in for
completeness in the same list).
Flag
--sep-rhoand--reduced-costs-rhoas scheduled fordeprecation. Per
issue #673 <https://github.com/Pyomo/mpi-sppy/issues/673>_, bothmethods are slated for removal:
SepRhois expected to besubsumed into
GradRho, and reduced-cost rho has not beendemonstrated to be effective in practice. PR rho setters: aggregate per-sub-scenario nonants in proper bundles (closes #673) #679 has already
added a
DeprecationWarningat instantiation; this PR adds an.. note::on each section so the rendered docs match.grad_rho.rststays a brief pointer (the academic paper covering thealgorithm is in preparation); a
.. _grad_rho:cross-reference labelis added so
rho_setting.rstcan link to it.Test plan
cd doc && make htmlbuilds without new warnings (verifiedlocally — the only warning is the pre-existing
viewcode_importconfig typo, unrelated).notes correctly.
🤖 Generated with Claude Code