Skip to content

docs(rl): repoint the refit example links at the split ModelExpress dirs - #14774

Merged
athreesh merged 2 commits into
ai-dynamo:mainfrom
ayaangazali:docs/fix-modelexpress-refit-example-link
Sep 14, 2026
Merged

athreesh merged 2 commits into
ai-dynamo:mainfrom
ayaangazali:docs/fix-modelexpress-refit-example-link

Conversation

@ayaangazali

@ayaangazali ayaangazali commented Sep 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

lychee is failing on every new PR in this repo, and this is the one broken link causing it:

[404] https://github.com/ai-dynamo/modelexpress/tree/main/examples/rl/dynamo_vllm_refit
      | Rejected status code: 404 Not Found

ai-dynamo/modelexpress split that directory in two. examples/rl still exists and now holds dynamo_vllm_reshard_refit and dynamo_vllm_s3_delta_refit, so the old path is gone.

Worth stating plainly because it looks intermittent: the check still reads SUCCESS on older open PRs such as #13888 and #14021 purely because those runs predate the rename. Any lychee run from now on fails, so this reddens new PRs regardless of what they change. I hit it on #14770, whose diff is two Rust files with no URLs.

The split also dated the sentence the link sits in. It claimed the example "does not qualify the S3 delta path", and there is now a dedicated example for that path: its README publishes a full snapshot v1 plus incremental snapshots d2 and d3 over S3. Repointing the link on its own would have left a sentence that the adjacent link disproves, so each example is now named for what it covers, and the caveat that neither qualifies every backend and topology is kept.

Validation

Both replacement paths were confirmed to exist before linking them, rather than inferred from the naming:

examples/rl/dynamo_vllm_reshard_refit   -> 6 entries
examples/rl/dynamo_vllm_s3_delta_refit  -> 8 entries
examples/rl/dynamo_vllm_refit           -> 404

The description of each example is taken from its own README, not guessed: the reshard one "validates the complete inference-side lifecycle" for a full-weight version over NIXL, and the S3 delta one "exercises the CoreWeave-shaped weight-synchronization lifecycle" with a full snapshot followed by incremental deltas.

No occurrence of dynamo_vllm_refit remains in the file. pre-commit over the changed file passes every hook except pytest-marker-report, which fails identically on a clean tree in this environment because vLLM is not installed.

Docs-only change; no code paths touched.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added links to separate vLLM resharding and S3 delta-refit examples.
    • Documented support for artifact refits using a full snapshot plus incremental deltas.
    • Clarified that the examples do not cover every backend or topology.

`examples/rl/dynamo_vllm_refit` in ai-dynamo/modelexpress was split into
`dynamo_vllm_reshard_refit` and `dynamo_vllm_s3_delta_refit`, so the link in
the weight-updates guide 404s. lychee reads that as a repo-wide failure, which
turns every new PR red regardless of what it changes: the check still shows
SUCCESS on older open PRs only because those runs predate the rename.

The split also dated the sentence around the link. It said the example
"does not qualify the S3 delta path", and there is now a dedicated example for
exactly that path: its README publishes a full snapshot followed by two
incremental snapshots over S3. Repointing the link alone would have left a
claim that the neighbouring link disproves, so both halves are named for what
they actually cover, and the honest caveat that neither qualifies every backend
and topology stays.

Signed-off-by: ayaangazali <ayaangazali@users.noreply.github.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: ayaangazali <ayaangazali.work@gmail.com>
@ayaangazali
ayaangazali requested a review from a team as a code owner September 13, 2026 03:06
Copilot AI lite review requested due to automatic review settings September 13, 2026 03:06
@copy-pr-bot

copy-pr-bot Bot commented Sep 13, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@ayaangazali
ayaangazali deployed to external_collaborator September 13, 2026 03:06 — with GitHub Actions Active
@ayaangazali
ayaangazali deployed to external_collaborator September 13, 2026 03:06 — with GitHub Actions Active

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Sep 13, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot added external-contribution Pull request is from an external contributor docs documentation Improvements or additions to documentation labels Sep 13, 2026
@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 6293460c-5870-4031-92b0-1731e1684cad

📥 Commits

Reviewing files that changed from the base of the PR and between 13a8523 and 3cdaae8.

📒 Files selected for processing (1)
  • docs/fern/pages/use-cases/reinforcement-learning/weight-updates.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

The ModelExpress refit documentation now separates full-weight trainer-to-inference resharding from S3 artifact delta refitting. It also states the qualification limits for both examples and keeps startup loading as a separate workflow.

Changes

ModelExpress refit documentation

Layer / File(s) Summary
Refit example links and scope
docs/fern/pages/use-cases/reinforcement-learning/weight-updates.md
The page links to separate vLLM reshard and S3 delta refit examples. It documents full-snapshot-plus-incremental-delta coverage and qualification limits for both examples.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 3cdaa

The updated documentation links to the split workflows without introducing product or operational risk.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the broken link, the replacement paths, the documentation updates, and validation results. However, it does not follow the required template because it omits the "Where should… Add the required "Where should the reviewer start?" section with the changed file, and add the "Related Issues" section with either the relevant issue reference or the checked confirmation that this PR has no related issue.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation change: it repoints the broken refit example links to the split ModelExpress directories.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the broken link, the replacement paths, the documentation updates, and validation results. However, it does not follow the required template because it omits the "Where should the reviewer start?" section and the required "Related Issues" section with an issue link or confirmation that no related issue exists.

  • Fix all pre-merge checks with AI

Comment @coderabbitai help to get the list of available commands.

@athreesh
athreesh enabled auto-merge (squash) September 13, 2026 22:29

Copy link
Copy Markdown
Contributor

/ok to test 3cdaae8

@nv-rinig
nv-rinig deployed to external_collaborator September 14, 2026 00:26 — with GitHub Actions Active
@nv-rinig

Copy link
Copy Markdown
Contributor

/ok to test 39e410d

@athreesh
athreesh merged commit 11b85b9 into ai-dynamo:main Sep 14, 2026
97 checks passed
jain-ria added a commit that referenced this pull request Sep 18, 2026
Remove the obsolete checkpoint source link and regenerate the operator references, adopt the split ModelExpress refit examples, and link the GB200 recipe to the release branch where it remains available.

Adapted from #14353 and #14774; all replacement targets return HTTP 200.

Signed-off-by: jain-ria <riajain@NVIDIA.com>
jain-ria added a commit that referenced this pull request Sep 18, 2026
Remove the obsolete checkpoint source link and regenerate the operator references, adopt the split ModelExpress refit examples, and link the GB200 recipe to the release branch where it remains available.

Adapted from #14353 and #14774; all replacement targets return HTTP 200.

Signed-off-by: jain-ria <riajain@NVIDIA.com>

This branch was successfully deployed

1 active deployment
external_collaborator — 39e410d9 Deployed Sep 14, 2026 by nv-rinig via ok-to-test #17819
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation external-contribution Pull request is from an external contributor size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants