-
Notifications
You must be signed in to change notification settings - Fork 342
align extraction links with quickstart, NeMo-Retriever paths, and API docs #2048
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.
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
Changes from all commits
50fc807
dde2c19
5f42a3f
4697db3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,10 +4,10 @@ This guide consolidates what you need to run NeMo Retriever Library in a secured | |
|
|
||
| !!! note "Source of truth for versions" | ||
|
|
||
| Image repositories and default tags change between releases. Always verify pins against the `release/26.3.0` (or your exact stack) branches of: | ||
| Image repositories and default tags change between releases. Always verify pins against the Git branch that matches your stack (for 26.3.x self-hosted docs, use the NeMo Retriever **`26.03`** branch as the structural baseline): | ||
|
|
||
| - [NeMo Retriever `docker-compose.yaml`](https://github.com/NVIDIA/NeMo-Retriever/blob/release/26.3.0/docker-compose.yaml) for self-hosted Compose (check out the **Git tag or branch that matches 26.3.0** in your environment; `main` moves forward) | ||
| - [`helm/values.yaml`](https://github.com/NVIDIA/NeMo-Retriever/blob/release/26.3.0/helm/values.yaml) and [`helm/README.md`](https://github.com/NVIDIA/NeMo-Retriever/blob/release/26.3.0/helm/README.md) for Kubernetes / Helm | ||
| - [NeMo Retriever `docker-compose.yaml`](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/docker-compose.yaml) for self-hosted Compose | ||
| - [`helm/values.yaml`](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/helm/values.yaml) and [`helm/README.md`](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/helm/README.md) for Kubernetes / Helm | ||
|
|
||
| ## End-to-end workflow | ||
|
|
||
|
|
@@ -62,7 +62,7 @@ Again, take the exact repository and tag from your pinned `values.yaml` for 26.3 | |
|
|
||
| ## Helm charts and packaging artifacts | ||
|
|
||
| From a connected environment, download and version-control the chart archive you install, for example (see [NV-Ingest Helm README](https://github.com/NVIDIA/NeMo-Retriever/blob/release/26.3.0/helm/README.md)): | ||
| From a connected environment, download and version-control the chart archive you install, for example (see [NV-Ingest Helm README](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/helm/README.md)): | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove nv-ingest references |
||
|
|
||
| - `nv-ingest-26.3.0.tgz` from NGC Helm (`helm pull` with NGC credentials) | ||
|
|
||
|
|
@@ -90,7 +90,7 @@ Transfer tarballs instead when the enclave has no registry yet: `docker save -o | |
|
|
||
| ### Docker Compose | ||
|
|
||
| - Override each `*_IMAGE` / `*_TAG` environment variable (see [`docker-compose.yaml`](https://github.com/NVIDIA/NeMo-Retriever/blob/release/26.3.0/docker-compose.yaml)) so every `image:` resolves to your mirror. | ||
| - Override each `*_IMAGE` / `*_TAG` environment variable (see [`docker-compose.yaml`](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/docker-compose.yaml)) so every `image:` resolves to your mirror. | ||
| - Keep hosted API endpoints disabled: use in-stack URLs for NIMs (defaults in the compose file already prefer `http://…` service names over `https://integrate.api.nvidia.com`). | ||
| - Provide `.env` or config alongside the compose file in the enclave; never rely on pulling new images at `up` time without registry access. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -92,7 +92,7 @@ To generate one extracted element for each sentence-like ASR segment, include `e | |
|
|
||
| !!! tip | ||
|
|
||
| For more Python examples, refer to [NV-Ingest: Python Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/python_client_usage.ipynb). | ||
| For more Python examples, refer to the [Python Client Quick Start Guide](quickstart-guide.md#ingest_python_example). | ||
|
|
||
|
|
||
| ## Use NVCF Endpoints for Cloud-Based Inference | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. NVCF== build.nvidia.com |
||
|
|
@@ -128,7 +128,7 @@ Instead of running the pipeline locally, you can use NVCF to perform inference b | |
|
|
||
| !!! tip | ||
|
|
||
| For more Python examples, refer to [NV-Ingest: Python Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/python_client_usage.ipynb). | ||
| For more Python examples, refer to the [Python Client Quick Start Guide](quickstart-guide.md#ingest_python_example). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ retriever --help | |
|
|
||
| !!! tip | ||
|
|
||
| There is a Jupyter notebook available to help you get started with the CLI. For more information, refer to [CLI Client Quick Start Guide](https://github.com/NVIDIA/NeMo-Retriever/blob/main/client/client_examples/examples/cli_client_usage.ipynb). | ||
| For CLI examples, see the [CLI section of the self-hosted quickstart](quickstart-guide.md#ingest_cli_example) or the [CLI companion notebook on the `26.03` branch](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/client/client_examples/examples/cli_client_usage.ipynb). | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is this hardlinking a release branch? |
||
|
|
||
|
|
||
| ## Parameter Reference | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ Use the provided [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/ | |
| NIM containers on their first startup can take 10-15 minutes to pull and fully load models. | ||
|
|
||
|
|
||
| If you prefer, you can run on Kubernetes by using [our Helm chart](https://github.com/NVIDIA/nv-ingest/blob/main/helm/README.md). Also, there are [additional environment variables](environment-config.md) you can configure. | ||
| If you prefer, you can run on Kubernetes by using [our Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/helm/README.md). Also, there are [additional environment variables](environment-config.md) you can configure. | ||
|
|
||
| a. Git clone the repo: | ||
|
|
||
|
|
@@ -177,10 +177,6 @@ The following examples demonstrate how to extract text, charts, tables, and imag | |
|
|
||
| ### In Python | ||
|
|
||
| !!! tip | ||
|
|
||
| For more Python examples, refer to [NV-Ingest: Python Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/python_client_usage.ipynb). | ||
|
|
||
| <a id="ingest_python_example"></a> | ||
| ```python | ||
| import logging, os, time | ||
|
|
@@ -319,10 +315,6 @@ image_caption:[] | |
|
|
||
| ### Using the `nv-ingest-cli` | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove nv-ingest references |
||
|
|
||
| !!! tip | ||
|
|
||
| There is a Jupyter notebook available to help you get started with the CLI. For more information, refer to [CLI Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/cli_client_usage.ipynb). | ||
|
|
||
| <a id="ingest_cli_example"></a> | ||
| ```shell | ||
| nv-ingest-cli \ | ||
|
|
@@ -474,7 +466,7 @@ For a complete NeMo Retriever Library air-gapped checklist (Compose and Kubernet | |
| When deploying in an air-gapped environment (no internet or NGC registry access), you must pre-stage container images on a machine with network access, then transfer and load them in the isolated environment. | ||
|
|
||
| 1. On a machine with network access: Clone the repo, authenticate with NGC (`docker login nvcr.io`), and pull all images used by your chosen profile (for example, `docker compose --profile retrieval pull`). | ||
| 2. Save images: Export the images to archives (for example, using `docker save` for each image or a script that saves all images referenced by your [docker-compose.yaml](https://github.com/NVIDIA/NeMo-Retriever/blob/main/docker-compose.yaml)). | ||
| 2. Save images: Export the images to archives (for example, using `docker save` for each image or a script that saves all images referenced by your [docker-compose.yaml](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/docker-compose.yaml)). | ||
| 3. Transfer the image archives and your `docker-compose.yaml` (and `.env` if used) to the air-gapped system. | ||
| 4. On the air-gapped machine: Load the images (`docker load -i <archive>`) and start the stack with the same profile (for example, `docker compose --profile retrieval up`). | ||
|
|
||
|
|
@@ -536,7 +528,7 @@ docker compose \ | |
|
|
||
| ## Specify MIG slices for NIM models | ||
|
|
||
| When you deploy NeMo Retriever Library with NIM models on MIG‑enabled GPUs, MIG device slices are requested and scheduled through the `values.yaml` file for the corresponding NIM microservice. For IBM Content-Aware Storage (CAS) deployments, this allows NeMo Retriever Library NIM pods to land only on nodes that expose the desired MIG profiles [raw.githubusercontent](https://raw.githubusercontent.com/NVIDIA/NeMo-Retriever/main/helm/README.md). | ||
| When you deploy NeMo Retriever Library with NIM models on MIG‑enabled GPUs, MIG device slices are requested and scheduled through the `values.yaml` file for the corresponding NIM microservice. For IBM Content-Aware Storage (CAS) deployments, this allows NeMo Retriever Library NIM pods to land only on nodes that expose the desired MIG profiles [raw.githubusercontent](https://raw.githubusercontent.com/NVIDIA/NeMo-Retriever/26.03/helm/README.md). | ||
|
|
||
| To target a specific MIG profile—for example, a 3g.20gb slice on an A100, which is a hardware-partitioned virtual GPU instance that gives your workload a fixed mid-sized share of the A100’s compute plus 20 GB of dedicated GPU memory and behaves like a smaller independent GPU—for a given NIM, configure the `resources` and `nodeSelector` under that NIM’s values path in `values.yaml`. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -940,6 +940,6 @@ def debug_udf(control_message: IngestControlMessage) -> IngestControlMessage: | |
|
|
||
| ## Related Topics | ||
|
|
||
| - [NV-Ingest UDF Examples](https://github.com/NVIDIA/nv-ingest/blob/release/26.1.2/examples/udfs/README.md) | ||
| - [NV-Ingest UDF Examples](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/udfs/README.md) | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove nv-ingest references |
||
| - [User-Defined Stages for NeMo Retriever Library](user-defined-stages.md) | ||
| - [NimClient Usage](nimclient.md) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove morpheus references