Skip to content

Conversation

@snowmanwwg
Copy link
Contributor

@snowmanwwg snowmanwwg commented Jan 2, 2026

Added documentation for model support and acceleration recipes.

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 documentation detailing broad model support for Hugging Face models (LLMs and VLMs), including supported model sizes, lists of compatible models, and acceleration optimization guidance with performance benchmarks.

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

Added documentation for model support and acceleration recipes.

Signed-off-by: Wenwen Gao <[email protected]>
@snowmanwwg snowmanwwg requested a review from a team as a code owner January 2, 2026 06:17
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 2, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 2, 2026

📝 Walkthrough

Walkthrough

Added documentation file describing Hugging Face model support in NeMo, covering LLMs and VLMs, supported model sizes, acceleration optimization via NeMo Megatron-bridge, and lists of compatible models.

Changes

Cohort / File(s) Summary
Documentation
docs/about/model-support.md
New documentation file detailing NeMo's support for Hugging Face models, including model types (LLMs, VLMs), supported sizes, acceleration guidance, and reference lists of supported models.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

CI:docs

Suggested reviewers

  • terrykong

Pre-merge checks

✅ 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 'Create model-support.md for NeMoRL' directly and accurately describes the main change—adding a new documentation file. It is concise, clear, and specific enough for a reviewer to understand the primary purpose of the PR.
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 documentation changes (new markdown file), which are minor changes exempt from test result requirements.

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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f017fd8 and 1f59f37.

📒 Files selected for processing (1)
  • docs/about/model-support.md
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.md

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Update docs/index.md when a new markdown doc is added under docs/**/*.md or a markdown file is renamed, ensuring the document appears in the most appropriate section

Files:

  • docs/about/model-support.md
!(**/tests/**|**/test_*.py|**/test_*.sh)

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Add the NVIDIA copyright header to all Python files and shell scripts (excluding tests). The header should include the current year

Files:

  • docs/about/model-support.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: build-container / main
  • GitHub Check: Lint check
  • GitHub Check: Post submodule check comment / Comment on PR
  • GitHub Check: Post automodel integration comment / Comment on PR
🔇 Additional comments (1)
docs/about/model-support.md (1)

1-28: Verify that docs/index.md has been updated to reference this new documentation file.

Per the coding guidelines, when a new markdown doc is added under docs/**/*.md, the docs/index.md file must be updated to include a reference in the most appropriate section. Please confirm that docs/index.md has been updated with an entry for this model-support.md documentation.


## Broad coverage for 🤗Hugging Face models via [NeMo AutoModel](https://github.com/NVIDIA-NeMo/Automodel)

NeMo-RL support 🤗Hugging Face models from the following classes
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix grammatical error: "support" should be "supports".

Line 5 is missing the verb conjugation.

-NeMo-RL support 🤗Hugging Face models from the following classes
+NeMo-RL supports 🤗Hugging Face models from the following classes
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
NeMo-RL support 🤗Hugging Face models from the following classes
NeMo-RL supports 🤗Hugging Face models from the following classes
🤖 Prompt for AI Agents
In docs/about/model-support.md around line 5, the sentence "NeMo-RL support
🤗Hugging Face models from the following classes" uses incorrect verb
conjugation; change "support" to "supports" so the sentence reads "NeMo-RL
supports 🤗Hugging Face models from the following classes."

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.

2 participants