Skip to content

Update: index all L3 worker examples in README#887

Closed
georgebisbas wants to merge 1 commit into
hw-native-sys:mainfrom
georgebisbas:docs/l3-readme-update
Closed

Update: index all L3 worker examples in README#887
georgebisbas wants to merge 1 commit into
hw-native-sys:mainfrom
georgebisbas:docs/l3-readme-update

Conversation

@georgebisbas
Copy link
Copy Markdown
Contributor

The examples/workers/l3/README.md table listed seven directories while the tree has ten. Add allgather_distributed and reduce_scatter_distributed with the same New concept style as the existing rows.

The examples/workers/l3/README.md table listed seven directories while
the tree has ten. Add allgather_distributed and reduce_scatter_distributed
with the same New concept style as the existing rows.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: df34ce31-6fd5-45ed-8bfb-326d58f45b00

📥 Commits

Reviewing files that changed from the base of the PR and between 61ba501 and 852c9c2.

📒 Files selected for processing (1)
  • examples/workers/l3/README.md

📝 Walkthrough

Walkthrough

The L3 examples README table is extended with two new rows documenting distributed communication examples: allgather_distributed/ and reduce_scatter_distributed/. Each entry describes the orchestration-time domain allocation and per-rank communication workflow for those patterns.

Changes

L3 Examples Documentation

Layer / File(s) Summary
Distributed communication examples documentation
examples/workers/l3/README.md
Table expanded with allgather_distributed/ and reduce_scatter_distributed/ entries, each describing per-rank staging, synchronization, and communication steps (gather or reduce-scatter).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through examples so fine,
Two new dancers join the communication line,
Allgather and reduce-scatter take their bow,
Distributed patterns documented now! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: updating the L3 worker examples README to include all examples by indexing previously unlisted ones.
Description check ✅ Passed The description directly relates to the changeset, explaining why the update is needed (7 examples listed vs 10 in tree) and what was added (allgather_distributed and reduce_scatter_distributed).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md in the L3 workers examples directory to document two new distributed examples: allgather_distributed/ and reduce_scatter_distributed/. There are no review comments, and I have no feedback to provide.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@georgebisbas
Copy link
Copy Markdown
Contributor Author

Closing as superseded by #888

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant