docs: clarify backend field is required, no implicit inheritance#1204
Closed
guozhihao-224 wants to merge 1 commit into
Closed
docs: clarify backend field is required, no implicit inheritance#1204guozhihao-224 wants to merge 1 commit into
guozhihao-224 wants to merge 1 commit into
Conversation
The `backend` field in `TrainEngineConfig` has `default=MISSING`, making it
required. The docs previously claimed that empty `critic.backend` or
`ref.backend` would "automatically inherit" from `actor.backend`, but there
is no code-level fallback. Clarify that users should use OmegaConf
interpolation (`${actor.backend}`) to share the actor backend.
Ref: areal-project#1165 (Finding areal-project#1)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in docs/en/reference/alloc_mode.md to specify that the backend field is now required for all engines, removing the implicit fallback behavior. It introduces the use of OmegaConf interpolation for sharing backend configurations between engines. I have no feedback to provide.
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
1 participant
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
Clarify that
critic.backendandref.backenddo not automatically inherit fromactor.backend. Thebackendfield hasdefault=MISSING(required), and there is no code-level fallback. Users should use OmegaConf interpolation${actor.backend}to share the actor backend.The previous docs showed
backend: ""and claimed it would "automatically inherit", which would actually cause a runtime error sinceMISSINGrequires an explicit value.Verification
TrainEngineConfig.backendhasdefault=MISSINGatcli_args.py:1131${actor.backend}interpolation (e.g.,gsm8k_ppo.yaml:85)__post_init__or resolver implements fallback logicTest plan
pre-commit run --all-filespasses./docs/build_all.shbuilds without errorsRef: #1165 (Finding #1)
🤖 Generated with Claude Code