docs: Create separate pypi.md files for each Python package - #158
Conversation
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThe pull request adds per-package PyPI documentation, updates package metadata and repository links, revises the root PyPI page, and consolidates Claude and Codex testing instructions into their README files. ChangesDocumentation and packaging updates
Estimated code review effort: 2 (Simple) | ~10 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-158.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 `@adapters/claude/pypi.md`:
- Around line 26-27: Split the Relay guidance into two sentences in
adapters/claude/pypi.md lines 26-27 and adapters/codex/pypi.md lines 26-27: end
the CLI requirement after “tool,” and begin the installation-guide reference
with “Refer to” as a new sentence.
In `@adapters/claude/README.md`:
- Line 249: Update the documented real_relay_gateway command to set
FABRIC_TEST_NEMO_RELAY_COMMAND, matching the environment variable consumed by
the E2E test harness and ensuring the user-provided Relay executable is
selected.
In `@python/pypi.md`:
- Around line 23-27: Rewrite the “Is equivalent to:” introduction in
python/pypi.md as a complete sentence ending with appropriate punctuation, while
preserving the existing pip install command and its meaning.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 67ccc26a-1f89-4d81-a16f-df46b6718f79
📒 Files selected for processing (18)
adapters/claude/README.mdadapters/claude/pypi.mdadapters/claude/pyproject.tomladapters/claude/testing.mdadapters/codex/README.mdadapters/codex/pypi.mdadapters/codex/pyproject.tomladapters/codex/testing.mdadapters/common/pypi.mdadapters/common/pyproject.tomladapters/deepagents/pypi.mdadapters/deepagents/pyproject.tomladapters/hermes/pypi.mdadapters/hermes/pyproject.tomlpypi.mdpyproject.tomlpython/pypi.mdpython/pyproject.toml
💤 Files with no reviewable changes (2)
- adapters/claude/testing.md
- adapters/codex/testing.md
📜 Review details
⏰ Context from checks skipped due to timeout. (18)
- GitHub Check: Preview docs
- GitHub Check: Test (Python 3.11, windows-amd64)
- GitHub Check: Test (Python 3.13, macos-arm64)
- GitHub Check: Test (Python 3.13, linux-amd64)
- GitHub Check: Test (Python 3.11, macos-arm64)
- GitHub Check: Test (Python 3.14, linux-amd64)
- GitHub Check: Test (Python 3.12, macos-arm64)
- GitHub Check: Test (Python 3.12, linux-arm64)
- GitHub Check: Test (Python 3.12, windows-amd64)
- GitHub Check: Test (Python 3.14, windows-amd64)
- GitHub Check: Test (Python 3.13, windows-amd64)
- GitHub Check: Test (Python 3.11, linux-amd64)
- GitHub Check: Test (Python 3.14, macos-arm64)
- GitHub Check: Test (Python 3.14, linux-arm64)
- GitHub Check: Test (Python 3.12, linux-amd64)
- GitHub Check: Test (Python 3.11, linux-arm64)
- GitHub Check: Test (Python 3.13, 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 spellNVIDIAin all caps; do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names withNVIDIAon first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomladapters/common/pypi.mdpython/pyproject.tomladapters/claude/README.mdadapters/common/pyproject.tomladapters/claude/pyproject.tomlpypi.mdadapters/codex/README.md
**/*.{rs,toml}
📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)
For any Rust change, run
just test-rustandcargo 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:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomlpython/pyproject.tomladapters/common/pyproject.tomladapters/claude/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:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomlpython/pyproject.tomladapters/common/pyproject.tomladapters/claude/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 theattributions-rustandattributions-pythonpre-commit hooks.
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomlpython/pyproject.tomladapters/common/pyproject.tomladapters/claude/pyproject.toml
**/*.{yml,yaml,toml,lock}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For CI or packaging changes, use
maintain-ciormaintain-packaging, then run recipes and checks whose behavior changed.
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomlpython/pyproject.tomladapters/common/pyproject.tomladapters/claude/pyproject.toml
{pyproject.toml,adapters/**/pyproject.toml}
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
{pyproject.toml,adapters/**/pyproject.toml}: Update the literalproject.versionin the root setuptools project and every adapterpyproject.toml.
Keep internal exact-version requirements aligned: rootnemo-fabric-* == <version>optional dependencies and each adapter'snemo-fabric-adapters-common == <version>dependency.
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomladapters/common/pyproject.tomladapters/claude/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 inpython/pyproject.toml.
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomlpython/pyproject.tomladapters/common/pyproject.tomladapters/claude/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:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomlpython/pyproject.tomladapters/common/pyproject.tomladapters/claude/pyproject.toml
**/*.{rs,py,html,md,mdx,toml,yaml,yml,sh,bash}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All source files must include the specified SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to the file type.
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomladapters/common/pypi.mdpython/pyproject.tomladapters/claude/README.mdadapters/common/pyproject.tomladapters/claude/pyproject.tomlpypi.mdadapters/codex/README.md
adapters/*/{README.md,LICENSE,fabric-adapter.json,pyproject.toml,uv.lock,package.json,package-lock.json,src/**,tests/**}
📄 CodeRabbit inference engine (.agents/skills/contribute-adapter/SKILL.md)
Place each adapter under
adapters/<name>withLICENSE -> ../../LICENSE,README.md,fabric-adapter.json, language-native package and lock files, a source entry point, and focused tests; Python adapters use the specifiedpyproject.toml,uv.lock, source path, and test naming convention.
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomladapters/codex/pyproject.tomladapters/claude/README.mdadapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/codex/README.md
adapters/*/pyproject.toml
📄 CodeRabbit inference engine (.agents/skills/contribute-adapter/SKILL.md)
Keep published Python runtime dependencies razor-thin and adapter-owned; directly imported SDK/client libraries must be declared, while external-process harness dependencies must not be installed or upgraded and test-only dependencies belong in
[dependency-groups].
Files:
adapters/deepagents/pyproject.tomladapters/hermes/pyproject.tomladapters/codex/pyproject.tomladapters/common/pyproject.tomladapters/claude/pyproject.toml
{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/deepagents/pyproject.tomladapters/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdadapters/claude/pypi.mdadapters/hermes/pyproject.tomladapters/codex/pyproject.tomladapters/common/pypi.mdadapters/claude/README.mdadapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/codex/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.
Files:
adapters/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/pypi.mdadapters/claude/README.mdpypi.mdadapters/codex/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/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/pypi.mdadapters/claude/README.mdpypi.mdadapters/codex/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/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/pypi.mdadapters/claude/README.mdpypi.mdadapters/codex/README.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
When public behavior, adapters, examples, or workspace structure changes, update the corresponding documentation, including relevant README files and SDK or API references.
**/*.{md,mdx}: Use the full product nameNVIDIA NeMo Fabricon first use, typically in the title and H1; useNeMo Fabricthereafter. Usefabricalone only for the CLI tool and surround it with backticks.
Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.
CapitalizeNVIDIAcorrectly and format code, commands, paths, and filenames as inline code where needed.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences; ensure examples match current APIs and build commands.
Use descriptive anchor text, avoid raw URLs and generic labels such ashere, and use repository-relative.mdxpaths for links withindocs/.
Prefer active voice, present tense, short sentences, plain English, consistent terminology, and imperative, parallel, scannable procedures.
Useafterinstead ofoncewhen expressing temporal sequence, and usecanrather thanmaywhen describing 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.
When reporting documentation-review findings, lead withMust fix,Should fix, andNice to havecategories; include file path, line reference, current problem, rationale, and a concrete rewrite or direction.
Files:
adapters/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/pypi.mdadapters/claude/README.mdpypi.mdadapters/codex/README.md
**/*.{md,mdx,yml,py,rs,sh}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Keep documentation aligned with current NeMo Fabric behavior, repository layout, entry points, commands, package names, APIs, bindings, and support claims.
Files:
adapters/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/pypi.mdadapters/claude/README.mdpypi.mdadapters/codex/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/hermes/pypi.mdadapters/deepagents/pypi.mdadapters/codex/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/pypi.mdadapters/claude/README.mdpypi.mdadapters/codex/README.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:
pyproject.tomlpython/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:
pyproject.tomlpython/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:
pyproject.tomlpython/pyproject.toml
{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/mainand review added packages and license changes.
Files:
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:
pyproject.tomlpython/pyproject.toml
python/pyproject.toml
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
Keep
project.dynamic = ["version"]; do not add a literalproject.version, because Maturin derives the runtime version from Cargo metadata.
Files:
python/pyproject.toml
adapters/*/README.md
📄 CodeRabbit inference engine (AGENTS.md)
Update adapter integration READMEs when public behavior, examples, or supported bindings change.
Document installation, supported configuration, harness-only settings, credentials, lifecycle, telemetry, artifacts, limitations, focused test commands, and canonical typed SDK or harness-native YAML examples where applicable.
Files:
adapters/claude/README.mdadapters/codex/README.md
🔇 Additional comments (15)
adapters/codex/README.md (1)
149-171: LGTM!adapters/claude/pypi.md (1)
1-25: LGTM!Also applies to: 28-30
adapters/claude/pyproject.toml (1)
25-25: LGTM!Also applies to: 41-43
adapters/codex/pypi.md (1)
1-25: LGTM!Also applies to: 28-30
adapters/codex/pyproject.toml (1)
25-25: LGTM!Also applies to: 41-43
python/pyproject.toml (1)
22-22: LGTM!Also applies to: 31-33
pypi.md (2)
11-12: LGTM!Also applies to: 88-89, 115-116
39-46: 🗄️ Data Integrity & IntegrationNo issue in the installation matrix.
> Likely an incorrect or invalid review comment.pyproject.toml (1)
32-34: LGTM!adapters/deepagents/pypi.md (1)
1-34: LGTM!adapters/deepagents/pyproject.toml (1)
25-25: LGTM!Also applies to: 53-55
adapters/hermes/pypi.md (1)
1-34: LGTM!adapters/hermes/pyproject.toml (1)
25-25: LGTM!Also applies to: 45-47
adapters/common/pypi.md (1)
1-28: LGTM!adapters/common/pyproject.toml (1)
25-31: LGTM!
AjayThorve
left a comment
AjayThorve
left a comment
There was a problem hiding this comment.
Approved w/ a minor comment, feel free to discard
lbliii
left a comment
lbliii
left a comment
There was a problem hiding this comment.
Style guide review (NVIDIA technical writing style)
Nice cleanup — splitting developer-facing README.md from install-scoped pypi.md is the right call, and merging the orphaned testing.md files back into the READMEs removes a real discoverability problem. The prose is solid; almost everything below is mechanical.
Please look at these first
- One blocking content regression.
pypi.mddrops the Python version support statement entirely (inline comment on lines 31-33). That is a real loss, not the duplication the rest of the PR is removing. - One CodeRabbit finding is wrong. Its Major on
adapters/claude/README.md:249would silently disable the test. Details inline — please do not apply it. The other two CodeRabbit comments (thepython/pypi.mdfragment and the Relay comma splice) are correct and I have echoed them with suggestions.
Verified good
- Both docs anchors resolve against
docs/getting-started/install.mdx(#install-nemo-relay→### Install NeMo Relay,#nemo-relay-cli→#### NeMo Relay CLI). assets/fabric-hero-option2.pngexists onmain, so theraw.githubusercontent.comreferences resolve.- Alt text is present and descriptive on all seven images.
- Every extras table matches the actual
[project.optional-dependencies]in the correspondingpyproject.toml, including theharness/fullequivalence on Claude and Codex and the separaterelayextras on Hermes and Deep Agents.
Remaining nits not worth inline comments
- Double blank lines:
pypi.md:47-48and88-89,adapters/claude/README.md:240-241,adapters/codex/README.md:147-148. pypi.md:120has the same lowercaseNVIDIA/nemo-fabricURL casing flagged onpython/pypi.md:35.adapters/deepagents/pypi.mdmarks both[full]and[relay]as providing the NeMo Relay Python package. True, butfullpullsnemo-relay[deepagents]whilerelaypulls plainnemo-relay. Probably fine to gloss at this altitude — flagging in case the distinction matters to someone debugging.
On removing Core Concepts (re: @AjayThorve's question)
Agreed with the removal, and I would go further: Core Concepts should get its own docs-site section rather than living on a PyPI install page or in README.md. There is currently no concepts section on the site — docs/about-nemo-fabric/overview.mdx is doing four jobs at once (positioning, concepts, quickstart, navigation), which is how this content ended up on a packaging page.
Suggested follow-up, not this PR: an About NeMo Fabric > Core Concepts section built from the conceptual/overview template, with child pages for configuration, adapters, run plans, artifacts, observability, and packaging.
That last one would pay for itself here. The reason each pypi.md needs its own four-column Runtime/Adapter/Harness/Relay table is that the packaging model has no canonical explanation anywhere — write it once and all seven pages link to it instead of restating it, which is the same duplication problem that motivated this removal in the first place.
Two things worth keeping in pypi.md regardless: the Python version statement (above), and the sentence noting the experimental nemo-fabric CLI ships separately from the Python package — that is a packaging caveat a PyPI reader needs at install time.
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.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)
12-12: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winPin the PyPI hero asset to an immutable revision.
refs/heads/mainmakes published PyPI pages depend on mutable branch content, so older releases can silently change or break if the asset moves. Use a release tag, commit SHA, or package-local asset instead.🤖 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 pypi.md to reference an immutable release tag or commit SHA instead of refs/heads/main, preserving the existing asset path and display 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 pypi.md to reference an immutable
release tag or commit SHA instead of refs/heads/main, preserving the existing
asset path and display text.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: c13b3190-2737-4e32-be05-8f8375d4deb8
📒 Files selected for processing (1)
pypi.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{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 spellNVIDIAin all caps; do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names withNVIDIAon first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...
Files:
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
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
When public behavior, adapters, examples, or workspace structure changes, update the corresponding documentation, including relevant README files and SDK or API references.
**/*.{md,mdx}: Use the full product nameNVIDIA NeMo Fabricon first use, typically in the title and H1; useNeMo Fabricthereafter. Usefabricalone only for the CLI tool and surround it with backticks.
Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.
CapitalizeNVIDIAcorrectly and format code, commands, paths, and filenames as inline code where needed.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences; ensure examples match current APIs and build commands.
Use descriptive anchor text, avoid raw URLs and generic labels such ashere, and use repository-relative.mdxpaths for links withindocs/.
Prefer active voice, present tense, short sentences, plain English, consistent terminology, and imperative, parallel, scannable procedures.
Useafterinstead ofoncewhen expressing temporal sequence, and usecanrather thanmaywhen describing 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.
When reporting documentation-review findings, lead withMust fix,Should fix, andNice to havecategories; include file path, line reference, current problem, rationale, and a concrete rewrite or direction.
Files:
pypi.md
**/*.{rs,py,html,md,mdx,toml,yaml,yml,sh,bash}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All source files must include the specified SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to the file type.
Files:
pypi.md
**/*.{md,mdx,yml,py,rs,sh}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Keep documentation aligned with current NeMo Fabric behavior, repository layout, entry points, commands, package names, APIs, bindings, and support claims.
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 lowercasefabricCLI 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)
41-42: LGTM!Also applies to: 90-91, 115-117
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Co-authored-by: Lawrence Lane <25370251+lbliii@users.noreply.github.com> Signed-off-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
…Relay Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
/merge |
|
Failed to merge PR using squash strategy. |
|
/merge |
|
Failed to merge PR using squash strategy. |
…d-pypi-119-b3 Signed-off-by: David Gardner <dagardner@nvidia.com>
5 participants
Overview
README.mdfiles remain developer focusedpypi.mdprovides brief install instructions appropriate for presentation on pypi.orgtesting.mdfiles back into theREADME.mdfilesproject.urlsettings inpyproject.tomlfilesWhere should the reviewer start?
pypi.mdRelated 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
Chores
readmeto the new PyPI docs and standardized repository/homepage/issues links across packages.