rename adv_estimator param to advantage_estimator in compute_advantages_and_returns#1793
Open
KTanmay1 wants to merge 1 commit into
Open
rename adv_estimator param to advantage_estimator in compute_advantages_and_returns#1793KTanmay1 wants to merge 1 commit into
KTanmay1 wants to merge 1 commit into
Conversation
…es_and_returns The function parameter name `adv_estimator` diverged from the config field name `advantage_estimator` (AlgorithmConfig). This mismatch causes a confusing startup crash (ValueError from validate_dict_keys_against_dataclass) when writing new integrations that copy the function parameter name as a CLI config key. Rename the parameter and its one internal use to match the config field. Update the two keyword-argument call sites in trainer.py accordingly. Fixes NovaSky-AI#1792
Contributor
There was a problem hiding this comment.
Code Review
This pull request renames the parameter adv_estimator to advantage_estimator in the compute_advantages_and_returns function signature and updates its corresponding usages in skyrl/train/trainer.py to maintain consistency. I have no feedback to provide as the changes are straightforward and there are no review comments.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
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
Closes #1792.
The function
compute_advantages_and_returnsinppo_utils.pyusedadv_estimatoras its parameter name, while the corresponding config field onAlgorithmConfigisadvantage_estimator. These two names diverged silently — the internal plumbing worked correctly becausetrainer.pyreads the config field and passes it positionally-by-keyword, but the mismatch is a footgun for anyone writing a new integration or launch script.If a developer uses
trainer.algorithm.adv_estimator=<value>on the CLI (copying the function parameter name),validate_dict_keys_against_dataclassraises at startup:Changes
skyrl/backends/skyrl_train/utils/ppo_utils.py: rename parameteradv_estimator→advantage_estimatorand update its one internal useskyrl/train/trainer.py: update both keyword-argument call sites fromadv_estimator=→advantage_estimator=No behavior change — purely a naming fix.
Test plan
uv run --extra dev pytest tests/train/ tests/backends/skyrl_train/ --ignore=tests/backends/skyrl_train/gpu/