Skip to content

Align quickstart with uv venv, nv-ingest runtime, and safe CLI sample output #1717

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
kheiss-uwzoo merged 4 commits into from
Apr 22, 2026
Merged

Align quickstart with uv venv, nv-ingest runtime, and safe CLI sample output #1717

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
56ef692
added python installation information
kheiss-uwzoo Mar 24, 2026
732e483
Update quickstart-guide.md
kheiss-uwzoo Mar 24, 2026
7238042
Merge branch '26.03' into kheiss/5966239
jdye64 Mar 25, 2026
bc8dd36
Merge branch '26.03' into kheiss/5966239
kheiss-uwzoo Apr 22, 2026
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
32 changes: 32 additions & 0 deletions docs/docs/extraction/quickstart-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,38 @@ h. Run the command `docker ps`. You should see output similar to the following.
3403c5a0e7be redis/redis-stack "/entrypoint.sh" 7 minutes ago Up 7 minutes 0.0.0.0:6379... nv-ingest-redis-1
```

i. To run the NeMo Retriever Library Python client from your host machine, Python 3.12 or later is required. Create a virtual environment and install the client packages:

```shell
uv venv --python 3.12 nv-ingest-dev
source nv-ingest-dev/bin/activate
uv pip install nv-ingest==26.1.2 nv-ingest-api==26.1.2 nv-ingest-client==26.1.2
```
Comment on lines +104 to +110
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot Apr 22, 2026

Choose a reason for hiding this comment

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

P2 uv prerequisite not mentioned

Step i assumes uv is already installed, but the guide does not tell the reader how to get it. Users coming to this guide fresh may hit command not found: uv. Consider adding a short sentence (or a link to the prerequisites page) noting that uv must be installed first, e.g.:

If uv is not already installed, run curl -LsSf https://astral.sh/uv/install.sh | sh or see the uv installation docs.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: docs/docs/extraction/quickstart-guide.md
Line: 104-110

Comment:
**`uv` prerequisite not mentioned**

Step i assumes `uv` is already installed, but the guide does not tell the reader how to get it. Users coming to this guide fresh may hit `command not found: uv`. Consider adding a short sentence (or a link to the prerequisites page) noting that `uv` must be installed first, e.g.:

> If `uv` is not already installed, run `curl -LsSf https://astral.sh/uv/install.sh | sh` or see the [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/).

How can I resolve this? If you propose a fix, please make it concise.


!!! tip

To confirm that you have activated your virtual environment, run `which pip` and `which python`, and confirm that you see `nv-ingest-dev` in the result. You can do this before any pip or python command that you run.

!!! note

Interaction from the host requires the appropriate port to be exposed from the `nv-ingest` runtime container, as defined in the `docker-compose.yaml` file. If you prefer, you can disable this port and interact directly from within the container.

j. To work inside the container, run the following code.

```bash
docker exec -it nv-ingest-nv-ingest-ms-runtime-1 bash
```

This command opens a shell in the `/workspace` directory, where the `DATASET_ROOT` from your `.env` file is mounted at `./data`. The `nv-ingest` image uses Python 3.12 in a virtual environment at `/opt/nv_ingest_runtime` (created with `uv`), which includes the necessary Python client libraries. You should see a prompt similar to the following.

```bash
root@your-computer-name:/workspace#
```

From this prompt, you can run the `nv-ingest-cli` and Python examples.

Because many service URIs default to localhost, running inside the `nv-ingest` container also requires that you specify URIs manually so that services can communicate across containers on the internal Docker network. See the Python example in the next section for how to set the `milvus_uri`.

## Step 2: Ingest Documents

You can submit jobs programmatically in Python or using the [CLI](nv-ingest_cli.md).
Expand Down
Loading