Install NVIDIA AgentIQ#

AgentIQ is a Python library that doesn’t require a GPU to run the workflow by default. You can deploy the core workflows using one of the following:

  • Ubuntu or other Linux distributions, including WSL, in a Python virtual environment.

Install From Source#

Prerequisites#

Before you begin using AgentIQ, ensure that you meet the following software prerequisites.

  1. Clone the AgentIQ repository to your local machine.

    git clone git@github.com:NVIDIA/AgentIQ.git agentiq
    cd agentiq
    
  2. Initialize, fetch, and update submodules in the Git repository.

    git submodule update --init --recursive
    
  3. Fetch the data sets by downloading the LFS files.

    git lfs install
    git lfs fetch
    git lfs pull
    
  4. Create a Python environment.

    uv venv --seed .venv
    source .venv/bin/activate
    
  5. Install the AgentIQ library. To install the AgentIQ 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 AgentIQ without any plugins, run the following:

    uv sync
    

    At this point individual plugins, which are located under the packages directory, can be installed with the following command uv pip install -e '.[<plugin_name>]'. For example, to install the langchain 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/simple/README.md guide will install the agentiq-langchain plugin if you haven’t already done so.

    In addition to plugins, there are optional dependencies needed for profiling. To install these dependencies, run the following:

    uv pip install -e .[profiling]
    
  6. Verify that you’ve installed the AgentIQ library.

    aiq --help
    aiq --version
    

    If the installation succeeded, the aiq command will log the help message and its current version.

AgentIQ Packages#

Once an AgentIQ workflow is ready for deployment to production, the deployed workflow will need to declare a dependency on the agentiq package, along with the needed plugins. When declaring a dependency on AgentIQ it is recommended to use the first two digits of the version number. For example if the version is 1.0.0 then the dependency would be 1.0.

For more information on the available plugins, refer to the Framework Integrations section of the plugins documentation.

Example dependency for AgentIQ using the langchain plugin for projects using a pyproject.toml file:

dependencies = [
"agentiq[langchain]~=1.0",
# Add any additional dependencies your workflow needs
]

Alternately for projects using a requirements.txt file:

agentiq[langchain]==1.0.*

Next Steps#

After installing AgentIQ, you can start using AgentIQ agentic workflows. For more information, refer to Get Started with AgentIQ.