Skip to content

Add W&B report to GPT-OSS Examples#2651

Open
cuichenx wants to merge 1 commit intomainfrom
chcui/gpt-oss-wandb-report
Open

Add W&B report to GPT-OSS Examples#2651
cuichenx wants to merge 1 commit intomainfrom
chcui/gpt-oss-wandb-report

Conversation

@cuichenx
Copy link
Contributor

@cuichenx cuichenx commented Mar 4, 2026

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

Changelog

  • Add specific line by line info of high level changes in this PR.

GitHub Actions CI

See the CI sectionin the Contributing doc for how to trigger the CI. A Nvidia developer will need to approve and trigger the CI for external contributors.

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

If you haven't finished some of the above items you can still open "Draft" PR.

Additional Information

  • Related to # (issue)

Summary by CodeRabbit

  • Documentation
    • Updated documentation by replacing placeholder sections with detailed training dynamics information and direct report access links
    • Removed temporary placeholder notes from model configuration areas
    • Enhanced the inference section with comprehensive usage examples
    • Applied minor formatting refinements for consistency

Signed-off-by: Chen Cui <chcui@nvidia.com>
@cuichenx cuichenx added the docs-only With great power comes great responsibility. label Mar 4, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2026

📝 Walkthrough

Walkthrough

Documentation in the GPT OSS example README is updated to replace three placeholder notes with a new "Expected Training Dynamics" section containing a direct Weights & Biases report link, and minor trailing whitespace adjustments.

Changes

Cohort / File(s) Summary
Documentation Updates
examples/models/gpt_oss/README.md
Replaces three occurrences of "W&B report coming soon." placeholder with new "Expected Training Dynamics" section including a Weights & Biases report link; removes placeholder notes around SFT and PEFT sections; minor trailing newline adjustment in Evaluation section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add W&B report to GPT-OSS Examples' accurately describes the main change: adding a Weights & Biases report link to the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Results For Major Changes ✅ Passed PR contains only minor documentation changes to README.md with no functional code changes, no impact on testing or performance.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chcui/gpt-oss-wandb-report

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
examples/models/gpt_oss/README.md (1)

105-106: Use the canonical Weights & Biases report URL instead of the short link.

The short-link format (api.wandb.ai/links/…) is less maintainable for long-term documentation. Replace it with the canonical report URL (wandb.ai/{entity}/{project}/reports/…) generated through the official W&B share flow, which is more stable and follows W&B's recommended practice for shareable documentation links.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@examples/models/gpt_oss/README.md` around lines 105 - 106, In the "###
Expected Training Dynamics" section replace the short-form wandb link currently
using the api.wandb.ai/links/... short-link with the canonical Weights & Biases
report URL (wandb.ai/{entity}/{project}/reports/{report-slug-or-id}) produced by
W&B's share flow; update the link text in examples/models/gpt_oss/README.md so
the existing short link is swapped for the full
wandb.ai/{entity}/{project}/reports/... URL to ensure a stable, maintainable
reference.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@examples/models/gpt_oss/README.md`:
- Around line 105-106: In the "### Expected Training Dynamics" section replace
the short-form wandb link currently using the api.wandb.ai/links/... short-link
with the canonical Weights & Biases report URL
(wandb.ai/{entity}/{project}/reports/{report-slug-or-id}) produced by W&B's
share flow; update the link text in examples/models/gpt_oss/README.md so the
existing short link is swapped for the full
wandb.ai/{entity}/{project}/reports/... URL to ensure a stable, maintainable
reference.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 079b6e47-a294-48ad-ba17-dc0bb25d4dae

📥 Commits

Reviewing files that changed from the base of the PR and between dd0a1d9 and ecdd8f4.

📒 Files selected for processing (1)
  • examples/models/gpt_oss/README.md

@cuichenx cuichenx requested review from weijiac0619 and yaoyu-33 March 4, 2026 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-only With great power comes great responsibility.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants