Skip to content

Conversation

@RayenTian
Copy link
Contributor

@RayenTian RayenTian commented Feb 2, 2026

What does this PR do ?

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

Issues

List issues that this PR closes (syntax):

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this

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 run the unit tests and functional tests locally? Visit our Testing Guide for how to run tests
  • Did you add or update any necessary documentation? Visit our Document Development Guide for how to write, build and test the docs.

Additional Information

  • ...

Summary by CodeRabbit

  • Documentation
    • Added reference link to a complete SFT LoRA configuration example within the setup guide for easier access to full configuration details.

✏️ Tip: You can customize this high-level summary in your review settings.

@RayenTian RayenTian requested a review from a team as a code owner February 2, 2026 02:56
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 2, 2026
@RayenTian RayenTian requested a review from yuki-97 February 2, 2026 02:56
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 2, 2026

📝 Walkthrough

Walkthrough

Adds a reference link to a full configuration example for SFT LoRA setup in the documentation guide's policy section, immediately following example usage without introducing any functional changes.

Changes

Cohort / File(s) Summary
Documentation
docs/guides/sft.md
Adds a reference link to a full configuration example for SFT LoRA setup within the policy section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

documentation

Suggested reviewers

  • lbliii
  • terrykong
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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 (adding a reference link in docs/guides/sft.md) with no functional code modifications, new features, breaking changes, or impact on numerics/convergence/performance.
Title check ✅ Passed The title clearly describes the main change: adding a nanov3 LoRA SFT recipe to documentation.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ruit/add_sft_recipe_doc

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.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@docs/guides/sft.md`:
- Line 237: There is a mismatch between the link text and the actual filename in
the markdown link: the display shows "sft-nanov3-30BA3B-2n4g-fsdp2-lora.yaml"
but the linked path points to "sft-nanov3-30BA3B-2n8g-fsdp2-lora.yaml"; fix by
making the display text match the real file name (or update the path if the
intended file was 2n4g), i.e., update the markdown link text or the target so
both use the same exact filename "sft-nanov3-30BA3B-2n8g-fsdp2-lora.yaml" (or
"sft-nanov3-30BA3B-2n4g-fsdp2-lora.yaml" if that is the correct file) in the
docs/guides/sft.md link line.
- Line 237: The link text and target mismatch: the text references
sft-nanov3-30BA3B-2n4g-fsdp2-lora.yaml while the URL points to
sft-nanov3-30BA3B-2n8g-fsdp2-lora.yaml; pick the intended recipe (either 2n4g or
2n8g) and make the link text and the URL consistent in the sentence referencing
the example (update either the displayed text or the URL so both use the same
filename, e.g., change the text to sft-nanov3-30BA3B-2n8g-fsdp2-lora.yaml if
that is the desired file or update the URL to
sft-nanov3-30BA3B-2n4g-fsdp2-lora.yaml to match the current text).

@RayenTian RayenTian changed the title Chore: add nanov3 lora sft recipe to doc chore: add nanov3 lora sft recipe to doc Feb 2, 2026
@terrykong terrykong merged commit 8ed3cd9 into main Feb 2, 2026
27 checks passed
@terrykong terrykong deleted the ruit/add_sft_recipe_doc branch February 2, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants