Install NVIDIA NeMo Agent Toolkit#
This guide will help you set up your NVIDIA NeMo Agent toolkit development environment.
Supported LLM APIs#
The following LLM API providers are supported:
NIM (such as Llama-3.1-70b-instruct and Llama-3.3-70b-instruct)
OpenAI
AWS Bedrock
Azure OpenAI
Framework Integrations#
To keep the library lightweight, many of the first-party plugins supported by NeMo Agent toolkit are located in separate distribution packages. For example, the nvidia-nat-langchain distribution contains all the LangChain-specific and LangGraph-specific plugins, and the nvidia-nat-mem0ai distribution contains the Mem0-specific plugins.
To install these first-party plugin libraries, you can use the full distribution name (for example, nvidia-nat-langchain) or use the nvidia-nat[langchain] extra distribution. The following extras are supported:
nvidia-nat[adk]ornvidia-nat-adk- Google ADKnvidia-nat[agno]ornvidia-nat-agno- Agnonvidia-nat[all]ornvidia-nat-all- Pseudo-package for installing almost all optional dependenciesnvidia-nat[crewai]ornvidia-nat-crewai- CrewAI. Conflicts withnvidia-nat[openpipe-art].nvidia-nat[data-flywheel]ornvidia-nat-data-flywheel- NeMo DataFlywheelnvidia-nat[ingestion]ornvidia-nat-ingestion- Additional dependencies needed for data ingestionnvidia-nat[langchain]ornvidia-nat-langchain- LangChain, LangGraphnvidia-nat[llama-index]ornvidia-nat-llama-index- LlamaIndexnvidia-nat[mcp]ornvidia-nat-mcp- Model Context Protocol (MCP)nvidia-nat[mem0ai]ornvidia-nat-mem0ai- Mem0nvidia-nat[mysql]ornvidia-nat-mysql- MySQLnvidia-nat[openpipe-art]ornvidia-nat-openpipe-art- Agent Reinforcement Trainer Not part ofnvidia-nat[all]ornvidia-nat-all. Conflicts withnvidia-nat[crewai].nvidia-nat[opentelemetry]ornvidia-nat-opentelemetry- OpenTelemetrynvidia-nat[phoenix]ornvidia-nat-phoenix- Arize Phoenixnvidia-nat[profiling]ornvidia-nat-profiling- Additional dependencies needed for profilingnvidia-nat[ragaai]ornvidia-nat-ragaai- RagaAI Catalyst Not part ofnvidia-nat[all]ornvidia-nat-all. Conflicts withnvidia-nat[strands].nvidia-nat[redis]ornvidia-nat-redis- Redisnvidia-nat[s3]ornvidia-nat-s3- Amazon S3nvidia-nat[semantic-kernel]ornvidia-nat-semantic-kernel- Microsoft Semantic Kernelnvidia-nat[strands]ornvidia-nat-strands- Strands Agents. Conflicts withnvidia-nat[ragaai].nvidia-nat[test]ornvidia-nat-test- NeMo Agent toolkit testnvidia-nat[vanna]ornvidia-nat-vanna- Vanna text-to-SQL with Databricks supportnvidia-nat[weave]ornvidia-nat-weave- Weights & Biases Weavenvidia-nat[zep-cloud]ornvidia-nat-zep-cloud- Zep
Supported Platforms#
Operating System |
Architecture |
Python Version |
Supported |
|---|---|---|---|
Linux |
x86_64 |
3.11, 3.12, 3.13 |
✅ Tested, Validated in CI |
Linux |
aarch64 |
3.11, 3.12, 3.13 |
✅ Tested, Validated in CI |
macOS |
x86_64 |
3.11, 3.12, 3.13 |
❓ Untested, Should Work |
macOS |
aarch64 |
3.11, 3.12, 3.13 |
✅ Tested |
Windows |
x86_64 |
3.11, 3.12, 3.13 |
❓ Untested, Should Work |
Windows |
aarch64 |
3.11, 3.12, 3.13 |
❌ Unsupported |
Software Prerequisites#
NVIDIA NeMo Agent toolkit is a Python library that doesn’t require a GPU to run by default. Before you begin using NeMo Agent toolkit, ensure that you meet the following software prerequisites:
Python 3.11, 3.12, or 3.13
Additional Prerequisites for Development#
Git Large File Storage (LFS)
uv (version 0.5.4 or later, latest version is recommended)
Install from Package#
The package installation is recommended for production use.
Note
To run any examples, you need to install the NeMo Agent toolkit from source.
To install the latest stable version of NeMo Agent toolkit, run the following command:
pip install nvidia-nat
NeMo Agent toolkit has many optional dependencies which can be installed with the core package. Optional dependencies are grouped by framework and can be installed with the core package. For example, to install the LangChain/LangGraph plugin, run the following:
pip install "nvidia-nat[langchain]"
Or for all optional dependencies:
pip install "nvidia-nat[all]"
The full list of optional dependencies can be found here.
Install From Source#
Warning
Using Conda environments is not recommended and may cause component resolution issues. Only create vanilla Python virtual environments through python -m venv or uv venv with no other active environments. For more information, see the Troubleshooting Guide.
Installing from source is required to run any examples provided in the repository or to contribute to the project.
Clone the NeMo Agent toolkit repository to your local machine.
git clone -b main https://github.com/NVIDIA/NeMo-Agent-Toolkit.git nemo-agent-toolkit cd nemo-agent-toolkit
Initialize, fetch, and update submodules in the Git repository.
git submodule update --init --recursive
Fetch the data sets by downloading the LFS files.
git lfs install git lfs fetch git lfs pull
Create a Python environment.
uv venv --python 3.13 --seed .venv source .venv/bin/activate
Note
Python 3.11 and 3.12 are also supported simply replace
3.13with3.11or3.12in theuvcommand above.Install the NeMo Agent toolkit library. To install the NeMo Agent toolkit library along with all of the optional dependencies. Including developer tools (
--all-groups) and all of the dependencies needed for profiling and plugins (--all-extras) in the source repository, run the following:uv sync --all-groups --all-extras
Alternatively to install just the core NeMo Agent toolkit without any optional plugins, run the following:
uv syncAt this point individual plugins, which are located under the
packagesdirectory, can be installed with the following commanduv pip install -e '.[<plugin_name>]'. For example, to install the LangChain/LangGraph plugin, run the following:uv pip install -e '.[langchain]'
Note
Many of the example workflows require plugins, and following the documented steps in one of these examples will in turn install the necessary plugins. For example following the steps in the
examples/getting_started/simple_web_query/README.mdguide will install thenvidia-nat-langchainplugin if you haven’t already done so.In addition to plugins, there are optional dependencies needed for profiling. Installing the
profilingsub-package is required for evaluation and profiling workflows usingnat eval. To install these dependencies, run the following:uv pip install -e '.[profiling]'
Verify that you’ve installed the NeMo Agent toolkit library.
nat --help nat --version
If the installation succeeded, the
natcommand will log the help message and its current version.
Next Steps#
Follow the Quick Start Guide to get started running workflows with NeMo Agent toolkit.