docs: Document installing the nemo-relay CLI tool#91
Conversation
Signed-off-by: David Gardner <dagardner@nvidia.com>
WalkthroughNeMo Relay documentation now covers Python-library and CLI installation paths, separates Harbor and Relay guidance, and updates adapter prerequisites. README, adapter, example, notebook, SDK, schema, skill, and contribution documentation standardizes Hermes Agent, Codex, and NeMo Fabric terminology. ChangesRelay installation and adapter guidance
Onboarding and examples
Estimated code review effort: 2 (Simple) | ~15 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-91.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: 3
🤖 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 `@docs/getting-started/install.mdx`:
- Around line 76-80: Update the Unix shell installation section around the curl
installer command to document that the binary is installed in $HOME/.local/bin
and users must add that directory to PATH manually because shell configuration
is not modified. State that macOS support is limited to Apple Silicon, and add a
post-install verification step running nemo-relay --version.
In `@pypi.md`:
- Around line 43-49: Update the Harbor integration and Relay integration
Markdown headings to title case: Harbor Integration and Relay Integration,
leaving the surrounding installation instructions unchanged.
- Around line 57-60: Update the NeMo Relay CLI installation link in the adapter
documentation to use a valid rendered Fabric installation page or NeMo Relay’s
published installation page, replacing the broken .mdx source-file URL while
preserving the existing link text and surrounding guidance.
🪄 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: 7735b71d-3186-4ff9-ad88-e1e1fe657415
📒 Files selected for processing (2)
docs/getting-started/install.mdxpypi.md
📜 Review details
⏰ Context from checks skipped due to timeout. (12)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Build wheels (x86_64)
- GitHub Check: Build wheels (arm64)
- GitHub Check: Pre-commit
🧰 Additional context used
📓 Path-based instructions (15)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
pypi.mddocs/getting-started/install.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
pypi.mddocs/getting-started/install.mdx
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: 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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
pypi.mddocs/getting-started/install.mdx
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
HTML and Markdown files must use the specified SPDX header in an HTML comment.
Files:
pypi.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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
pypi.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:
pypi.mddocs/getting-started/install.mdx
**/*.{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.md
**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
MDX files must use the specified SPDX header in a JSX comment.
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.
Files:
docs/getting-started/install.mdx
{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.mdx
{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.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.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/getting-started/install.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/getting-started/install.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/getting-started/install.mdx
{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.mdx
🔇 Additional comments (2)
docs/getting-started/install.mdx (2)
54-72: LGTM!
82-92: LGTM!
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 (1)
pypi.md (1)
45-46: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winIntroduce each install code block with a complete sentence.
Add lead-ins such as “Install the Harbor integration:” and “Install the Relay integration:” before the corresponding code blocks.
Also applies to: 51-52
🤖 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 `@pypi.md` around lines 45 - 46, Update the installation documentation around the Harbor and Relay code blocks so each block is preceded by a complete-sentence lead-in, using clear descriptions such as identifying the integration being installed.Source: Coding guidelines
🤖 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 `@pypi.md`:
- Around line 45-46: Update the installation documentation around the Harbor and
Relay code blocks so each block is preceded by a complete-sentence lead-in,
using clear descriptions such as identifying the integration being installed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 23fb2331-65e0-4e1a-81f3-2a178c3f8f31
📒 Files selected for processing (1)
pypi.md
📜 Review details
⏰ Context from checks skipped due to timeout. (12)
- GitHub Check: Preview docs
- GitHub Check: Pre-commit
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Build wheels (x86_64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Build wheels (arm64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.13, x86_64)
🧰 Additional context used
📓 Path-based instructions (7)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
pypi.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
pypi.md
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: 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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
pypi.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
HTML and Markdown files must use the specified SPDX header in an HTML comment.
Files:
pypi.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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
pypi.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:
pypi.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.md
🔇 Additional comments (2)
pypi.md (2)
43-49: Duplicate: use title case for integration headings.Rename
Harbor integrationandRelay integrationtoHarbor IntegrationandRelay Integration.Source: Coding guidelines
57-60: Duplicate: the CLI installation link is still broken.The target currently returns 404. Replace it with the published Relay installation page, which contains the CLI installation instructions. ()
Proposed fix
-[NeMo Relay CLI](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) +[NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/getting-started/installation)Source: MCP tools
…, some some developer focused docs from the codex readme Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@adapters/claude/README.md`:
- Line 54: Update the NeMo Relay CLI hyperlink in the README prerequisite text
to the current valid NeMo Relay installation guide, preserving the existing
wording and link purpose.
In `@adapters/codex/README.md`:
- Around line 107-108: Update the NeMo Relay CLI installation link in the README
to https://docs.nvidia.com/nemo/relay/getting-started/installation, keeping the
surrounding installation guidance unchanged.
🪄 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: 5f137eaf-2cb2-483b-b3be-f1f5c28a26f1
📒 Files selected for processing (2)
adapters/claude/README.mdadapters/codex/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (12)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Build wheels (arm64)
- GitHub Check: Build wheels (x86_64)
- GitHub Check: Pre-commit
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
adapters/codex/README.mdadapters/claude/README.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update an adapter or example
README.mdwhen that adapter or example surface changes.
Files:
adapters/codex/README.mdadapters/claude/README.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
adapters/codex/README.mdadapters/claude/README.md
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: 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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
adapters/codex/README.mdadapters/claude/README.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
HTML and Markdown files must use the specified SPDX header in an HTML comment.
Files:
adapters/codex/README.mdadapters/claude/README.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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
adapters/codex/README.mdadapters/claude/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:
adapters/codex/README.mdadapters/claude/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:
adapters/codex/README.mdadapters/claude/README.md
{adapters/**,examples/**}
⚙️ CodeRabbit configuration file
{adapters/**,examples/**}: Review adapter and example changes for command correctness, config/schema consistency, artifact handling, and compatibility with the public Fabric contracts.
Files:
adapters/codex/README.mdadapters/claude/README.md
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
…ooks Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pypi.md (1)
49-61: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winFix the broken CLI installation-guide link.
The target currently returns 404. Link to the published NeMo Relay installation page instead, which documents both installer and Cargo installation paths. ()
Proposed fix
- [NeMo Relay CLI](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) + [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/getting-started/installation)🤖 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 `@pypi.md` around lines 49 - 61, Update the NeMo Relay CLI link in the Relay Integration section to point to the published NeMo Relay installation page that documents both installer and Cargo installation methods. Keep the surrounding installation guidance and nemo-relay CLI reference unchanged.Source: MCP tools
🤖 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 `@examples/notebooks/README.md`:
- Around line 60-61: Insert a blank line between the “## Next Steps” heading and
its first bullet to satisfy Markdown heading spacing requirements (MD022).
- Line 62: Update the examples/notebooks README link to use
../../README.md#more-workflows so it targets the repository root, and replace
the generic link text with a descriptive label for the More Workflows section.
- Line 9: Update the examples/notebooks README text to state that Colab requires
running just build-all and that live workflows require the harness-specific
credentials; change the Google Colab badge URL to open the notebooks directly
rather than the repository root, and replace the broken
../README.md#more-workflows navigation target with a valid destination.
In `@README.md`:
- Around line 124-125: Insert a blank line immediately after the “### Next
Steps” heading and before its first bullet to satisfy Markdownlint MD022.
---
Outside diff comments:
In `@pypi.md`:
- Around line 49-61: Update the NeMo Relay CLI link in the Relay Integration
section to point to the published NeMo Relay installation page that documents
both installer and Cargo installation methods. Keep the surrounding installation
guidance and nemo-relay CLI reference unchanged.
🪄 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: 0090a3b3-5fd3-41ce-b7bf-175be15cda1c
📒 Files selected for processing (3)
README.mdexamples/notebooks/README.mdpypi.md
📜 Review details
⏰ Context from checks skipped due to timeout. (10)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Pre-commit
🧰 Additional context used
📓 Path-based instructions (14)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
pypi.mdexamples/notebooks/README.mdREADME.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
pypi.mdexamples/notebooks/README.mdREADME.md
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: 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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
pypi.mdexamples/notebooks/README.mdREADME.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
HTML and Markdown files must use the specified SPDX header in an HTML comment.
Files:
pypi.mdexamples/notebooks/README.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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
pypi.mdexamples/notebooks/README.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:
pypi.mdexamples/notebooks/README.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.mdexamples/notebooks/README.mdREADME.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update an adapter or example
README.mdwhen that adapter or example surface changes.
Files:
examples/notebooks/README.mdREADME.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:
examples/notebooks/README.mdREADME.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:
examples/notebooks/README.md
{adapters/**,examples/**}
⚙️ CodeRabbit configuration file
{adapters/**,examples/**}: Review adapter and example changes for command correctness, config/schema consistency, artifact handling, and compatibility with the public Fabric contracts.
Files:
examples/notebooks/README.md
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
The root
README.mdmust reflect the current workspace, supported adapters, and top-level documentation.Update
README.mdwhen a small Fabric bug fix changes public behavior.
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
{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
🪛 markdownlint-cli2 (0.23.0)
examples/notebooks/README.md
[warning] 60-60: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
README.md
[warning] 124-124: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (2)
README.md (1)
50-50: LGTM!Also applies to: 84-85, 125-125, 126-128, 194-194
pypi.md (1)
43-48: LGTM!
Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@docs/sdk/python.mdx`:
- Around line 511-512: Update the “Next Steps” section around the examples link:
replace the broken repository URL with the verified path, and convert the lone
bullet into a complete lead-in sentence or add another actionable next step so
the section no longer contains an unsupported single-item list.
🪄 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: faf63c77-2afe-4bb1-ab4d-c5a0b141444e
📒 Files selected for processing (1)
docs/sdk/python.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: Test (arm64)
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
docs/sdk/python.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
docs/sdk/python.mdx
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: 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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
docs/sdk/python.mdx
**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
MDX files must use the specified SPDX header in a JSX comment.
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.
Files:
docs/sdk/python.mdx
{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/sdk/python.mdx
{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/sdk/python.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/sdk/python.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/sdk/python.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/sdk/python.mdx
**/*.{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/sdk/python.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/sdk/python.mdx
{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/sdk/python.mdx
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>
…docs Signed-off-by: David Gardner <dagardner@nvidia.com>
|
Must fix: Use the product name instead of standalone “Fabric.”
|
Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
skills/nemo-fabric-integrate/references/config-mapping.md (1)
79-84: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUpdate the
doctor(...)docs to match adapter behavior.docs/sdk/python.mdxoverstates whatdoctor(...)checks: it resolves the plan and reports adapter-specific diagnostics, but it does not generically reject unknownharness.settingskeys unless the adapter itself validates them. Keep the config-mapping guidance as-is and align the SDK doc to that behavior.🤖 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 `@skills/nemo-fabric-integrate/references/config-mapping.md` around lines 79 - 84, Update the `doctor(...)` documentation in `docs/sdk/python.mdx` to state that it resolves the plan and reports adapter-specific diagnostics, without claiming generic validation or rejection of unknown `harness.settings` keys. Leave the existing config-mapping guidance unchanged.
♻️ Duplicate comments (3)
adapters/codex/README.md (1)
127-128: 🎯 Functional Correctness | 🟡 MinorFix the broken Relay CLI link.
Use the current NeMo Relay installation page instead of the obsolete Fabric URL. ()
As per path instructions, adapter installation guidance must remain current and executable.
🤖 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 `@adapters/codex/README.md` around lines 127 - 128, Update the NeMo Relay CLI hyperlink in the Relay-enabled installation guidance to the current NeMo Relay installation page, replacing the obsolete Fabric URL while preserving the surrounding instructions and link text.Sources: Path instructions, MCP tools
docs/getting-started/install.mdx (1)
76-80: 🎯 Functional Correctness | 🟠 MajorDocument Unix CLI PATH and platform constraints.
The Unix installer places the binary in
$HOME/.local/binwithout updating shell configuration, and Intel macOS is unsupported. Add the PATH guidance and anemo-relay --versionverification step. (docs.nvidia.com)🤖 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 `@docs/getting-started/install.mdx` around lines 76 - 80, Update the “Shell installation method (Linux and macOS)” section to state that Intel macOS is unsupported, explain that the installer places the binary in $HOME/.local/bin without modifying shell configuration, provide guidance for adding that directory to PATH, and add a nemo-relay --version verification step.Source: MCP tools
adapters/claude/README.md (1)
61-61: 🎯 Functional Correctness | 🟡 MinorFix the broken Relay CLI link.
Use the current NeMo Relay installation page instead of the obsolete Fabric URL. ()
As per path instructions, adapter installation guidance must remain current and executable.
🤖 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 `@adapters/claude/README.md` at line 61, Update the NeMo Relay CLI hyperlink in the Relay-enabled installation guidance to the current NeMo Relay installation page, replacing the obsolete Fabric URL while preserving the existing installation instructions and link text.Sources: Path instructions, MCP tools
🤖 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 `@examples/notebooks/02_variations.ipynb`:
- Around line 147-148: Update the provider description in the notebook’s
introductory text to state that the default configurations use different
providers, rather than implying each harness is intrinsically tied to a specific
provider. Preserve the listed default provider associations for Hermes Agent,
Deep Agents, Codex, and Claude.
In `@README.md`:
- Around line 189-193: Update the terminology in the adapter documentation
sentence so “Harness Agent-specific extensions” uses an established repository
term: use “Harness-specific” for Harness-wide extensions or “Hermes
Agent-specific” for Hermes-only extensions, matching the intended scope and
existing adapter terminology.
---
Outside diff comments:
In `@skills/nemo-fabric-integrate/references/config-mapping.md`:
- Around line 79-84: Update the `doctor(...)` documentation in
`docs/sdk/python.mdx` to state that it resolves the plan and reports
adapter-specific diagnostics, without claiming generic validation or rejection
of unknown `harness.settings` keys. Leave the existing config-mapping guidance
unchanged.
---
Duplicate comments:
In `@adapters/claude/README.md`:
- Line 61: Update the NeMo Relay CLI hyperlink in the Relay-enabled installation
guidance to the current NeMo Relay installation page, replacing the obsolete
Fabric URL while preserving the existing installation instructions and link
text.
In `@adapters/codex/README.md`:
- Around line 127-128: Update the NeMo Relay CLI hyperlink in the Relay-enabled
installation guidance to the current NeMo Relay installation page, replacing the
obsolete Fabric URL while preserving the surrounding instructions and link text.
In `@docs/getting-started/install.mdx`:
- Around line 76-80: Update the “Shell installation method (Linux and macOS)”
section to state that Intel macOS is unsupported, explain that the installer
places the binary in $HOME/.local/bin without modifying shell configuration,
provide guidance for adding that directory to PATH, and add a nemo-relay
--version verification step.
🪄 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: 469040a5-2faf-4483-bb71-f13077e9b5ca
📒 Files selected for processing (21)
CONTRIBUTING.mdREADME.mdadapters/claude/README.mdadapters/codex/README.mdadapters/hermes/README.mddocs/about-nemo-fabric/overview.mdxdocs/getting-started/install.mdxdocs/integrations/codex.mdxdocs/integrations/harbor.mdxdocs/sdk/python.mdxexamples/README.mdexamples/code_review_agent/README.mdexamples/harbor/README.mdexamples/harbor/calculator/README.mdexamples/harbor/swebench/README.mdexamples/notebooks/01_quickstart.ipynbexamples/notebooks/02_variations.ipynbexamples/notebooks/README.mdpypi.mdskills/nemo-fabric-integrate/SKILL.mdskills/nemo-fabric-integrate/references/config-mapping.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (19)
{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/integrations/harbor.mdxdocs/integrations/codex.mdxexamples/README.mddocs/about-nemo-fabric/overview.mdxexamples/harbor/README.mdexamples/code_review_agent/README.mddocs/sdk/python.mdxexamples/notebooks/README.mddocs/getting-started/install.mdxexamples/harbor/calculator/README.mdexamples/harbor/swebench/README.mdREADME.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/integrations/harbor.mdxdocs/integrations/codex.mdxexamples/README.mddocs/about-nemo-fabric/overview.mdxexamples/harbor/README.mdexamples/code_review_agent/README.mddocs/sdk/python.mdxexamples/notebooks/README.mddocs/getting-started/install.mdxexamples/harbor/calculator/README.mdexamples/harbor/swebench/README.md
**/*.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.Include the specified SPDX copyright and Apache-2.0 license header using a JSX comment in every MDX file.
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxdocs/about-nemo-fabric/overview.mdxdocs/sdk/python.mdxdocs/getting-started/install.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxdocs/about-nemo-fabric/overview.mdxdocs/sdk/python.mdxdocs/getting-started/install.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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)with the required content.
Only check contribution-confirmation boxes when they are true; if either confirmation cannot be made, stop before opening the pull request and surface...
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxskills/nemo-fabric-integrate/references/config-mapping.mdexamples/README.mdadapters/codex/README.mddocs/about-nemo-fabric/overview.mdxexamples/harbor/README.mdCONTRIBUTING.mdexamples/code_review_agent/README.mdadapters/claude/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/sdk/python.mdxexamples/notebooks/README.mdexamples/notebooks/01_quickstart.ipynbexamples/notebooks/02_variations.ipynbdocs/getting-started/install.mdxexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdpypi.mdREADME.md
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxdocs/about-nemo-fabric/overview.mdxdocs/sdk/python.mdxdocs/getting-started/install.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxdocs/about-nemo-fabric/overview.mdxdocs/sdk/python.mdxdocs/getting-started/install.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.Update relevant SDK, API reference, integration, adapter-support, and embedded-example documentation when public behavior or covered surfaces change.
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxskills/nemo-fabric-integrate/references/config-mapping.mdexamples/README.mdadapters/codex/README.mddocs/about-nemo-fabric/overview.mdxexamples/harbor/README.mdCONTRIBUTING.mdexamples/code_review_agent/README.mdadapters/claude/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/sdk/python.mdxexamples/notebooks/README.mddocs/getting-started/install.mdxexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdpypi.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/integrations/harbor.mdxdocs/integrations/codex.mdxskills/nemo-fabric-integrate/references/config-mapping.mdexamples/README.mdadapters/codex/README.mddocs/about-nemo-fabric/overview.mdxexamples/harbor/README.mdCONTRIBUTING.mdexamples/code_review_agent/README.mdadapters/claude/README.mdskills/nemo-fabric-integrate/SKILL.mddocs/sdk/python.mdxexamples/notebooks/README.mddocs/getting-started/install.mdxexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdpypi.mdREADME.md
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/integrations/harbor.mdxdocs/integrations/codex.mdxdocs/about-nemo-fabric/overview.mdxdocs/sdk/python.mdxdocs/getting-started/install.mdx
{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/integrations/harbor.mdxdocs/integrations/codex.mdxdocs/about-nemo-fabric/overview.mdxdocs/sdk/python.mdxdocs/getting-started/install.mdxREADME.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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
skills/nemo-fabric-integrate/references/config-mapping.mdexamples/README.mdadapters/codex/README.mdexamples/harbor/README.mdCONTRIBUTING.mdexamples/code_review_agent/README.mdadapters/claude/README.mdskills/nemo-fabric-integrate/SKILL.mdexamples/notebooks/README.mdexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdpypi.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:
skills/nemo-fabric-integrate/references/config-mapping.mdexamples/README.mdadapters/codex/README.mdexamples/harbor/README.mdCONTRIBUTING.mdexamples/code_review_agent/README.mdadapters/claude/README.mdskills/nemo-fabric-integrate/SKILL.mdexamples/notebooks/README.mdexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdpypi.mdREADME.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include the specified SPDX copyright and Apache-2.0 license header in every Markdown file.
Files:
skills/nemo-fabric-integrate/references/config-mapping.mdexamples/README.mdadapters/codex/README.mdexamples/harbor/README.mdCONTRIBUTING.mdexamples/code_review_agent/README.mdadapters/claude/README.mdskills/nemo-fabric-integrate/SKILL.mdexamples/notebooks/README.mdexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdpypi.mdREADME.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update the relevant adapter or example
README.mdwhen that adapter or example surface changes.
Files:
examples/README.mdadapters/codex/README.mdexamples/harbor/README.mdexamples/code_review_agent/README.mdadapters/claude/README.mdexamples/notebooks/README.mdexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.mdREADME.md
{adapters/**,examples/**}
⚙️ CodeRabbit configuration file
{adapters/**,examples/**}: Review adapter and example changes for command correctness, config/schema consistency, artifact handling, and compatibility with the public Fabric contracts.
Files:
examples/README.mdadapters/codex/README.mdexamples/harbor/README.mdexamples/code_review_agent/README.mdadapters/claude/README.mdexamples/notebooks/README.mdexamples/notebooks/01_quickstart.ipynbexamples/notebooks/02_variations.ipynbexamples/harbor/calculator/README.mdadapters/hermes/README.mdexamples/harbor/swebench/README.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/skills/small-fix/SKILL.md)
Update
README.mdwhen a small Fabric bug fix changes public behavior.Update the root
README.mdwhen workspace details, supported adapters, or top-level documentation changes.
Files:
README.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: Run tests for every language surface affected by a change; changes touching the Rust core or public schemas must run both Rust and Python suites.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: Run affected test targets through the repository `justfile`: `just test-rust`, `just test-python`, or `just test-all`; use `no_uv=true` when dependencies are already synchronized.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: Keep native Python binding declarations synchronized with their Rust implementations when public contracts change.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: For documentation-heavy changes, prefer small targeted commits separating entry-point, reference, example, and maintenance updates.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: All contributors must sign off their commits using `git commit -s`; unsigned commits will not be accepted.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: Before submitting a pull request, identify an issue, 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-21T16:30:55.055Z
Learning: Complete the pull request template with an overview, reviewer starting point, related issues, testing, and breaking changes.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: All pull requests require at least one approving review, and CI must pass before merging.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: Address review feedback with additional commits and do not force-push during review.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T16:30:55.055Z
Learning: Use commit messages formatted as `type: short description`, with one of the specified types, keep the first line under 72 characters, and use the body for additional context when needed.
🪛 LanguageTool
docs/getting-started/install.mdx
[typographical] ~19-~19: Consider adding a comma after ‘Specifically’ for more clarity.
Context: ...pters may have additional requirements. Specifically the Hermes Agent adapter doesn't suppor...
(RB_LY_COMMA)
🔇 Additional comments (32)
docs/getting-started/install.mdx (2)
18-20: LGTM!Also applies to: 22-27, 54-72, 82-92
45-51: 🎯 Functional CorrectnessNo change needed for adapter extra names. The install guide uses the canonical
adapters-*extras, andpyproject.tomlalso exposes matching short aliases likehermes,claude,codex, anddeepagents. The original inconsistency is not present.> Likely an incorrect or invalid review comment.pypi.md (1)
15-18: LGTM!Also applies to: 20-25, 43-55, 62-78
adapters/claude/README.md (1)
38-43: LGTM!Also applies to: 80-82
adapters/codex/README.md (1)
52-62: LGTM!Also applies to: 86-102, 112-119
adapters/hermes/README.md (2)
26-38: LGTM!Also applies to: 51-59
12-22: 🎯 Functional CorrectnessNo packaging mismatch here.
adapters/hermes/README.mduses theadapters-hermesextra declared inpyproject.toml, andpypi.mdalso documents the shorterhermesalias.> Likely an incorrect or invalid review comment.docs/sdk/python.mdx (1)
15-16: LGTM!Also applies to: 99-99, 152-153, 194-197, 209-209, 401-402, 437-439, 455-468
skills/nemo-fabric-integrate/references/config-mapping.md (1)
70-73: LGTM!Also applies to: 95-98
README.md (8)
109-109: Use the product name in the install lead-in.Line 109 still says “Install Fabric...”, the same unresolved issue raised previously. Use “Install NeMo Fabric, Hermes Agent, and the Hermes Agent adapter into an environment:”.
22-32: LGTM!
49-73: LGTM!
147-151: LGTM!
168-188: LGTM!
194-199: LGTM!
209-223: LGTM!
109-115: 🎯 Functional Correctness
nemo-fabric[hermes]is a valid aliaspyproject.tomldeclareshermesalongsideadapters-hermes, so the quick start command is correct.> Likely an incorrect or invalid review comment.examples/notebooks/README.md (2)
60-61: Add the required blank line after## Next Steps.This is the same unresolved heading-spacing issue from the previous review. As per coding guidelines, headings must be surrounded by blank lines.
Source: Coding guidelines
8-14: LGTM!Also applies to: 21-31, 62-63
docs/about-nemo-fabric/overview.mdx (1)
12-38: LGTM!Also applies to: 40-62, 64-122, 124-177
docs/integrations/codex.mdx (2)
2-60: LGTM!
111-114: 🎯 Functional CorrectnessNo change needed here.
docs/integrations/harbor.mdx (1)
15-16: LGTM!CONTRIBUTING.md (1)
23-30: LGTM!Also applies to: 252-254
skills/nemo-fabric-integrate/SKILL.md (1)
26-32: LGTM!Also applies to: 50-52, 109-112, 129-132, 231-245, 252-269
examples/README.md (1)
30-30: LGTM!Also applies to: 51-53
examples/code_review_agent/README.md (1)
12-12: LGTM!Also applies to: 23-25, 44-44, 61-68
examples/harbor/README.md (1)
18-23: LGTM!examples/harbor/calculator/README.md (1)
10-10: LGTM!Also applies to: 23-23, 76-79, 100-103
examples/harbor/swebench/README.md (1)
17-17: LGTM!Also applies to: 73-78, 132-146, 170-170, 228-237
examples/notebooks/01_quickstart.ipynb (1)
17-17: LGTM!Also applies to: 38-38, 64-76, 387-388, 446-446
examples/notebooks/02_variations.ipynb (1)
25-29: LGTM!Also applies to: 149-150
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 9
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
adapters/hermes/README.md (1)
12-21: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winMake the adapter install instructions work before PyPI release.
Both commands resolve
nemo-fabricfrom the default package index, butskills/nemo-fabric-integrate/SKILL.mdstates that the package is not published on PyPI yet. Document the supportedjust build-allor wheelhouse installation flow, or clearly mark these commands as post-release instructions.As per path instructions, technical documentation must remain aligned with current repository behavior.
🤖 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 `@adapters/hermes/README.md` around lines 12 - 21, Update the installation section in the Hermes adapter README to reflect the pre-PyPI release workflow described by skills/nemo-fabric-integrate/SKILL.md. Replace or qualify both direct PyPI pip commands with the supported just build-all or wheelhouse installation flow, while preserving post-release commands only if clearly labeled as such.Source: Path instructions
🤖 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 `@adapters/common/README.md`:
- Around line 8-10: Update the README description for
nemo-fabric-adapters-common to use the single phrase “shared Python helpers for
NVIDIA NeMo Fabric adapter implementations,” removing the duplicated product
name while preserving the surrounding dependency information.
In `@examples/code_review_agent/README.md`:
- Line 16: Update the first product reference in the README command instructions
from “NeMo Fabric” to “NVIDIA NeMo Fabric,” while retaining “NeMo Fabric” for
subsequent references.
In `@examples/harbor/calculator/README.md`:
- Line 9: Update the first mention in the README’s “Harbor → FabricAgent → NeMo
Fabric → verifier” path to use the full product name “NVIDIA NeMo Fabric,”
preserving the rest of the path unchanged.
In `@examples/harbor/README.md`:
- Line 6: Update the README heading to use the full first-use product name,
changing it to “Run NVIDIA NeMo Fabric Agents with Harbor.”
In `@examples/harbor/swebench/sample-artifacts/README.md`:
- Line 9: Update the first mention of NeMo Fabric in the README text to use the
full product name “NVIDIA NeMo Fabric,” while leaving subsequent references
unchanged.
In `@examples/README.md`:
- Line 8: Update the first mention in the directory description from “NeMo
Fabric examples” to “NVIDIA NeMo Fabric examples,” preserving subsequent
references and the rest of the prose.
In `@python/src/nemo_fabric/integrations/harbor/README.md`:
- Line 8: Update the first product mention in the README sentence to use “NVIDIA
NeMo Fabric adapters” instead of “NeMo Fabric adapters”; retain “NeMo Fabric”
for subsequent mentions.
In `@README.md`:
- Line 140: Revise the environment guidance in README.md so it uses separate
sentences: explicitly state that the environment must have the ADAPTER_PYTHON
adapter package installed, then separately note that adapter packages are
generally small and self-contained with minimal dependencies.
In `@tests/fixtures/hermes-shim-agent/repos/my-service/README.md`:
- Line 8: Update the first-use description in the README to spell out the full
product name as “NVIDIA NeMo Fabric,” changing the existing “NeMo Fabric”
reference without altering the rest of the sentence.
---
Outside diff comments:
In `@adapters/hermes/README.md`:
- Around line 12-21: Update the installation section in the Hermes adapter
README to reflect the pre-PyPI release workflow described by
skills/nemo-fabric-integrate/SKILL.md. Replace or qualify both direct PyPI pip
commands with the supported just build-all or wheelhouse installation flow,
while preserving post-release commands only if clearly labeled as such.
🪄 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: 5b0a0363-3536-41d2-9549-d51aa5953ac6
📒 Files selected for processing (38)
.agents/skills/README.md.agents/skills/python-tests/SKILL.md.agents/skills/small-fix/SKILL.md.agents/skills/update-project-version/SKILL.md.coderabbit.yaml.github/workflows/ci_python.ymlREADME.mdTODO.mdadapters/claude/README.mdadapters/codex/README.mdadapters/codex/pyproject.tomladapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/common/README.mdadapters/common/src/nemo_fabric_adapters/common/utils.pyadapters/deepagents/README.mdadapters/hermes/README.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdxexamples/README.mdexamples/code_review_agent/README.mdexamples/harbor/README.mdexamples/harbor/calculator/README.mdexamples/harbor/swebench/README.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/notebooks/01_quickstart.ipynbexamples/notebooks/02_variations.ipynbexamples/notebooks/README.mdpypi.mdpython/src/nemo_fabric/integrations/harbor/README.mdschemas/SCHEMA.mdscripts/generate_api_docs.shskills/README.mdskills/nemo-fabric-integrate/SKILL.mdskills/nemo-fabric-integrate/references/config-mapping.mdskills/nemo-fabric-integrate/references/results-and-errors.mdskills/nemo-fabric-integrate/references/sdk-api-inventory.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: Pre-commit
🧰 Additional context used
📓 Path-based instructions (37)
**/*.{rs,py,pyi,json,yaml,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Determine and update every affected public surface, including the CLI, PyO3 bindings, Python SDK, type stubs, schemas, and adapter contract, so they remain in parity.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/common/src/nemo_fabric_adapters/common/utils.py
**/*
📄 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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)with the required content.
Only check contribution-confirmation boxes when they are true; if either confirmation cannot be made, stop before opening the pull request and surface...
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pypython/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/codex/pyproject.tomladapters/common/README.mdadapters/common/src/nemo_fabric_adapters/common/utils.pyexamples/notebooks/README.mdTODO.mdscripts/generate_api_docs.shskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxexamples/notebooks/02_variations.ipynbpypi.mddocs/sdk/python.mdxexamples/notebooks/01_quickstart.ipynbskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.md
**/*.{py,pyi}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
When Python code or a Python-facing adapter changes, run
just test-python.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/common/src/nemo_fabric_adapters/common/utils.py
**/*.{rs,py,pyi,toml}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
When the PyO3 bridge or package metadata changes, run
just build-pythonandcargo check -p fabric-python --locked.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/codex/pyproject.tomladapters/common/src/nemo_fabric_adapters/common/utils.py
**/*.{toml,py}
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
For prerelease or build-metadata releases, use valid Cargo SemVer in Cargo metadata and equivalent PEP 440 syntax in explicit Python metadata; verify the built packages resolve to equivalent versions.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/codex/pyproject.tomladapters/common/src/nemo_fabric_adapters/common/utils.py
**/*.py
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Use type annotations for public Python APIs and keep native Python binding declarations synchronized with their Rust implementations.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/common/src/nemo_fabric_adapters/common/utils.py
**/*.{rs,py}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{rs,py}: Usesnake_casefor Rust and Python functions and variables; usePascalCasefor Rust types and Python classes.
Run tests for every affected language surface; changes touching the Rust core or public schemas must run both the Rust and Python test suites.
If a change affects public behavior, adapters, examples, or workspace structure, update the corresponding documentation in the same branch.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/common/src/nemo_fabric_adapters/common/utils.py
**/*.{rs,py,json}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
When adding functionality, include tests in the corresponding Rust crate or relevant
tests/area. Public contract changes must keep checked-in JSON Schema snapshots and native Python binding declarations synchronized.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/common/src/nemo_fabric_adapters/common/utils.py
**/*.{rs,py,html,md,mdx,toml,yaml,yml,sh,bash}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All source and repository configuration files must include the appropriate SPDX copyright and Apache-2.0 license header syntax for their file type.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pypython/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/codex/pyproject.tomladapters/common/README.mdadapters/common/src/nemo_fabric_adapters/common/utils.pyexamples/notebooks/README.mdTODO.mdscripts/generate_api_docs.shskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxpypi.mddocs/sdk/python.mdxskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.md
{adapters/**,examples/**}
⚙️ CodeRabbit configuration file
{adapters/**,examples/**}: Review adapter and example changes for command correctness, config/schema consistency, artifact handling, and compatibility with the public NeMo Fabric contracts.
Files:
adapters/codex/src/nemo_fabric_adapters/codex/__init__.pyadapters/codex/pyproject.tomladapters/common/README.mdadapters/common/src/nemo_fabric_adapters/common/utils.pyexamples/notebooks/README.mdexamples/harbor/README.mdexamples/notebooks/02_variations.ipynbexamples/notebooks/01_quickstart.ipynbexamples/code_review_agent/README.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdadapters/hermes/README.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
python/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/common/README.mdexamples/notebooks/README.mdTODO.mdskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mdpypi.mdskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.md
{Cargo.toml,pyproject.toml,python/pyproject.toml,python/src/nemo_fabric/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
{Cargo.toml,pyproject.toml,python/pyproject.toml,python/src/nemo_fabric/**}: Keep Rust package names, Python package/import paths, and native module names internally consistent across Cargo and Python packaging metadata and source paths.
Ensure generated native and Python artifacts are placed where downstream consumers expect them.
Files:
python/src/nemo_fabric/integrations/harbor/README.md
{pyproject.toml,python/pyproject.toml,Cargo.toml,python/src/nemo_fabric/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
The editable maturin build must continue to produce the
nemo_fabric._nativeextension.
Files:
python/src/nemo_fabric/integrations/harbor/README.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.Update relevant SDK, API reference, integration, adapter-support, and embedded-example documentation when public behavior or related surfaces change.
Files:
python/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/common/README.mdexamples/notebooks/README.mdTODO.mdskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxpypi.mddocs/sdk/python.mdxskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/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:
python/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/common/README.mdexamples/notebooks/README.mdTODO.mdskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxpypi.mddocs/sdk/python.mdxskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/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:
python/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/common/README.mdexamples/notebooks/README.mdTODO.mdskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mdpypi.mdskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update the relevant adapter or example README when that adapter or example surface changes.
Files:
python/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/common/README.mdexamples/notebooks/README.mdexamples/harbor/README.mdskills/README.mdexamples/code_review_agent/README.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.md
python/src/nemo_fabric/**/*
⚙️ CodeRabbit configuration file
python/src/nemo_fabric/**/*: Review Python SDK changes for typed API consistency, import-time dependency neutrality, async/session behavior, and parity with the native extension.
Stubs and runtime implementations should stay aligned.
Files:
python/src/nemo_fabric/integrations/harbor/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:
python/src/nemo_fabric/integrations/harbor/README.mdtests/fixtures/hermes-shim-agent/repos/my-service/README.mdadapters/common/README.mdexamples/notebooks/README.mdTODO.mdskills/nemo-fabric-integrate/references/sdk-api-inventory.mdexamples/harbor/README.mdskills/nemo-fabric-integrate/references/config-mapping.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxexamples/notebooks/02_variations.ipynbpypi.mddocs/sdk/python.mdxexamples/notebooks/01_quickstart.ipynbskills/README.mdexamples/code_review_agent/README.mdskills/nemo-fabric-integrate/references/results-and-errors.mdschemas/SCHEMA.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdadapters/deepagents/README.mdexamples/harbor/calculator/README.mdskills/nemo-fabric-integrate/SKILL.mdadapters/hermes/README.mdREADME.mdadapters/codex/README.mdexamples/harbor/swebench/README.mdadapters/claude/README.md
{tests/**,python/tests/**}
⚙️ CodeRabbit configuration file
{tests/**,python/tests/**}: Tests should cover the behavior promised by the changed API surface, including error paths, lifecycle cleanup, and SDK/native parity where relevant.
Files:
tests/fixtures/hermes-shim-agent/repos/my-service/README.md
**/*.{rs,toml}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
When Rust code or Rust project configuration changes, run
cargo fmt --all -- --checkandjust test-rust.Use Rust formatting and validation commands
cargo fmt --all,cargo fmt --all -- --check, andcargo check --workspace --lockedfor changes to the Rust workspace, CLI, runtime, or native extension.
Files:
adapters/codex/pyproject.toml
adapters/**/pyproject.toml
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
Update the literal
project.versionin every adapter setuptools project.
Files:
adapters/codex/pyproject.toml
{pyproject.toml,adapters/**/pyproject.toml}
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
Keep all internal
nemo-fabric-* == <version>requirements aligned with the Python release version, including each adapter'snemo-fabric-adapters-commondependency.
Files:
adapters/codex/pyproject.toml
{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:
examples/notebooks/README.mdexamples/harbor/README.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdxexamples/code_review_agent/README.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdexamples/harbor/calculator/README.mdREADME.mdexamples/harbor/swebench/README.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:
examples/notebooks/README.mdexamples/harbor/README.mddocs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdxexamples/code_review_agent/README.mdexamples/harbor/swebench/sample-artifacts/README.mdexamples/README.mdexamples/harbor/calculator/README.mdexamples/harbor/swebench/README.md
**/.github/workflows/*.{yml,yaml}
📄 CodeRabbit inference engine (.agents/skills/maintain-ci/SKILL.md)
**/.github/workflows/*.{yml,yaml}: Definepermissions:per job that needs token access, using the minimum required scopes; avoid workflow-level permissions unless centralized inheritance is intentionally documented.
Pin every third-party GitHub Action to a full commit SHA and retain a readable version comment after the SHA.
Use action-native or ecosystem-native caching instead of genericactions/cachewhen available.
Tie cache invalidation to lockfiles, dependency manifests, or explicit tool versions; avoid caching generated outputs unless deliberate repository behavior requires it.
Useastral-sh/setup-uvcache support withcache-dependency-globanchored touv.lock.
UseSwatinem/rust-cachewith explicitshared-keyandworkspacesinstead of ad hoc target-directory caching.
Keep deploy and publish permissions isolated to only the jobs that require them; restrictpages: writeandid-token: writeto Pages deployment jobs and their reusable-workflow callers.
Usecontents: readas the minimum permission for checkout-based build, test, documentation, and packaging jobs.
Grantpull-requests: readonly to jobs that perform pull-request metadata lookups.
When usingworkflow_call, inspect both caller and callee, and ensure the caller grants every permission required by the called jobs because the callee cannot elevate permissions.
Keep local workflow commands aligned with equivalentjustfilerecipes, and keep Python, Rust, and documentation jobs aligned with their lockfiles.
Preserve intended concurrency settings, branch filters, and documentation publish guards when modifying workflows.
Before editing workflows, inspect workflow relationships and settings with searches coveringuses:,permissions:,secrets:,concurrency:,cache, andjust.
Files:
.github/workflows/ci_python.yml
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
.github/workflows/ci_python.ymldocs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
.github/workflows/ci_python.ymldocs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdx
{.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile,pyproject.toml,python/pyproject.toml,Cargo.toml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
CI workflows must reference the same package names and commands used by local build and installation workflows.
Files:
.github/workflows/ci_python.yml
**/*.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.
Files:
docs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdx
{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/experimentation/cli.mdxdocs/integrations/codex.mdxdocs/sdk/python.mdxREADME.md
schemas/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
When public configuration types change, ensure schema snapshot tests pass through
just test-rustand review generated schema diffs.
Files:
schemas/SCHEMA.md
⚙️ CodeRabbit configuration file
schemas/**/*: Schemas are generated public contract snapshots. Check that schema diffs correspond to intentional Rust type changes and are covered by core tests.
Files:
schemas/SCHEMA.md
**/SKILL.md
📄 CodeRabbit inference engine (.agents/skills/README.md)
Each maintainer skill file must begin with YAML frontmatter containing at least
nameanddescription.
Files:
skills/nemo-fabric-integrate/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 (CONTRIBUTING.md)
Update the repository README when changes affect the current workspace, supported adapters, or top-level documentation.
Files:
README.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Keep maintainer skills focused on repository development, including public APIs, tests, CI, packaging, releases, documentation, and pull requests.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Keep consumer-facing integration guidance in the top-level `skills/` directory and out of the maintainer skill set.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Expose the maintainer skill set through `.agents/skills/`; `.claude/skills` should remain a symlink to the same directory.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Use descriptive, task-based names for maintainer skills, such as `contribute-api` and `validate-change`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Maintain parity across Rust, CLI, Python, schema, adapter, and documentation surfaces when adding a public API.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Keep small bug fixes reviewable and avoid widening their scope.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Update documentation and examples consistently with public behavior changes.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Use the appropriate validation matrix for each change and validate GitHub Actions workflows locally where applicable.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:43.362Z
Learning: Maintain pinned GitHub Actions, package metadata, native artifacts, lockfiles, and synchronized release versions.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:25:50.274Z
Learning: Run focused tests with `uv run pytest -k "<pattern>"` and the complete suite with `uv run pytest`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:26:12.494Z
Learning: Before submitting a pull request, identify an issue, 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-21T17:26:12.494Z
Learning: Pull requests require at least one approving review, passing CI, and completion of the PR template sections for overview, reviewer starting point, related issues, testing, and breaking changes.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:26:12.494Z
Learning: Address review feedback with additional commits and do not force-push during review.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:26:12.494Z
Learning: Use commit messages in the format `type: short description`, with an approved type and a first line under 72 characters.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T17:26:12.494Z
Learning: All contributors must sign off commits using `git commit -s`; unsigned-off commits are not accepted.
🪛 Ruff (0.15.21)
examples/notebooks/01_quickstart.ipynb
[warning] 167-167: Do not catch blind exception: Exception
(BLE001)
🔇 Additional comments (43)
skills/README.md (1)
27-30: LGTM!Also applies to: 31-36
pypi.md (3)
60-60: The Relay CLI link is still stale.This repeats the previous finding: replace the old Fabric installation URL with the current NeMo Relay installation guide.
43-53: 🎯 Functional CorrectnessReconcile these install commands with the package release state.
TODO.mdstill states thatnemo-fabricis not published on PyPI. If this page is rendered before publication, both new extras commands will fail. Confirm whether this page is release-gated or replace these instructions with the current source or wheel installation flow.
37-40: LGTM!Also applies to: 55-59, 62-64
adapters/claude/README.md (2)
61-61: The Relay CLI link is still stale.This repeats the previous finding. Point the link to the current NeMo Relay installation guide; the valid guide is already referenced immediately below.
9-9: LGTM!Also applies to: 32-51, 71-74, 87-87, 104-112, 120-138, 218-219
adapters/codex/README.md (2)
127-128: The Relay CLI link is still stale.This repeats the previous finding. Replace the old Fabric installation URL with the current NeMo Relay installation guide.
9-9: LGTM!Also applies to: 29-42, 55-75, 91-91, 100-100, 125-126
TODO.md (1)
51-51: LGTM!examples/README.md (1)
30-30: LGTM!Also applies to: 42-52
examples/code_review_agent/README.md (1)
23-25: LGTM!Also applies to: 44-44, 61-70
examples/notebooks/01_quickstart.ipynb (1)
17-24: LGTM!Also applies to: 38-38, 52-52, 64-76, 167-173, 446-446
examples/notebooks/02_variations.ipynb (1)
13-13: LGTM!Also applies to: 25-31, 45-45, 147-150, 406-406
examples/notebooks/README.md (1)
14-14: LGTM!Also applies to: 25-29, 59-63
examples/harbor/swebench/sample-artifacts/README.md (1)
18-18: LGTM!adapters/hermes/README.md (1)
26-39: LGTM!Also applies to: 42-59
adapters/codex/pyproject.toml (1)
13-13: LGTM!adapters/codex/src/nemo_fabric_adapters/codex/__init__.py (1)
4-4: LGTM!skills/nemo-fabric-integrate/SKILL.md (1)
14-19: LGTM!Also applies to: 29-33, 44-47, 110-110, 154-154, 204-204, 229-245
examples/harbor/README.md (1)
18-22: LGTM!Also applies to: 42-42, 61-69
examples/harbor/calculator/README.md (1)
19-30: LGTM!Also applies to: 76-79, 100-103, 138-138, 167-177
examples/harbor/swebench/README.md (2)
22-23: 📐 Maintainability & Code QualityVerify the first product-name occurrence in this README.
If the omitted preceding lines contain no earlier full product name, change
NeMo Fabrichere toNVIDIA NeMo Fabric. As per path instructions, user-facing Markdown must use “NVIDIA NeMo Fabric” on first use.Source: Path instructions
17-19: LGTM!Also applies to: 73-78, 130-146, 170-170, 223-237, 267-267
README.md (3)
184-193: Duplicate: Correct the adapter terminology.Line 192 still says “Harness Agent-specific extensions,” which is not established repository terminology. Use
Harness-specificorHermes Agent-specific, depending on the intended scope.Source: Coding guidelines
109-123: 🎯 Functional CorrectnessVerify the Hermes installation commands against package metadata.
Confirm that
nemo-fabric[hermes]installs both the external Hermes Agent and its adapter, and that the local-checkout alternative installs every required package from the intended wheel directory.
8-8: LGTM!Also applies to: 20-20, 33-34, 77-83, 102-107, 137-139, 142-155, 197-199, 209-222, 235-235
adapters/deepagents/README.md (2)
78-84: 🎯 Functional CorrectnessVerify the documented subagent restrictions.
Confirm that
tools.blockedgatesgeneral-purposeand local subagents, rejects remote/precompiled subagents, and that only JSON-shaped subagent fields cross the SDK boundary. These are user-visible behavioral guarantees.
9-9: LGTM!Also applies to: 26-26, 46-46, 68-68, 98-108, 157-157
adapters/common/src/nemo_fabric_adapters/common/utils.py (1)
88-88: LGTM!Also applies to: 97-97
skills/nemo-fabric-integrate/references/config-mapping.md (1)
10-10: LGTM!Also applies to: 80-85
skills/nemo-fabric-integrate/references/results-and-errors.md (1)
38-45: LGTM!Also applies to: 64-66
.agents/skills/README.md (1)
36-36: LGTM!.agents/skills/python-tests/SKILL.md (1)
3-3: LGTM!.agents/skills/small-fix/SKILL.md (1)
3-3: LGTM!skills/nemo-fabric-integrate/references/sdk-api-inventory.md (1)
17-17: LGTM!Also applies to: 55-55, 70-70
docs/integrations/codex.mdx (1)
3-3: LGTM!Also applies to: 52-52
docs/sdk/python.mdx (1)
191-191: LGTM!Also applies to: 401-401, 455-455, 502-504
docs/experimentation/cli.mdx (1)
76-80: LGTM!Also applies to: 95-95, 226-228
scripts/generate_api_docs.sh (1)
70-70: LGTM!Also applies to: 80-80
schemas/SCHEMA.md (1)
6-8: LGTM!Also applies to: 23-24, 48-54
.coderabbit.yaml (1)
73-79: LGTM!.github/workflows/ci_python.yml (1)
83-83: LGTM!.agents/skills/update-project-version/SKILL.md (1)
3-3: LGTM!
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@README.md`:
- Line 140: Update the environment guidance in README.md by changing
“designedto” to “designed to” and replacing “The adapters Python packages” with
“Adapter packages,” leaving the rest of the guidance unchanged.
🪄 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: 683b1e34-dab9-42e6-ad87-d29f1152ad9b
📒 Files selected for processing (4)
README.mdadapters/common/README.mdexamples/README.mdexamples/harbor/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Pre-commit
🧰 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.
Verify README and documentation entry points, package names, paths, examples, and public commands remain current after changes.
Files:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.mdREADME.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.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)with the required content.
Only check contribution-confirmation boxes when they are true; if either confirmation cannot be made, stop before opening the pull request and surface...
Files:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.mdREADME.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.Update documentation when changes affect public behavior, adapters, examples, or workspace structure; update relevant SDK, API, adapter, and example documentation.
Files:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.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:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.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:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.mdREADME.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include the specified SPDX copyright and Apache-2.0 license header using an HTML comment.
Files:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.mdREADME.md
{adapters/**,examples/**}
⚙️ CodeRabbit configuration file
{adapters/**,examples/**}: Review adapter and example changes for command correctness, config/schema consistency, artifact handling, and compatibility with the public NeMo Fabric contracts.
Files:
adapters/common/README.mdexamples/harbor/README.mdexamples/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:
adapters/common/README.mdexamples/harbor/README.mdexamples/README.mdREADME.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:
examples/harbor/README.mdexamples/README.mdREADME.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:
examples/harbor/README.mdexamples/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
{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
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:05.930Z
Learning: When changing public behavior or API surfaces, maintain parity across the relevant Rust, CLI, Python, schema, adapter, documentation, and example layers.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:13.571Z
Learning: Make the scope of the fix explicit, understand the affected language surfaces, and ensure a regression test or focused validation path exists.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:13.571Z
Learning: Ensure PR notes explain what failed before the fix and why the change is safe.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:21.931Z
Learning: Use `Cargo.toml` `[workspace.package].version` as the source of truth for the Rust workspace and Python build versioning, and keep workspace self-references aligned.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:21.931Z
Learning: Use targeted searches to audit old-version references and distinguish package-version surfaces from examples and unrelated dependency versions; avoid blind repository-wide replacement.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:21.931Z
Learning: Validate version changes with Cargo workspace checks, Python build and packaging checks as applicable, focused Python tests for material packaging changes, wheel builds for release validation, and `git diff --check`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:31.783Z
Learning: Run tests for every language surface affected by a change; changes touching the Rust core or public schemas must run both Rust and Python test suites.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:31.783Z
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-21T20:05:31.783Z
Learning: All contributors must sign off every commit using `git commit -s`; unsigned commits are not accepted.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:31.783Z
Learning: Before submitting a pull request, run relevant tests, verify affected packages compile, update documentation, and rebase onto the latest `main`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:31.783Z
Learning: All pull requests require at least one approving review, and CI must pass before merging.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:31.783Z
Learning: Address review feedback by pushing additional commits; do not force-push during review.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric
Timestamp: 2026-07-21T20:05:31.783Z
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.
🪛 LanguageTool
README.md
[grammar] ~140-~140: Ensure spelling is correct
Context: ...alled. The adapters Python packages are designedto be small with minimal dependencies. Th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (5)
adapters/common/README.md (1)
8-9: Remove the duplicated product name.This still renders as “shared Python helpers for NeMo NeMo Fabric adapter implementations.” Use “shared Python helpers for NVIDIA NeMo Fabric adapter implementations.”
README.md (2)
189-193: Use established adapter terminology.
Harness Agent-specificremains inconsistent with the repository’s established terminology. UseHarness-specificorHermes Agent-specific, depending on the intended scope.
8-8: LGTM!Also applies to: 20-20, 33-34, 77-83, 102-138, 147-151, 153-155, 184-187, 194-197, 209-223, 235-235
examples/harbor/README.md (1)
6-6: LGTM!Also applies to: 18-22, 42-42, 61-69
examples/README.md (1)
6-10: LGTM!Also applies to: 30-30, 42-52
#### Overview * Guide the user from `README.md` --> Notebooks --> Python SDK Guide --> Examples * Document installing the nemo-relay CLI tool * Remove YAML specific documentetion from "Core Concepts" section of `README.md` * Always refer to Hermes Agent as "Hermes Agent" not "Hermes" * Remove "SDK" from the name of the Codex adapter * Remove developer specific information from `adapters/codex/README.md` Replaces PR #91 #### Where should the reviewer start? * `README.md` * `docs/getting-started/install.mdx` #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Closes FABRIC-99 FABRIC-83 - [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. Authors: - David Gardner (https://github.com/dagardner-nv) Approvers: - Lawrence Lane (https://github.com/lbliii) - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) URL: #97
3 participants
Overview
README.md--> Notebooks --> Python SDK Guide --> ExamplesREADME.mdadapters/codex/README.mdWhere should the reviewer start?
README.mddocs/getting-started/install.mdxRelated Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Closes FABRIC-99 FABRIC-83
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
Summary
nemo-relayCLI guidance.