docs: fix critical doc-code mismatches across config, endpoints, LoRA, and metrics#1203
Closed
guozhihao-224 wants to merge 1 commit into
Closed
Conversation
…, and metrics
Fix high-priority documentation issues that can directly cause user errors:
1. **Proxy endpoints** (agent_workflow.md): Fix paths from /v1/chat/completions
and /v1/responses to /chat/completions and /responses. The OpenAI SDK puts
/v1/ in the base_url, not in the request path.
2. **Rollout config** (rollout_workflow.md): Remove non-existent
rollout.group_size YAML config (group_size is a runtime API parameter).
Fix trajectory dump path to include /logs/{user}/ segment.
3. **LoRA support** (cli_reference.md, lora.md, cli_args.py): Update "Only
support FSDP" to include Megatron (requires megatron-bridge). Add note
that SGLang LoRA requires weight_update_mode: disk.
4. **Metrics tracking** (metrics_tracking.md): Fix SwanLab mode from "online"
(invalid) to "cloud". Add Trackio as a supported logging backend.
Ref: areal-project#1165 (Findings areal-project#3, areal-project#4, areal-project#5, areal-project#8, areal-project#9, areal-project#14, areal-project#15)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation and CLI help text to include support for LoRA with the Megatron backend, requiring the megatron-bridge package, and specifies that SGLang LoRA requires the disk weight update mode. Additionally, it introduces trackio as a new metrics tracking backend, updates API endpoint paths in the agent workflow documentation by removing the /v1 prefix, and modifies the trajectory storage path to include user-specific directories. I have no feedback to provide.
This was referenced May 14, 2026
3 tasks
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
Fix high-priority documentation issues that can directly cause user errors (runtime
ValueError, 404s, or missing files), identified by automated audit in #1165.agent_workflow.md): Fix paths from/v1/chat/completionsand/v1/responsesto/chat/completionsand/responses. The OpenAI SDK puts/v1/inbase_url, not in the request path. (Finding nccl error, machine all-reduce communication test passed. #3)rollout_workflow.md): Remove non-existentrollout.group_sizeYAML config —group_sizeis a runtime API parameter onsubmit(), not a config field. Fix trajectory dump path to include/logs/{user}/segment. (Findings Update release v0.1.1 #4, Update release v0.1.2 #5)cli_reference.md,lora.md,cli_args.py): Update "Only support FSDP" to include Megatron (requiresmegatron-bridge). Add note that SGLang LoRA requiresweight_update_mode: disk. (Findings V0.2.0 prerelease #8, V0.2.0 prerelease #9)metrics_tracking.md): Fix SwanLab mode from"online"(invalid, causesValueError) to"cloud". Add Trackio as a supported logging backend. (Findings Can I use 1*GPU for training by setting 'allocation_made'? #14, Update README.md citation #15)Verification
Each fix was verified against the actual code:
server.pyconstants and OpenAI SDK URL construction behaviorgroup_size: confirmedInferenceEngineConfighas no such field; all examples useactor.adv_norm.group_sizeStatsLogger.get_log_path()atstats_logger.py:179MegatronEnginesupports LoRA viamegatron-bridgeatmegatron_engine.py:284cloud/local/offline/disabledatcli_args.py:2078stats_logger.py:97-107Test plan
pre-commit run --all-filespasses./docs/build_all.shbuilds without errorsuse_lorahelp stringRef: #1165
🤖 Generated with Claude Code