docs: Reafactor the README.md#103
Conversation
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
…epo or the license until the repo is made public Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
…scription from the image's alt-text into the elevator pitch, replacing the alt-text with a description of the image Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThe pull request reorganizes installation and onboarding guidance, introduces grouped consumer and harness integration documentation, adds consumer SDK reference material, and updates repository links, badges, ignore rules, tests, and temporary workaround references. ChangesDocumentation and integration guidance
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Fern docs preview: https://nvidia-preview-pull-request-103.docs.buildwithfern.com/nemo/fabric |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 50-53: Update the Markdown formatting around the installation code
fences: in CONTRIBUTING.md at lines 50-53, add a blank line before the fence; in
README.md at lines 27-35, add blank lines before both installation fences.
Preserve the existing fence contents.
In `@docs/getting-started/install.mdx`:
- Line 27: Quote the package extras in all installation commands: update
docs/getting-started/install.mdx lines 27-27, README.md lines 31-31, and
skills/nemo-fabric-integrate/SKILL.md lines 47-47 so the nemo-fabric[runtime]
package spec is enclosed in quotes while preserving the existing pip and uv pip
commands.
In `@README.md`:
- Around line 6-13: Move the badge block below the top-level “# NVIDIA NeMo
Fabric” heading in README.md (lines 6-13) and pypi.md (lines 6-13), preserving
the existing badges and links.
- Around line 19-25: Update the introductory prose in the README around the NeMo
Fabric description: correct the malformed punctuation and spacing in
“harness-Hermes Agent” and “adapter-and call,” and change “seperate” to
“separate,” while preserving the intended meaning.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 8220552a-bcb0-4ca5-8bf2-0f22b82f6d06
📒 Files selected for processing (9)
.gitignoreCONTRIBUTING.mdREADME.mdTODO.mddocs/getting-started/install.mdxdocs/getting-started/quickstart.mdxpypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.md
💤 Files with no reviewable changes (1)
- TODO.md
📜 Review details
⏰ Context from checks skipped due to timeout. (5)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.12, macos-arm64)
- GitHub Check: Test (Python 3.13, macos-arm64)
- GitHub Check: Test (Python 3.14, macos-arm64)
- GitHub Check: Pre-commit
🧰 Additional context used
📓 Path-based instructions (18)
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
docs/getting-started/install.mdxdocs/getting-started/quickstart.mdxREADME.md
{docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.
Files:
docs/getting-started/install.mdxdocs/getting-started/quickstart.mdx
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.Use
{/* ... */}delimiters for top-of-file MDX SPDX comments, not HTML comment delimiters.Every MDX file must include the specified SPDX copyright and Apache-2.0 license header using a JSX comment.
Files:
docs/getting-started/install.mdxdocs/getting-started/quickstart.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/getting-started/install.mdxdocs/getting-started/quickstart.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Always spellNVIDIAin all caps; do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names withNVIDIAon first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...
Files:
docs/getting-started/install.mdxpypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/getting-started/quickstart.mdxCONTRIBUTING.mdREADME.md
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
docs/getting-started/install.mdxpypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/getting-started/quickstart.mdxCONTRIBUTING.mdREADME.md
docs/**/*
📄 CodeRabbit inference engine (AGENTS.md)
Update Fern documentation under
docs/when public behavior, thenemo-fabricpackage, examples, or supported bindings change.
Files:
docs/getting-started/install.mdxdocs/getting-started/quickstart.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,mdx}: Use the full product nameNVIDIA NeMo Fabricon its first usage, typically in the title or H1; useNeMo Fabricthereafter.
Usefabricby itself only when referring to the CLI tool, and surround those references with backticks.
CapitalizeNVIDIAcorrectly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such ashere.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Useafterinstead ofoncewhen expressing temporal sequence.
Usecaninstead ofmaywhen the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.
Files:
docs/getting-started/install.mdxpypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/getting-started/quickstart.mdxCONTRIBUTING.mdREADME.md
{docs/**,README.md,AGENTS.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
Files:
docs/getting-started/install.mdxdocs/getting-started/quickstart.mdxREADME.md
{*.md,**/*.md,**/*.mdx,**/*.ipynb}
⚙️ CodeRabbit configuration file
{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercasefabricCLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.
Files:
docs/getting-started/install.mdxpypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/getting-started/quickstart.mdxCONTRIBUTING.mdREADME.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Update documentation and examples in the same branch as the public API change.
Files:
pypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mdCONTRIBUTING.mdREADME.md
**/*.{md,rst,txt,adoc}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)
**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Usecanfor possibility and reservemayfor permission; useafterfor temporal order; userefer tofor cross-references; prefer short direct sentences and specific verbs; avoid unnecessarypleasein technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: usefor exampleorsuch asinstead ofe.g.,and so oninstead ofetc.,that isinstead ofi.e.,compared toinstead ofvs., andby,through, orusinginstead ofvia. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Usethatwithout commas for essential clauses, andwhichwith commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such asJune 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space beforea.m.orp.m.; useETandPTfor needed time zones; avoid24/7; and preferfrom 12:30 to 1:00 p.m.for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...
Files:
pypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mdCONTRIBUTING.mdREADME.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Every HTML and Markdown file must include the specified SPDX copyright and Apache-2.0 license header using HTML comment syntax.
Files:
pypi.mdskills/README.mdskills/nemo-fabric-integrate/SKILL.mdCONTRIBUTING.mdREADME.md
skills/**
📄 CodeRabbit inference engine (AGENTS.md)
skills/**: Keep consumer skills underskills/self-contained and dependent only on supported public Python SDK contracts and published documentation; do not add repository-internal contribution guidance.
Keep consumer skills in parity with the public SDK guide, model, and type details when the Python/Rust binding contract changes.
Files:
skills/README.mdskills/nemo-fabric-integrate/SKILL.md
**/README.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update relevant package, crate, adapter, and integration README files when public behavior or entry-point documentation changes.
Files:
skills/README.mdREADME.md
**/SKILL.md
⚙️ CodeRabbit configuration file
**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.
Files:
skills/nemo-fabric-integrate/SKILL.md
{README.md,docs/index.yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update
README.mdordocs/index.ymlwhen documentation entry points or example reading paths change.
Files:
README.md
README.md
📄 CodeRabbit inference engine (AGENTS.md)
Update the root
README.mdwhen public behavior, thenemo-fabricpackage, examples, or supported bindings change.Update the top-level
README.mdwhen changed behavior affects an entry point users would naturally consult.
Files:
README.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-22T21:54:56.373Z
Learning: If a change affects public behavior, adapters, examples, or workspace structure, update the corresponding documentation in the same branch.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-22T21:54:56.373Z
Learning: Before submitting a pull request, run relevant tests, verify affected packages compile, update documentation, and rebase on the latest `main`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-22T21:54:56.373Z
Learning: All contributions must have DCO-signed commits using `git commit --signoff` or `git commit -s`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-22T21:54:56.373Z
Learning: Pull requests must include an overview, reviewer starting point, related issue, testing details, and breaking-change information.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-22T21:54:56.373Z
Learning: All pull requests require at least one approving review, must address review feedback without force-pushing during review, and must have passing CI before merge.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-22T21:54:56.373Z
Learning: Use commit messages in the format `type: short description`, with one of the approved types, keep the first line under 72 characters, and use the body for additional context when needed.
🪛 markdownlint-cli2 (0.23.0)
pypi.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
CONTRIBUTING.md
[warning] 52-52: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 28-28: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 35-35: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🔇 Additional comments (6)
CONTRIBUTING.md (1)
38-40: LGTM!Also applies to: 42-51, 54-63, 105-105
skills/nemo-fabric-integrate/SKILL.md (1)
48-51: LGTM!README.md (1)
15-18: LGTM!Also applies to: 39-48, 50-87, 89-112, 129-129
docs/getting-started/quickstart.mdx (1)
40-51: LGTM!.gitignore (1)
21-21: LGTM!skills/README.md (1)
27-27: LGTM!
Signed-off-by: Anuradha Karuppiah <26330987+AnuradhaKaruppiah@users.noreply.github.com>
Signed-off-by: Anuradha Karuppiah <26330987+AnuradhaKaruppiah@users.noreply.github.com>
Signed-off-by: Anuradha Karuppiah <26330987+AnuradhaKaruppiah@users.noreply.github.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
README.md (2)
31-31: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winQuote the
runtimeextra.Use
pip install "nemo-fabric[runtime]". Unquoted brackets can be interpreted as shell glob syntax, unlike the command on Line 36.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 31, Update the README installation command to quote the nemo-fabric runtime extra, using the same quoting convention as the other installation command and preserving the existing package and extra name.
90-90: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument harness-specific environment requirements.
Changing only
adapter_idis not sufficient for every supported harness. Theclaudepreset also requiresNVIDIA_FRONTIER_BASE_URLin addition toNVIDIA_API_KEY(crates/fabric-cli/src/presets.rs:120-150). Add a per-harness configuration note or qualify this statement.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 90, Update the harness configuration guidance around adapter_id and HarnessConfig to state that supported harnesses may require different environment variables; specifically document that the claude preset requires NVIDIA_FRONTIER_BASE_URL in addition to NVIDIA_API_KEY, while preserving the existing settings-field guidance.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@README.md`:
- Line 31: Update the README installation command to quote the nemo-fabric
runtime extra, using the same quoting convention as the other installation
command and preserving the existing package and extra name.
- Line 90: Update the harness configuration guidance around adapter_id and
HarnessConfig to state that supported harnesses may require different
environment variables; specifically document that the claude preset requires
NVIDIA_FRONTIER_BASE_URL in addition to NVIDIA_API_KEY, while preserving the
existing settings-field guidance.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 33662224-f341-415a-96e1-87513166cbfe
📒 Files selected for processing (1)
README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (18)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.11, windows-amd64)
- GitHub Check: Test (Python 3.12, macos-arm64)
- GitHub Check: Test (Python 3.12, windows-amd64)
- GitHub Check: Test (Python 3.14, linux-arm64)
- GitHub Check: Pre-commit
- GitHub Check: Test (Python 3.14, windows-amd64)
- GitHub Check: Test (Python 3.12, linux-arm64)
- GitHub Check: Test (Python 3.11, macos-arm64)
- GitHub Check: Test (Python 3.14, macos-arm64)
- GitHub Check: Test (Python 3.14, linux-amd64)
- GitHub Check: Test (Python 3.13, macos-arm64)
- GitHub Check: Test (Python 3.11, linux-amd64)
- GitHub Check: Test (Python 3.13, linux-arm64)
- GitHub Check: Test (Python 3.13, linux-amd64)
- GitHub Check: Test (Python 3.11, linux-arm64)
- GitHub Check: Test (Python 3.13, windows-amd64)
- GitHub Check: Test (Python 3.12, linux-amd64)
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Update documentation and examples in the same branch as the public API change.
Files:
README.md
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
README.md
{README.md,docs/index.yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update
README.mdordocs/index.ymlwhen documentation entry points or example reading paths change.
Files:
README.md
**/*
📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Always spellNVIDIAin all caps; do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names withNVIDIAon first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...
Files:
README.md
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
README.md
**/*.{md,rst,txt,adoc}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)
**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Usecanfor possibility and reservemayfor permission; useafterfor temporal order; userefer tofor cross-references; prefer short direct sentences and specific verbs; avoid unnecessarypleasein technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: usefor exampleorsuch asinstead ofe.g.,and so oninstead ofetc.,that isinstead ofi.e.,compared toinstead ofvs., andby,through, orusinginstead ofvia. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Usethatwithout commas for essential clauses, andwhichwith commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such asJune 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space beforea.m.orp.m.; useETandPTfor needed time zones; avoid24/7; and preferfrom 12:30 to 1:00 p.m.for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...
Files:
README.md
README.md
📄 CodeRabbit inference engine (AGENTS.md)
Update the root
README.mdwhen public behavior, thenemo-fabricpackage, examples, or supported bindings change.Update the top-level
README.mdwhen changed behavior affects an entry point users would naturally consult.
Files:
README.md
**/README.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update relevant package, crate, adapter, and integration README files when public behavior or entry-point documentation changes.
Files:
README.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,mdx}: Use the full product nameNVIDIA NeMo Fabricon its first usage, typically in the title or H1; useNeMo Fabricthereafter.
Usefabricby itself only when referring to the CLI tool, and surround those references with backticks.
CapitalizeNVIDIAcorrectly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such ashere.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Useafterinstead ofoncewhen expressing temporal sequence.
Usecaninstead ofmaywhen the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.
Files:
README.md
**/*.{rs,py,html,md,mdx,toml,yaml,yml,sh}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All Rust, Python, HTML, Markdown, MDX, TOML, YAML, and shell source files must include the specified SPDX copyright and Apache-2.0 license headers using the appropriate comment syntax.
Files:
README.md
{docs/**,README.md,AGENTS.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
Files:
README.md
{*.md,**/*.md,**/*.mdx,**/*.ipynb}
⚙️ CodeRabbit configuration file
{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercasefabricCLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.
Files:
README.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: Run tests for every language surface affected by a change. Changes to the Rust core or public schemas must run both the Rust and Python test suites.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation in the same branch.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: Versioned release tags must use raw Rust-compatible SemVer without a leading `v`, such as `0.1.0` or `0.1.0-rc.1`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: All contributors must sign off commits using `git commit -s`; commits without DCO sign-off are not accepted.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: Before submitting a pull request, run relevant tests, verify affected packages compile, update documentation, and rebase on the latest `main`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: Pull requests must have at least one approving review, address review feedback without force-pushing during review, and pass CI before merge.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-23T15:22:09.437Z
Learning: Use commit messages in the format `type: short description`, with an allowed type such as `feat`, `fix`, `docs`, `test`, `refactor`, `chore`, or `perf`; keep the first line under 72 characters.
🔇 Additional comments (4)
README.md (4)
21-25: Existing prose issues remain unresolved.Line 21 still contains malformed punctuation and spacing, and Line 25 still misspells
separate. This duplicates the prior review finding.
48-51: 🎯 Functional CorrectnessVerify the supported-platform claims.
Confirm these Linux, macOS, and Windows combinations against package metadata, CI, and installation documentation before publishing. Remove or qualify any platform not explicitly supported.
As per coding guidelines, verify technical documentation claims against the current repository.
Source: Coding guidelines
74-86: 🎯 Functional CorrectnessVerify the quickstart against the current SDK and adapter registration.
The supplied SDK contract confirms that
adapter_idis required, but does not establish thatnvidia.fabric.hermes, the shownModelConfigfields, and the model identifier are valid together. Run this example in a clean environment or compare it with the canonical quickstart tests.As per coding guidelines, verify documentation examples against the current API.
Source: Coding guidelines
118-132: LGTM!
docs: clarify README onboarding and integrations
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
#### Overview Clarify the Python SDK examples so users export the required NVIDIA-hosted model credential and print the adapter response instead of the `RunOutput` object identity. This issue predates #103; that PR changes links in `docs/sdk/python.mdx` but does not change the affected credential or output examples. This PR therefore targets `main` directly. #### Details - Add the required `NVIDIA_API_KEY` export before the first Hermes example. - Print `result.output.response` in both affected examples. - Breaking changes: none. #### Validation - `just docs` (passed; the unauthenticated Fern redirects check was skipped) - `uv run --no-sync pre-commit run --files docs/sdk/python.mdx` - `git diff --check` #### Where should the reviewer start? Start with `docs/sdk/python.mdx`, under **Start With One Run**. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to #103 - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. ## Summary by CodeRabbit * **Documentation** * Updated the Python SDK “Start With One Run” example to instruct exporting `NVIDIA_API_KEY` before running. * Adjusted output display in both “Start With One Run” and “Single-Invocation Runs” to print only `result.output.response` (instead of the full output). Authors: - Zhongxuan (Daniel) Wang (https://github.com/zhongxuanwang-nv) Approvers: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) URL: #111
Signed-off-by: David Gardner <dagardner@nvidia.com>
…nv/nemo-fabric into david-docs-refactor-readme-b2 Signed-off-by: David Gardner <dagardner@nvidia.com>
…refactor-readme-b2 Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
#### Overview Hardens the runnable examples after an end-to-end audit of the documentation refactor in #103. The changes remove implicit or invalid prerequisites, route the optional GitHub MCP server through maintained harnesses, make headless notebook failures visible, align Relay setup with the supported 0.6 CLI, and document concrete success criteria. There are no public API, dependency, lockfile, or breaking changes. #### Details - Convert the placeholder code-review skill into a discoverable `SKILL.md`, route the optional GitHub MCP server through each harness's native MCP support, and document adapter-specific Python selection without leaking Hermes settings into other harnesses. - Correct the Harbor calculator commands and acceptance criteria, ignore generated run/vendor output, and make the SWE-Bench bootstrap require its actual Linux/x86_64 host while pinning the supported Relay CLI version. - Make the variations notebook try every available harness, accept adapter commands resolved through `PATH`, collect both harness and Relay failures, and require successful Relay status plus nonempty, parseable ATOF output before a headless run can pass. - Clarify that Codex authentication is validated at invocation time and link Hermes commands to the setup that creates `.tmp/hermes-venv`. - Add regression coverage for all eight plan combinations, native GitHub MCP routing across all four maintained adapters, notebook prerequisite and aggregate-failure behavior, generated Harbor paths, and Relay version parity. #### Validation Repository validation: - `just build-all` - `just test-python` — 405 passed, 44 skipped - Focused review regressions — 10 passed - `uv run --no-sync pre-commit run --all-files --show-diff-on-failure` - `just docs` — completed with the expected unauthenticated Fern redirect warning only - `bash -n examples/harbor/prepare_swebench.sh` - Notebook JSON validation and compilation of every code cell - `git diff --check` Live E2E coverage: - All eight code-review planning combinations: Hermes, Codex, Claude, and Deep Agents, each plain and Relay-enabled. - Plain live runs: Hermes, Deep Agents, and Codex. - Relay live runs: Hermes, Deep Agents, and Codex; Relay 0.6 ATOF/ATIF output was produced and parsed. - Notebooks 01 and 02 executed headlessly; notebook 02 completed Hermes, Deep Agents, Codex, and Deep Agents + Relay successfully. - Harbor calculator scripted smoke, Hermes, and Hermes + Relay runs completed with one completed trial, zero errors, Fabric status `succeeded`, and reward `1.0`. Environment-bound gaps are explicit rather than reported as passes: - Claude live execution requires `ANTHROPIC_API_KEY`, which was not available. - The SWE-Bench preparation/task/capability/five-task shard requires an x86_64 Linux host; the validation host was arm64 macOS. GitHub validation for the final review-fix commit: - Pre-commit, documentation preview, DCO, and Rust tests passed. - Python 3.11–3.14 passed on Linux amd64, Linux arm64, macOS arm64, and Windows amd64. - Wheel builds passed on Linux amd64, Linux arm64, macOS arm64, and Windows amd64. #### Linked Refactor Follow-Ups The latest audited #103 head was `003f380`. These items are specific to files changed on that branch and are intentionally not folded into this non-overlapping patch: - `docs/about-nemo-fabric/overview.mdx` and notebook 01 still link to the removed `#quick-start-hermes-agent` anchor. The equivalent links in the shared example READMEs are corrected here. - The root setup creates `.venv-hermes`, while notebook 01 auto-detects `.tmp/hermes-venv`; `.venv-hermes` is not ignored. The canonical path is unclear and should be made consistent on #103. - `docs/getting-started/install.mdx` uses `just build-all no_uv=true`, which Just parses as a missing recipe. The valid override form is `just --set no_uv true build-all`. - `adapters/claude/README.md` contains a stray closing code fence after the Relay CLI paragraph. - Notebook 01 says `doctor()` proves the machine and harness are ready. The current implementation checks the resolved plan and declared preflight requirements without starting the harness, so the intended guarantee should be clarified or the prose narrowed. #### Where should the reviewer start? Start with `examples/code_review_agent/config.py` and its plan assertions in `tests/python/test_code_review_example.py`, then review the prerequisite and failure-aggregation cells in `examples/notebooks/02_variations.ipynb`. The Harbor host/version contract starts in `examples/harbor/prepare_swebench.sh`. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to #103 - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. ## Summary by CodeRabbit - **New Features** - Added a dedicated **code-review** skill with guidance for assessing correctness and missing test coverage. - **Documentation** - Updated code-review setup/run instructions, including Hermes adapter selection and **GitHub MCP** requirements. - Refreshed Harbor/SWE-bench walkthroughs and smoke-test expectations to use **Relay CLI 0.6.0**. - Simplified Quick Start commands using inline `ADAPTER_PYTHON`. - **Bug Fixes** - Improved variation notebook behavior with stricter prereq handling and Relay trace/telemetry validation. - **Tests** - Expanded integration/contract coverage, including Deep Agents, updated native planning expectations, and notebook telemetry/trace checks. Authors: - Zhongxuan (Daniel) Wang (https://github.com/zhongxuanwang-nv) Approvers: - David Gardner (https://github.com/dagardner-nv) URL: #113
…refactor-readme-b2 Signed-off-by: David Gardner <dagardner@nvidia.com>
|
/merge |
mdemoret-nv
left a comment
mdemoret-nv
left a comment
There was a problem hiding this comment.
Added comments to the README changes
| - a versioned, typed configuration contract; | ||
| - ordinary Python composition for experiment variants; | ||
| - adapter integrations for harness-specific launch and control; | ||
| - a Python SDK backed by the Rust core; |
| Capabilities vary by harness. Review the compatibility matrix and use plan() | ||
| and doctor() before relying on optional capabilities such as MCP, skills, | ||
| blocked tools, subagents, or telemetry. |
There was a problem hiding this comment.
| Capabilities vary by harness. Review the compatibility matrix and use plan() | |
| and doctor() before relying on optional capabilities such as MCP, skills, | |
| blocked tools, subagents, or telemetry. | |
| Capabilities vary by harness. Review the compatibility matrix and use `plan()` | |
| and `doctor()` before relying on optional capabilities such as MCP, skills, | |
| blocked tools, subagents, or telemetry. |
There was a problem hiding this comment.
Also link to the docs if we can for these functions
| cargo install just --locked | ||
| python -m venv .venv | ||
| source .venv/bin/activate | ||
| pip install "nemo-fabric[runtime, hermes-agent]" |
There was a problem hiding this comment.
Does this install hermes too? Are there any prerecs?
| ID. Pass harness-specific options through `HarnessConfig.settings`. | ||
|
|
||
| For a guided version of this example, refer to the | ||
| [`01_quickstart.ipynb` notebook](examples/notebooks/01_quickstart.ipynb). The |
There was a problem hiding this comment.
| [`01_quickstart.ipynb` notebook](examples/notebooks/01_quickstart.ipynb). The | |
| [`01_quickstart.ipynb`](examples/notebooks/01_quickstart.ipynb) notebook. The |
This looks weird when rendered
| [`01_quickstart.ipynb` notebook](examples/notebooks/01_quickstart.ipynb). The | ||
| [example notebooks overview](examples/notebooks/README.md) describes the other | ||
| available notebooks. |
There was a problem hiding this comment.
| [`01_quickstart.ipynb` notebook](examples/notebooks/01_quickstart.ipynb). The | |
| [example notebooks overview](examples/notebooks/README.md) describes the other | |
| available notebooks. | |
| [`01_quickstart.ipynb` notebook](examples/notebooks/01_quickstart.ipynb). | |
| Additional guided notebooks can be found in the [example notebooks overview](examples/notebooks/README.md) README. |
| [example notebooks overview](examples/notebooks/README.md) describes the other | ||
| available notebooks. | ||
|
|
||
| ## Use Separate Environments |
There was a problem hiding this comment.
This section doesnt seem appropriate for the main README. Purpose of the README is to illustrate capabilities and excite users to use the product. This seems like a nice feature. Instead add this to the feature list above with a link to the docs about environment isolation.
| models={ | ||
| "default": ModelConfig( | ||
| provider="nvidia", | ||
| model="nvidia/nemotron-3-nano-30b-a3b", | ||
| api_key_env="NVIDIA_API_KEY", | ||
| ) | ||
| }, |
There was a problem hiding this comment.
Are there other top level objects that are worth demonstrating? Skills? A lot of the value comes from more than just specifying the model name but also the harness settings and common configuration options.
| needs. Every harness supports persistent multi-turn local runtimes through the | ||
| same NeMo Fabric lifecycle and returns normalized results, artifacts, and telemetry | ||
| references. | ||
| ## Execution Flow |
There was a problem hiding this comment.
I dont think this provides much value in the readme and would be better in the docs.
| ### Consumer Integrations | ||
|
|
||
| To run the full test suite, bootstrap a virtual environment with the optional dependencies. | ||
| Consumer integrations are northbound: they connect applications, evaluation |
There was a problem hiding this comment.
Is northbound/southbound a common expression? This is foreign to me.
7 participants
Overview
Trim down the document into an end-user focused elevator pitch consisting of:
Replace absolute links with relative links that work in both generated api docs and in the repo
Add shield bar to pypi.md
Where should the reviewer start?
README.mdRelated Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Closes FABRIC-114
Closes FABRIC-127
I confirm this contribution is my own work, or I have the right to submit it under this project's license.
I searched existing issues and open pull requests, and this does not duplicate existing work.
Summary by CodeRabbit
.gitignoreto also ignoreexamples/harbor/*/runs/paths.