docs: dynamo readme simplification and hardware requirements cleanup#1509
Conversation
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
bbednarski9
added
doc
WalkthroughDocumentation and configuration updates: Hello World LLM model replaced with Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
external/dynamo/README.md (2)
1-15: Add the standard SPDX header block.
This file is missing the SPDX-FileCopyrightText and SPDX-License-Identifier lines required at the top of documentation files.🛠️ Suggested header alignment
<!-- +SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. +SPDX-License-Identifier: Apache-2.0 + Copyright (c) 2025-2026 NVIDIA Corporation Licensed under the Apache License, Version 2.0 (the "License");As per coding guidelines, every file must start with the standard SPDX Apache-2.0 header and copyright years must be up to date.
520-536: Avoid the “NAT” acronym in docs output.
Replace “NAT” with “NeMo Agent toolkit” or reference the CLI asnatin backticks.✏️ Suggested update
-0. Checking if NAT environment is active... -✓ NAT command found +0. Checking if NeMo Agent toolkit environment is active... +✓ `nat` command foundAs per coding guidelines, documentation must not use the “NAT” acronym; use “NeMo Agent toolkit” or backticked code identifiers instead.
examples/dynamo_integration/react_benchmark_agent/README.md (2)
1-15: Add the standard SPDX header block.
This file is missing the SPDX-FileCopyrightText and SPDX-License-Identifier lines required at the top of documentation files.🛠️ Suggested header alignment
<!-- +SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. +SPDX-License-Identifier: Apache-2.0 + Copyright (c) 2025-2026, NVIDIA CORPORATIONAs per coding guidelines, every file must start with the standard SPDX Apache-2.0 header and copyright years must be up to date.
18-20: Use the full name on first mention.
The first mention should be “NVIDIA NeMo Agent toolkit” (lowercase “toolkit” in body text).✏️ Suggested wording
-> ⚠️ **EXPERIMENTAL**: This integration between NeMo Agent toolkit and Dynamo is experimental and under active development. +> ⚠️ **EXPERIMENTAL**: This integration between NVIDIA NeMo Agent toolkit and Dynamo is experimental and under active development.As per coding guidelines, use “NVIDIA NeMo Agent toolkit” for the first mention and lowercase “toolkit” in body text.
examples/dynamo_integration/README.md (1)
1-15: Add the standard SPDX header block.
This file is missing the SPDX-FileCopyrightText and SPDX-License-Identifier lines required at the top of documentation files.🛠️ Suggested header alignment
<!-- +SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. +SPDX-License-Identifier: Apache-2.0 + Copyright (c) 2025-2026, NVIDIA CORPORATIONAs per coding guidelines, every file must start with the standard SPDX Apache-2.0 header and copyright years must be up to date.
examples/dynamo_integration/react_benchmark_agent/src/react_benchmark_agent/DEVELOPER_NOTES.md (1)
1-15: Add the standard SPDX header block.
This file is missing the SPDX-FileCopyrightText and SPDX-License-Identifier lines required at the top of documentation files.🛠️ Suggested header alignment
<!-- +SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. +SPDX-License-Identifier: Apache-2.0 + Copyright (c) 2025-2026, NVIDIA CORPORATIONAs per coding guidelines, every file must start with the standard SPDX Apache-2.0 header and copyright years must be up to date.
🤖 Fix all issues with AI agents
In `@examples/dynamo_integration/README.md`:
- Around line 80-84: The markdown table rows (e.g., the header row "| Component
| Minimum | Recommended |" and the following rows with GPU specs) need standard
spacing around the pipe characters to satisfy MD060; update each table line so
there is exactly one space after and before each '|' delimiter (e.g., "| Column
| Value |"), keeping the same content and alignment across the header and all
data rows for consistency.
- Around line 40-45: The first in-body mention of the project should use the
full product name; update the README paragraph so the first occurrence of the
phrase reads "NVIDIA NeMo Agent toolkit" (capitalizing NVIDIA NeMo and using
lowercase "toolkit"), then ensure subsequent body uses lowercase "toolkit" where
appropriate; modify the sentence starting "**This set of example agents and
evaluations demonstrate...**" to replace its initial project mention accordingly
and keep later mentions consistent.
In `@external/dynamo/README.md`:
- Around line 20-28: Update the first occurrence of the product name in the
README so the initial full-name mention reads "NVIDIA NeMo Agent toolkit" (keep
subsequent uses as "NeMo Agent toolkit" or lowercase "toolkit" per style);
locate and replace the first instance inside the introductory paragraph/note
block (the text that currently begins "This document guides you through...") to
ensure the very first mention uses the full name.
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
Signed-off-by: Bryan Bednarski <bbednarski@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)
examples/dynamo_integration/react_benchmark_agent/README.md (1)
18-20: Use the full product name on first mention.Update the first mention to “NVIDIA NeMo Agent toolkit.”
As per coding guidelines, use 'NVIDIA NeMo Agent toolkit' for the first use and 'NeMo Agent toolkit' thereafter.
🤖 Fix all issues with AI agents
In `@examples/dynamo_integration/README.md`:
- Line 56: Replace the phrase "NeMo Agent toolkit Framework" in the README body
text with "NeMo Agent toolkit framework" so that "Toolkit" remains capitalized
in headings but "toolkit" is lowercase in body text; locate the exact sentence
containing "NeMo Agent toolkit Framework" in
examples/dynamo_integration/README.md and update it to the requested casing.
In `@external/dynamo/README.md`:
- Line 26: The sentence uses the incorrect article "a NVIDIA" — update the
phrase "a NVIDIA NeMo Agent toolkit-compatible Dynamo inference server" to "an
NVIDIA NeMo Agent toolkit-compatible Dynamo inference server" so the article
matches the vowel sound of "NVIDIA" (locate and edit the exact sentence
containing "a NVIDIA NeMo Agent toolkit-compatible Dynamo inference server" in
README.md).
🧹 Nitpick comments (1)
examples/dynamo_integration/README.md (1)
45-45: Tighten wording: “with respect to.”Consider replacing with “about” or “regarding” for brevity.
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
examples/dynamo_integration/README.md (1)
1-15: Add the standard SPDX header at the top.The file starts with the full Apache 2.0 license block, but the guidelines require the SPDX Apache-2.0 header template at the top of each file. Please replace the block with the SPDX header format.
As per coding guidelines, “Every file must start with the standard SPDX Apache-2.0 header … Confirm that copyright years are up-to-date whenever a file is changed.”📄 Suggested SPDX header
-<!-- -Copyright (c) 2025-2026, NVIDIA CORPORATION - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> +<!-- +SPDX-FileCopyrightText: 2025-2026 NVIDIA CORPORATION +SPDX-License-Identifier: Apache-2.0 +-->
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
|
/merge |
2 participants
Description
Addressing comments about the complexity of dynamo documentation. The biggest change here are as follows:
Closes
By Submitting this PR I confirm:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.