Skip to content

Cleanup readmes #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 18, 2025
+3 −35
Merged

Cleanup readmes #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5895d95
Updating readme.md and fixing links
mdemoret-nv Mar 18, 2025
24d6a6e
Merge remote-tracking branch 'upstream/develop' into mdd_cleanup-readmes
mdemoret-nv Mar 18, 2025
41e44dc
Removing Getting Started Section from Pypi Readme
mdemoret-nv Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 3 additions & 35 deletions src/aiq/meta/pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

![NVIDIA AgentIQ](./docs/source/_static/agentiq_banner.png "AgentIQ banner image")
![NVIDIA AgentIQ](https://media.githubusercontent.com/media/NVIDIA/AgentIQ/refs/heads/main/docs/source/_static/agentiq_banner.png "AgentIQ banner image")

# NVIDIA AgentIQ

Expand Down Expand Up @@ -44,40 +44,8 @@ With AgentIQ, you can move quickly, experiment freely, and ensure reliability ac
* [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 troubleshooting 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[<your framework>]
```

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.
> ## First time user?
> If this is your first time using AgentIQ, it is recommended to install the latest version from the [source repository](https://github.com/NVIDIA/AgentIQ?tab=readme-ov-file#get-started) on GitHub. This package is intended for users who are familiar with AgentIQ applications and need to add AgentIQ as a dependency to their project.

## Feedback

Expand Down