Skip to content

docs: clarify backend field is required, no implicit inheritance #1204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
guozhihao-224 wants to merge 1 commit into from
Closed

docs: clarify backend field is required, no implicit inheritance #1204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/en/reference/alloc_mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,18 @@ rollout:
actor:
backend: "fsdp:d8"

# Critic engine (falls back to actor.backend if empty)
# Critic engine (use YAML interpolation to share actor's backend)
critic:
backend: ""
backend: "${actor.backend}"

# Ref engine (falls back to actor.backend if empty)
# Ref engine (use YAML interpolation to share actor's backend)
ref:
backend: ""
backend: "${actor.backend}"
```

When `critic.backend` or `ref.backend` is empty, it automatically inherits from
`actor.backend`.
The `backend` field is required for all engines. To reuse the actor's backend
configuration, use OmegaConf interpolation `${actor.backend}` as shown above.
There is no implicit fallback—an empty or missing `backend` value will raise an error.

> **Note:** The top-level `allocation_mode` config field is deprecated and only retained
> for backward compatibility with legacy SPMD launchers (local/ray/slurm). It is ignored
Expand Down
Loading