Skip to content

docs: Add FAQ section for common questions about NeMo Agent Toolkit#1930

Open
meichuanyi wants to merge 1 commit into
NVIDIA:developfrom
meichuanyi:develop
Open

docs: Add FAQ section for common questions about NeMo Agent Toolkit#1930
meichuanyi wants to merge 1 commit into
NVIDIA:developfrom
meichuanyi:develop

Conversation

@meichuanyi
Copy link
Copy Markdown

@meichuanyi meichuanyi commented May 14, 2026

This PR adds a comprehensive FAQ section to the README covering:

  • What is NVIDIA NeMo Agent Toolkit and framework-agnostic approach
  • How NAT differs from LangChain/CrewAI (instrumentation vs orchestration)
  • Installation with framework-specific integrations
  • Supported LLM providers (NVIDIA NIMs, OpenAI, Anthropic, Gemini, Azure, Bedrock, local models)
  • Profiler capabilities and bottleneck identification
  • Evaluation System for workflow quality
  • Hyper-Parameter and Prompt Optimizer
  • LLM fine-tuning with Reinforcement Learning
  • Dynamo Runtime Intelligence for latency optimization
  • Agent Performance Primitives (APP) for parallel execution
  • MCP Client/Server support and FastMCP publishing
  • A2A Protocol for distributed agent teams
  • Built-in User Interface for chat and debugging
  • Observability options (LangSmith, OpenTelemetry, Phoenix)
  • Telemetry details and opt-out
  • Python version requirements
  • Examples and help resources
  • Contributing guide

The FAQ helps users quickly find answers to common questions about this enterprise-grade agent toolkit.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive FAQ section to README covering framework overview, installation, supported providers, key features, Python compatibility, and support resources.

Review Change Stack

@meichuanyi meichuanyi requested a review from a team as a code owner May 14, 2026 09:30
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 14, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Walkthrough

This PR adds a comprehensive Frequently Asked Questions section to the README, covering NAT's core purpose, feature capabilities, deployment considerations, and community resources. The FAQ is organized into foundational concepts, technical feature descriptions, and production guidance topics.

Changes

README FAQ Section

Layer / File(s) Summary
FAQ: NAT Overview and Getting Started
README.md
Introductory FAQ entries explain what NAT is, distinguish it from orchestration frameworks, list supported LLM providers, and provide installation commands with framework-specific extras.
FAQ: Feature Capabilities
README.md
Feature-focused FAQ entries document the Profiler and Evaluation System, Hyper-Parameter and Prompt Optimizer with reinforcement learning fine-tuning, Dynamo Runtime Intelligence, Agent Performance Primitives (APP), and MCP/A2A protocol support.
FAQ: Production Deployment and Community
README.md
Deployment and community FAQ entries cover the built-in UI, production observability options, telemetry collection details and disabling instructions, supported Python versions, example resources, help channels, and contribution guidelines.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: adding a FAQ section to the README for the NeMo Agent Toolkit, uses imperative mood ('Add'), and is concise at 67 characters.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 174: Replace narrative uses of the acronym "NAT" with the full name "NeMo
Agent Toolkit" (or "the toolkit" where concise) and only use the lowercase
backticked form `nat` for package names or code/CLI identifiers; update every
prose occurrence of "NAT" in the README (including the sentence currently using
"NAT" in the description of the toolkit) to follow this rule and keep
capitalization and punctuation consistent.
🪄 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: CHILL

Plan: Enterprise

Run ID: 22ba785f-849c-4597-8e6b-5f68ebe0d311

📥 Commits

Reviewing files that changed from the base of the PR and between 736eb54 and f47810e.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md

### What is NVIDIA NeMo Agent Toolkit?

NVIDIA NeMo Agent Toolkit (NAT) is an enterprise-grade toolkit that adds intelligence to AI agents across any framework—enhancing speed, accuracy, and decision-making through instrumentation, observability, and continuous learning. It works side-by-side with popular frameworks like LangChain, LlamaIndex, CrewAI, Microsoft Semantic Kernel, and Google ADK.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Replace NAT acronym usage in prose to satisfy docs lint rules.

NAT appears in narrative text in several places; this violates the Markdown vocabulary/style rules and may fail Vale. Use “NeMo Agent Toolkit” (or “the toolkit”), and reserve lowercase backticked nat only for technical identifiers/CLI references.

As per coding guidelines, “Documentation in Markdown files should not use NAT as an acronym… The exception to this rule is when referring to package names or code identifiers that contain "nat", these should always be surrounded by backticks…and be lowercase.”

Also applies to: 181-181, 257-257, 264-264, 287-287

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 174, Replace narrative uses of the acronym "NAT" with the
full name "NeMo Agent Toolkit" (or "the toolkit" where concise) and only use the
lowercase backticked form `nat` for package names or code/CLI identifiers;
update every prose occurrence of "NAT" in the README (including the sentence
currently using "NAT" in the description of the toolkit) to follow this rule and
keep capitalization and punctuation consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant