From f49bc099436076d33c60da4f717ec9822fed6fc1 Mon Sep 17 00:00:00 2001 From: Anuradha Karuppiah Date: Mon, 17 Mar 2025 14:36:40 -0700 Subject: [PATCH 1/4] Use a separate README for pypi Signed-off-by: Anuradha Karuppiah --- pypi.md | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- 2 files changed, 98 insertions(+), 1 deletion(-) create mode 100644 pypi.md diff --git a/pypi.md b/pypi.md new file mode 100644 index 000000000..f3e69e7f4 --- /dev/null +++ b/pypi.md @@ -0,0 +1,97 @@ + + +![NVIDIA AgentIQ](./docs/source/_static/agentiq_banner.png "AgentIQ banner image") + +# NVIDIA AgentIQ + +AgentIQ is a flexible library designed to seamlessly integrate your enterprise agents—regardless of framework—with various data sources and tools. By treating agents, tools, and agentic workflows as simple function calls, AgentIQ enables true composability: build once and reuse anywhere. + +## Key Features + +- [**Framework Agnostic:**](https://docs.nvidia.com/agentiq/latest/concepts/plugins.html) Works with any agentic framework, so you can use your current technology stack without replatforming. +- [**Reusability:**](https://docs.nvidia.com/agentiq/latest/guides/sharing_workflows_and_tools.html) Every agent, tool, or workflow can be combined and repurposed, allowing developers to leverage existing work in new scenarios. +- [**Rapid Development:**](https://docs.nvidia.com/agentiq/latest/guides/create_customize_workflows.html) Start with a pre-built agent, tool, or workflow, and customize it to your needs. +- [**Profiling:**](https://docs.nvidia.com/agentiq/latest/guides/profiler.html) Profile entire workflows down to the tool and agent level, track input/output tokens and timings, and identify bottlenecks. +- [**Observability:**](https://docs.nvidia.com/agentiq/latest/guides/observe_workflow_with_phoenix.html) Monitor and debug your workflows with any OpenTelemetry-compatible observability tool. +- [**Evaluation System:**](https://docs.nvidia.com/agentiq/latest/guides/evaluate.html) Validate and maintain accuracy of agentic workflows with built-in evaluation tools. +- [**User Interface:**](https://docs.nvidia.com/agentiq/latest/guides/use_aiq_serve.html) Use the AgentIQ UI chat interface to interact with your agents, visualize output, and debug workflows. +- [**MCP Compatibility**](https://docs.nvidia.com/agentiq/latest/components/mcp.html) Compatible with Model Context Protocol (MCP), allowing tools served by MCP Servers to be used as AgentIQ functions. + +With AgentIQ, you can move quickly, experiment freely, and ensure reliability across all your agent-driven projects. + +## Links + + * [Documentation](https://docs.nvidia.com/agentiq/latest/index.html): Explore the full documentation for AgentIQ. + * [About AgentIQ](https://docs.nvidia.com/agentiq/latest/intro/why_aiq.html): Learn more about the benefits of using AgentIQ. + * [Get Started Guide](https://docs.nvidia.com/agentiq/latest/intro/get_started.html): Set up your environment and start building with AgentIQ. + * [Examples](https://github.com/NVIDIA/AgentIQ/tree/main/examples#readme): Explore examples of AgentIQ workflows. + * [Create and Customize AgentIQ Workflows](https://docs.nvidia.com/agentiq/latest/guides/create_customize_workflows.html): Learn how to create and customize AgentIQ workflows. + * [Evaluate with AgentIQ](https://docs.nvidia.com/agentiq/latest/guides/evaluate.html): Learn how to evaluate your AgentIQ workflows. + * [Troubleshooting](https://docs.nvidia.com/agentiq/latest/troubleshooting.html): Get help with common issues. + + +## Get Started + +1. Ensure you have Python 3.12, and a Python development environment. + + Assuming Python 3.12 is installed, create a virtual environment and activate it with: + ```bash + python -m venv env + source env/bin/activate + ``` + +2. Install AgentIQ with support for your desired LLM framework + + ```bash + pip install agentiq[] + ``` + + For example, to install AgentIQ with support for the LangChain framework (which is necessary for the Hello World example), use the following command: + + ```bash + pip install agentiq[langchain] + ``` + + > [!NOTE] + > AgentIQ also supports other LLM frameworks. Refer to the [plugin guide](https://docs.nvidia.com/agentiq/latest/concepts/plugins.md) for more information. + + +3. Verify the installation using the AgentIQ CLI + + ```bash + aiq --version + ``` + + This should output the AgentIQ version which is currently installed. + +## Feedback + +We would love to hear from you! Please file an issue on [GitHub](https://github.com/NVIDIA/AgentIQ/issues) if you have any feedback or feature requests. + +## Acknowledgements + +We would like to thank the following open source projects that made AgentIQ possible: + +- [CrewAI](https://github.com/crewAIInc/crewAI) +- [FastAPI](https://github.com/tiangolo/fastapi) +- [LangChain](https://github.com/langchain-ai/langchain) +- [Llama-Index](https://github.com/run-llama/llama_index) +- [Mem0ai](https://github.com/mem0ai/mem0) +- [Ragas](https://github.com/explodinggradients/ragas) +- [Semantic Kernel](https://github.com/microsoft/semantic-kernel) +- [uv](https://github.com/astral-sh/uv) diff --git a/pyproject.toml b/pyproject.toml index 6f5754739..45f98d92f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,7 +43,7 @@ dependencies = [ ] requires-python = "==3.12.*" description = "AgentIQ" -readme = "README.md" +readme = "pypi.md" license = { file = "LICENSE.md" } keywords = ["ai", "rag", "agents"] classifiers = ["Programming Language :: Python"] From e447554d9dc34ed73756a0b82f1c52d4eef74e63 Mon Sep 17 00:00:00 2001 From: Anuradha Karuppiah Date: Mon, 17 Mar 2025 15:12:22 -0700 Subject: [PATCH 2/4] Move pypi.md to ci Signed-off-by: Anuradha Karuppiah --- MANIFEST.in | 1 + pypi.md => ci/pypi.md | 0 pyproject.toml | 2 +- 3 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 MANIFEST.in rename pypi.md => ci/pypi.md (100%) diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 000000000..b16833d28 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include ci/pypi.md diff --git a/pypi.md b/ci/pypi.md similarity index 100% rename from pypi.md rename to ci/pypi.md diff --git a/pyproject.toml b/pyproject.toml index 45f98d92f..bacc2e2cd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,7 +43,7 @@ dependencies = [ ] requires-python = "==3.12.*" description = "AgentIQ" -readme = "pypi.md" +readme = "ci/pypi.md" license = { file = "LICENSE.md" } keywords = ["ai", "rag", "agents"] classifiers = ["Programming Language :: Python"] From 7c3b1caae1b962bd800c6da79f10677631541d5e Mon Sep 17 00:00:00 2001 From: Anuradha Karuppiah Date: Mon, 17 Mar 2025 16:09:24 -0700 Subject: [PATCH 3/4] Moved pypi.md to internal metadata Notes for the future 1. README gets copied agentiq-*.dist-info/METADATA. So need to be a complete path within src. 2. The README doesn't need to be include as a data file Signed-off-by: Anuradha Karuppiah --- MANIFEST.in | 1 - pyproject.toml | 2 +- {ci => src/aiq/meta}/pypi.md | 0 3 files changed, 1 insertion(+), 2 deletions(-) delete mode 100644 MANIFEST.in rename {ci => src/aiq/meta}/pypi.md (100%) diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index b16833d28..000000000 --- a/MANIFEST.in +++ /dev/null @@ -1 +0,0 @@ -include ci/pypi.md diff --git a/pyproject.toml b/pyproject.toml index bacc2e2cd..8b8061c6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,7 +43,7 @@ dependencies = [ ] requires-python = "==3.12.*" description = "AgentIQ" -readme = "ci/pypi.md" +readme = "src/aiq/meta/pypi.md" license = { file = "LICENSE.md" } keywords = ["ai", "rag", "agents"] classifiers = ["Programming Language :: Python"] diff --git a/ci/pypi.md b/src/aiq/meta/pypi.md similarity index 100% rename from ci/pypi.md rename to src/aiq/meta/pypi.md From d6dd68a18eb868c6d39a74e7e00f2cdc914d0f60 Mon Sep 17 00:00:00 2001 From: Anuradha Karuppiah Date: Mon, 17 Mar 2025 16:40:10 -0700 Subject: [PATCH 4/4] Check GPG verification Signed-off-by: Anuradha Karuppiah --- src/aiq/meta/pypi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/aiq/meta/pypi.md b/src/aiq/meta/pypi.md index f3e69e7f4..3f94c6ce3 100644 --- a/src/aiq/meta/pypi.md +++ b/src/aiq/meta/pypi.md @@ -42,7 +42,7 @@ With AgentIQ, you can move quickly, experiment freely, and ensure reliability ac * [Examples](https://github.com/NVIDIA/AgentIQ/tree/main/examples#readme): Explore examples of AgentIQ workflows. * [Create and Customize AgentIQ Workflows](https://docs.nvidia.com/agentiq/latest/guides/create_customize_workflows.html): Learn how to create and customize AgentIQ workflows. * [Evaluate with AgentIQ](https://docs.nvidia.com/agentiq/latest/guides/evaluate.html): Learn how to evaluate your AgentIQ workflows. - * [Troubleshooting](https://docs.nvidia.com/agentiq/latest/troubleshooting.html): Get help with common issues. + * [Troubleshooting](https://docs.nvidia.com/agentiq/latest/troubleshooting.html): Get help with troubleshooting common issues. ## Get Started