Skip to content

docs: address nvbugs 6581813 and 6581793 - #1215

Open
gabwow wants to merge 1 commit into
mainfrom
nv6581813-fix-doc-error/agabow
Open

docs: address nvbugs 6581813 and 6581793#1215
gabwow wants to merge 1 commit into
mainfrom
nv6581813-fix-doc-error/agabow

Conversation

@gabwow

@gabwow gabwow commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Address to lower priority docs issues:
nvbugs 6581813 and nvbugs 6581793. One was we simply weren't referencing the new nemo-rl training image in our listed images. The other was we had multiple references to the deprecated get_logs call.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • [ X] Pull request title follows the repository's Conventional Commit format
  • [ X] Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • [ X] No secrets, API keys, or credentials are included

Targeted validation:

Summary by CodeRabbit

  • Documentation
    • Added the reinforcement learning training container image and its docker pull command to the available container images table.
    • Updated customization tutorials for distillation, embedding, and supervised fine-tuning to provide clearer deployment troubleshooting guidance.
    • Troubleshooting instructions now recommend checking deployment status and confirming it reaches READY before using the deployment for inference.

Signed-off-by: Aaron Gabow <agabow@nvidia.com>
@gabwow
gabwow requested review from a team as code owners August 10, 2026 20:00
@github-actions github-actions Bot added the docs label Aug 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review 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: 6de0aabd-fa84-4812-886f-948055e169dd

📥 Commits

Reviewing files that changed from the base of the PR and between d8205de and f409099.

📒 Files selected for processing (7)
  • docs/customizer/index.mdx
  • docs/customizer/tutorials/distillation-customization-job.ipynb
  • docs/customizer/tutorials/distillation-customization-job.mdx
  • docs/customizer/tutorials/embedding-customization-job.ipynb
  • docs/customizer/tutorials/embedding-customization-job.mdx
  • docs/customizer/tutorials/sft-customization-job.ipynb
  • docs/customizer/tutorials/sft-customization-job.mdx

📝 Walkthrough

Walkthrough

Changes

Customizer documentation

Layer / File(s) Summary
Deployment status troubleshooting
docs/customizer/tutorials/*
The distillation, embedding, and SFT tutorials now instruct readers to retrieve deployment status and verify READY before inference.
Training image catalog
docs/customizer/index.mdx
Added the nmp-rl-training image and its docker pull command.

Suggested reviewers: a2bondar

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies a documentation change that addresses the two bugs covered by the pull request.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nv6581813-fix-doc-error/agabow

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

@albcui albcui 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.

Actually, can you also fix customizer.mdx, it has the same issue.

@github-actions

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 32002/40616 78.8% 63.6%
Integration Tests 18553/38542 48.1% 20.8%

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants