docs: Create separate pypi.md files for each Python package

[dagardner-nv]

Overview

• README.md files remain developer focused
• pypi.md provides brief install instructions appropriate for presentation on pypi.org
• Merge testing.md files back into the README.md files
• Update project.url settings in pyproject.toml files

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

• Closes FABRIC-119

• 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

• Documentation

  • Added/updated PyPI-facing pages for the runtime and multiple adapters (including Hermes, Codex, Claude, Deep Agents, and shared adapters utilities), with install variants and optional Relay notes.
  • Updated main PyPI content with a new hero image and revised “Supported Harnesses” information.
  • Added Testing guidance for Claude and Codex (deterministic defaults and opt-in live runs), while removing standalone adapter testing pages.

• Chores

  • Refreshed package/project metadata (PyPI README sources and repository/Homepage/Issues links) across affected packages.

[coderabbitai]

Walkthrough

The change reorganizes package-facing documentation, moves Claude and Codex testing guidance into their READMEs, adds per-package PyPI pages, updates package metadata and repository URLs, and replaces the root PyPI badges with a hero image.

Changes

Packaging documentation and metadata

Layer / File(s)	Summary
Adapter testing guidance adapters/claude/README.md, adapters/codex/README.md	Documents default, SDK, Relay, and environment-gated integration tests, including artifact and response validation expectations.
Adapter PyPI pages and metadata adapters/{claude,codex,common,deepagents,hermes}/pypi.md, adapters/*/pyproject.toml	Adds package installation pages and points package metadata to them while standardizing repository, homepage, and issue URLs.
Runtime and repository PyPI presentation python/pypi.md, python/pyproject.toml, pypi.md, pyproject.toml	Adds runtime PyPI documentation, updates runtime and root project URLs, and replaces the root badges with a hero image.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• NVIDIA/NeMo-Fabric#57: Related package readme and project URL metadata updates.
• NVIDIA/NeMo-Fabric#153: Directly overlaps the per-package PyPI documentation and adapter testing documentation changes.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title follows Conventional Commits, uses a valid type, and clearly summarizes the documentation-only change.
Description check	✅ Passed	The description includes an Overview, related issue, and required confirmations; only the reviewer-start section is missing.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[github-actions]

Fern docs preview: https://nvidia-preview-pull-request-155.docs.buildwithfern.com/nemo/fabric

[coderabbitai]

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 `@adapters/codex/README.md`:
- Around line 156-162: Update the README command examples to use quoted
angle-bracketed placeholders for both executable paths: replace the Nemo Relay
and Codex path values with placeholders such as “<path-to-nemo-relay>” and
“<path-to-codex>”, keeping them inside the existing shell assignments and code
formatting.

In `@python/pypi.md`:
- Around line 23-25: Replace the “Is equivalent to:” lead-in in the Python
package installation documentation with a complete sentence that clearly
introduces the direct runtime installation command, such as instructing the
reader to run it.
- Line 35: Update the NVIDIA NeMo Fabric repository link in the PyPI
documentation to use the canonical URL casing
`https://github.com/NVIDIA/NeMo-Fabric`, matching the package metadata and
official repository naming.

🪄 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: 2a3e99fc-a1a8-4bd3-aa07-86ce898ed162

📥 Commits

Reviewing files that changed from the base of the PR and between d438ac3 and ff16134.

📒 Files selected for processing (18)

• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/claude/pyproject.toml
• adapters/claude/testing.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• adapters/codex/pyproject.toml
• adapters/codex/testing.md
• adapters/common/pypi.md
• adapters/common/pyproject.toml
• adapters/deepagents/pypi.md
• adapters/deepagents/pyproject.toml
• adapters/hermes/pypi.md
• adapters/hermes/pyproject.toml
• pypi.md
• pyproject.toml
• python/pypi.md
• python/pyproject.toml

💤 Files with no reviewable changes (2)

• adapters/codex/testing.md
• adapters/claude/testing.md

📜 Review details

⏰ Context from checks skipped due to timeout. (18)

• GitHub Check: Preview docs
• GitHub Check: Test (Python 3.12, linux-amd64)
• GitHub Check: Test (Python 3.11, linux-amd64)
• GitHub Check: Test (Python 3.14, macos-arm64)
• GitHub Check: Test (Python 3.14, linux-amd64)
• GitHub Check: Test (Python 3.12, macos-arm64)
• GitHub Check: Test (Python 3.13, macos-arm64)
• GitHub Check: Test (Python 3.11, windows-amd64)
• GitHub Check: Test (Python 3.14, linux-arm64)
• GitHub Check: Test (Python 3.13, windows-amd64)
• GitHub Check: Test (Python 3.12, windows-amd64)
• GitHub Check: Test (Python 3.14, windows-amd64)
• GitHub Check: Test (Python 3.11, macos-arm64)
• GitHub Check: Test (Python 3.13, linux-amd64)
• GitHub Check: Test (Python 3.13, linux-arm64)
• GitHub Check: Test (Python 3.12, linux-arm64)
• GitHub Check: Test (Python 3.11, linux-arm64)
• GitHub Check: Pre-commit

🧰 Additional context used

📓 Path-based instructions (25)

**/*

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

• python/pyproject.toml
• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml
• adapters/common/pypi.md

{Cargo.toml,python/pyproject.toml,pyproject.toml}

📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)

Keep Rust workspace/package metadata and Python/maturin package metadata internally consistent, including package names, versions, import paths, and module names.

Files:

• python/pyproject.toml
• pyproject.toml

{Cargo.toml,Cargo.lock,pyproject.toml,uv.lock,python/pyproject.toml}

📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)

{Cargo.toml,Cargo.lock,pyproject.toml,uv.lock,python/pyproject.toml}: Keep workspace, Python, and lockfile dependency versions aligned where required, and review both direct and transitive dependency changes from resolved lockfiles.
Inspect resolved transitive licenses, explicitly surface UNKNOWN, non-SPDX/custom, proprietary, source-available, copyleft, or network-copyleft terms, and route unresolved licensing questions to dependency approvers with distribution and linkage context.
Document the functional need, alternatives considered, rationale for the selected dependency, and any unresolved licensing question when introducing dependencies.

Files:

• python/pyproject.toml
• pyproject.toml

{Cargo.toml,pyproject.toml,python/pyproject.toml}

📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)

Before adding a dependency, prefer the standard library, an existing dependency, or a small local implementation when appropriate; otherwise select a maintained, narrow-fit dependency with clear SPDX metadata and a permissive license where possible.

Files:

• python/pyproject.toml
• pyproject.toml

{pyproject.toml,python/pyproject.toml,Cargo.toml,docs/package.json,.github/workflows/*.yml,justfile}

📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)

Reflect public packaging changes in release-facing documentation and ensure CI references the same package names and commands used by local workflows.

Files:

• python/pyproject.toml
• pyproject.toml

**/*.{rs,toml}

📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)

For any Rust change, run just test-rust and cargo fmt --all -- --check.

For Rust core, CLI, or shared runtime semantic changes, run Rust formatting and tests, and add Python tests when behavior is exposed through the SDK.

Files:

• python/pyproject.toml
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

**/{Cargo.toml,Cargo.lock,pyproject.toml,package.json}

📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)

For new or updated dependencies, document the functional need, alternatives considered, and why the selected dependency is the narrowest fit.

Files:

• python/pyproject.toml
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

**/*.{toml,lock}

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If a manifest or lockfile changes, run the license-diff script against origin/main, review transitive license changes, and run the attributions-rust and attributions-python pre-commit hooks.

Files:

• python/pyproject.toml
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

**/*.{yml,yaml,toml,lock}

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

For CI or packaging changes, use maintain-ci or maintain-packaging, then run recipes and checks whose behavior changed.

Files:

• python/pyproject.toml
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

python/pyproject.toml

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

Keep project.dynamic = ["version"]; do not add a literal project.version, because Maturin derives the runtime version from Cargo metadata.

Files:

• python/pyproject.toml

**/*.{rs,py,toml}

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

When editing version helpers, verify every nemo-fabric-* workspace package through Cargo metadata and reject a static version in python/pyproject.toml.

Files:

• python/pyproject.toml
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

**/*.{toml,rs,py}

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

Avoid blind repository-wide replacement of version-like strings; distinguish package-version references from examples and unrelated dependency versions.

Files:

• python/pyproject.toml
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

**/*.{rs,py,html,md,mdx,toml,yml,yaml,sh,bash}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

All Rust, Python, HTML, Markdown, MDX, TOML, YAML, and shell source files must include the project SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to each file type.

Files:

• python/pyproject.toml
• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml
• adapters/common/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.

Files:

• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/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 spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
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 as here or read 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.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when 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
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/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.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in 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: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 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
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/pypi.md

**/*.{md,mdx}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on its first usage, typically in the title or H1; use NeMo Fabric thereafter.
Use fabric by itself only when referring to the CLI tool, and surround those references with backticks.
Capitalize NVIDIA correctly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such as here.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Use after instead of once when expressing temporal sequence.
Use can instead of may when the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.

For docs site changes, run just docs to regenerate Python and Rust API references and validate the Fern configuration.

Files:

• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/pypi.md

**/{README.md,*.md,*.mdx}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant documentation when changes affect public behavior, adapters, examples, or workspace structure.

Files:

• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/pypi.md

**/*.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Documentation and examples must be updated consistently with changes to public behavior and reviewed for NVIDIA technical-writing style.

Files:

• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/pypi.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 lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

• pypi.md
• adapters/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/codex/README.md
• adapters/codex/pypi.md
• python/pypi.md
• adapters/deepagents/pypi.md
• adapters/common/pypi.md

adapters/*/README.md

📄 CodeRabbit inference engine (AGENTS.md)

Update adapter README files when public behavior, examples, or supported bindings change.

Files:

• adapters/claude/README.md
• adapters/codex/README.md

**/README.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

Update relevant package, crate, adapter, and integration README files when public behavior or entry-point documentation changes.

Files:

• adapters/claude/README.md
• adapters/codex/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/claude/README.md
• adapters/claude/pypi.md
• adapters/hermes/pypi.md
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/codex/README.md
• adapters/codex/pypi.md
• adapters/deepagents/pypi.md
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml
• adapters/common/pypi.md

{Cargo.toml,Cargo.lock,pyproject.toml,uv.lock}

📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)

After updating manifests or lockfiles, run uv run --no-project python scripts/licensing/license_diff.py --base-ref origin/main and review added packages and license changes.

Files:

• pyproject.toml

{pyproject.toml,adapters/**/pyproject.toml}

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

{pyproject.toml,adapters/**/pyproject.toml}: Update the literal project.version in the root setuptools project and every adapter pyproject.toml.
Keep internal exact-version requirements aligned: root nemo-fabric-* == <version> optional dependencies and each adapter's nemo-fabric-adapters-common == <version> dependency.

Files:

• pyproject.toml
• adapters/claude/pyproject.toml
• adapters/codex/pyproject.toml
• adapters/deepagents/pyproject.toml
• adapters/common/pyproject.toml
• adapters/hermes/pyproject.toml

🔇 Additional comments (15)

adapters/hermes/pyproject.toml (1)

25-25: LGTM!

Also applies to: 45-47

python/pyproject.toml (1)

22-22: LGTM!

Also applies to: 31-33

pypi.md (1)

11-12: LGTM!

pyproject.toml (1)

32-34: LGTM!

adapters/claude/README.md (1)

249-249: 🎯 Functional Correctness

FABRIC_NEMO_RELAY_COMMAND is the right variable here The Claude relay test reads it in tests/e2e/test_claude.py and forwards it to FABRIC_TEST_NEMO_RELAY_COMMAND, so the README command does select the installed nemo-relay CLI.

			> Likely an incorrect or invalid review comment.

adapters/claude/pypi.md (1)

27-27: 📐 Maintainability & Code Quality

Remove this note. The sentence is already split correctly, and #nemo-relay-cli points to the NeMo Relay CLI section in the install guide.

			> Likely an incorrect or invalid review comment.

adapters/claude/pyproject.toml (1)

25-25: LGTM!

Also applies to: 41-43

adapters/codex/pypi.md (2)

1-17: LGTM!

---

18-29: 🗄️ Data Integrity & Integration

Verify the advertised adapter installation contracts before publishing.

The new PyPI pages document extras and Python compatibility that are not established by the supplied metadata changes. Confirm each command, extra, relay combination, and Python range against the corresponding project metadata and the root nemo-fabric extras.

• adapters/codex/pypi.md#L18-L29: verify the codex, harness, full, and relay-related commands.
• adapters/deepagents/pypi.md#L18-L33: verify the deepagents, relay, harness, and full commands and relay behavior.
• adapters/hermes/pypi.md#L18-L34: verify Python 3.11–3.13 support and all Hermes and relay installation options.

As per coding guidelines, verify documentation claims against the current repository or public API. As per path instructions, verify adapter command correctness and compatibility with public NeMo Fabric contracts.

Sources: Coding guidelines, Path instructions

adapters/codex/pyproject.toml (1)

25-25: LGTM!

Also applies to: 41-43

adapters/common/pypi.md (1)

1-28: LGTM!

adapters/common/pyproject.toml (1)

25-25: LGTM!

Also applies to: 29-31

adapters/deepagents/pypi.md (1)

1-17: LGTM!

adapters/deepagents/pyproject.toml (1)

25-25: LGTM!

Also applies to: 53-55

adapters/hermes/pypi.md (1)

1-17: LGTM!

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use explicit angle-bracketed path placeholders.

/path/to/nemo-relay and /path/to/codex should be represented as placeholders, not literal paths. Quote them so the commands remain valid shell examples.

Proposed wording

-  FABRIC_TEST_NEMO_RELAY_COMMAND=/path/to/nemo-relay \
+  FABRIC_TEST_NEMO_RELAY_COMMAND="<path-to-nemo-relay>" \
...
-Set `FABRIC_TEST_CODEX_BIN=/path/to/codex` on either opt-in command to validate
+Set `FABRIC_TEST_CODEX_BIN="<path-to-codex>"` on either opt-in command to validate

As per coding guidelines, represent path placeholders as angle-bracketed values inside monospace.

📝 Committable suggestion

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

Suggested change

	RUN_FABRIC_CODEX_RELAY_INTEGRATION=1 \
	FABRIC_TEST_NEMO_RELAY_COMMAND=/path/to/nemo-relay \
	uv run pytest tests/e2e/test_codex.py -q
	```
	Set `FABRIC_TEST_CODEX_BIN=/path/to/codex` on either opt-in command to validate
	an explicit app-server override instead of the SDK-pinned runtime.
	RUN_FABRIC_CODEX_RELAY_INTEGRATION=1 \
	FABRIC_TEST_NEMO_RELAY_COMMAND="<path-to-nemo-relay>" \
	uv run pytest tests/e2e/test_codex.py -q
	Set `FABRIC_TEST_CODEX_BIN="<path-to-codex>"` on either opt-in command to validate
	an explicit app-server override instead of the SDK-pinned runtime.

🤖 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 156 - 162, Update the README command
examples to use quoted angle-bracketed placeholders for both executable paths:
replace the Nemo Relay and Codex path values with placeholders such as
“<path-to-nemo-relay>” and “<path-to-codex>”, keeping them inside the existing
shell assignments and code formatting.

Source: Coding guidelines

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use a complete lead-in for the direct runtime install.

Is equivalent to: is a sentence fragment and does not clearly introduce the command. Rewrite it as a complete sentence, such as “To install the runtime package directly, run:”.

As per coding guidelines, introduce every code block with a complete sentence.

🤖 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 `@python/pypi.md` around lines 23 - 25, Replace the “Is equivalent to:” lead-in
in the Python package installation documentation with a complete sentence that
clearly introduces the direct runtime installation command, such as instructing
the reader to run it.

Source: Coding guidelines

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use the canonical repository URL casing.

The new page links to https://github.com/NVIDIA/nemo-fabric/, while the package metadata uses https://github.com/NVIDIA/NeMo-Fabric. Keep the PyPI documentation consistent with the official repository URL.

Proposed fix

-[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/nemo-fabric/).
+[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/NeMo-Fabric/).

As per coding guidelines, verify official capitalization and spelling for NVIDIA and third-party product names.

📝 Committable suggestion

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

Suggested change

	[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/nemo-fabric/).
	[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/NeMo-Fabric/).

🤖 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 `@python/pypi.md` at line 35, Update the NVIDIA NeMo Fabric repository link in
the PyPI documentation to use the canonical URL casing
`https://github.com/NVIDIA/NeMo-Fabric`, matching the package metadata and
official repository naming.

Source: Coding guidelines

[coderabbitai]

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)

12-12: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Pin the hero image to the published release.

The image uses the mutable main branch, so historical PyPI pages can display a changed or missing asset. Use the release tag or an immutable commit that matches the published package.

🤖 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` at line 12, Update the hero image URL in the README content near the
diagram reference to replace the mutable main branch with the immutable tag or
commit corresponding to the published package release, while preserving the
existing image path and alt text.

🤖 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`:
- Line 12: Update the hero image URL in the README content near the diagram
reference to replace the mutable main branch with the immutable tag or commit
corresponding to the published package release, while preserving the existing
image path and alt text.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: c7540fd8-cc3b-47ba-bb3f-15a1b7caa658

📥 Commits

Reviewing files that changed from the base of the PR and between ff16134 and eb43f96.

📒 Files selected for processing (1)

• pypi.md

📜 Review details

⏰ Context from checks skipped due to timeout. (18)

• GitHub Check: Preview docs
• GitHub Check: Test (Python 3.14, linux-arm64)
• GitHub Check: Test (Python 3.14, macos-arm64)
• GitHub Check: Test (Python 3.12, windows-amd64)
• GitHub Check: Test (Python 3.13, linux-amd64)
• GitHub Check: Test (Python 3.11, windows-amd64)
• GitHub Check: Test (Python 3.12, macos-arm64)
• GitHub Check: Test (Python 3.12, linux-amd64)
• GitHub Check: Test (Python 3.13, linux-arm64)
• GitHub Check: Test (Python 3.13, windows-amd64)
• GitHub Check: Test (Python 3.12, linux-arm64)
• GitHub Check: Test (Python 3.11, linux-amd64)
• GitHub Check: Test (Python 3.13, macos-arm64)
• GitHub Check: Test (Python 3.14, linux-amd64)
• GitHub Check: Test (Python 3.11, linux-arm64)
• GitHub Check: Test (Python 3.11, macos-arm64)
• GitHub Check: Test (Python 3.14, windows-amd64)
• GitHub Check: Pre-commit

🧰 Additional context used

📓 Path-based instructions (9)

**/*.{md,rst}

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

• pypi.md

**/*

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

• 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 spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
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 as here or read 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.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when 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.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in 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: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 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

**/*.{md,mdx}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on its first usage, typically in the title or H1; use NeMo Fabric thereafter.
Use fabric by itself only when referring to the CLI tool, and surround those references with backticks.
Capitalize NVIDIA correctly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such as here.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Use after instead of once when expressing temporal sequence.
Use can instead of may when the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.

For docs site changes, run just docs to regenerate Python and Rust API references and validate the Fern configuration.

Files:

• pypi.md

**/*.{rs,py,html,md,mdx,toml,yml,yaml,sh,bash}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

All Rust, Python, HTML, Markdown, MDX, TOML, YAML, and shell source files must include the project SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to each file type.

Files:

• pypi.md

**/{README.md,*.md,*.mdx}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant documentation when changes affect public behavior, adapters, examples, or workspace structure.

Files:

• pypi.md

**/*.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Documentation and examples must be updated consistently with changes to public behavior and reviewed for NVIDIA technical-writing style.

Files:

• pypi.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 lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

• pypi.md

🔇 Additional comments (1)

pypi.md (1)

39-46: 🗄️ Data Integrity & Integration

Pairing guidance is already present below. Bare adapter installs do not include the runtime, and the following note tells users to install nemo-fabric with a bare adapter only in a compatible environment.

			> Likely an incorrect or invalid review comment.

[zhongxuanwang-nv]

Thanks David!! Now the docs are also cleaner :)