Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -536,4 +536,4 @@ Portions adopted from

- [https://github.com/nv-morpheus/Morpheus/blob/branch-24.06/CONTRIBUTING.md](https://github.com/nv-morpheus/Morpheus/blob/branch-24.06/CONTRIBUTING.md)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

remove morpheus references

- [https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md](https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md)
- [https://github.com/dask/dask/blob/master/docs/source/develop.rst](https://github.com/dask/dask/blob/master/docs/source/develop.rst)
- [https://github.com/dask/dask/blob/master/docs/source/develop.rst](https://github.com/dask/dask/blob/master/docs/source/develop.rst)
10 changes: 5 additions & 5 deletions docs/docs/extraction/air-gapped-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)):

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The 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)

Expand Down Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/extraction/audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

NVCF== build.nvidia.com

Expand Down Expand Up @@ -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).



Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extraction/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this hardlinking a release branch?



## Parameter Reference
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/extraction/nemoretriever-parse.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Use the following procedure to run the NIM locally.

!!! 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).


## Using NVCF Endpoints for Cloud-Based Inference
Expand Down Expand Up @@ -102,7 +102,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).



Expand Down
8 changes: 4 additions & 4 deletions docs/docs/extraction/notebooks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Notebooks for NeMo Retriever Library

To get started using [NeMo Retriever Library](overview.md), you can try one of the ready-made notebooks that are available.
To get started using [NeMo Retriever Library](overview.md), you can try one of the guides or ready-made notebooks that are available.

!!! note

Expand All @@ -13,10 +13,10 @@ If you plan to run benchmarking or evaluation tests, you must download the [Benc

## Getting Started

To get started with the basics, try one of the following notebooks:
To get started with the basics, try one of the following guides or notebooks:

- [NV-Ingest: CLI Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/cli_client_usage.ipynb)
- [NV-Ingest: Python Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/python_client_usage.ipynb)
- [CLI Client Quick Start Guide](quickstart-guide.md#ingest_cli_example) — walkthrough for `nv-ingest-cli` / `retriever` with the self-hosted stack
- [Python Client Quick Start Guide](quickstart-guide.md#ingest_python_example) — walkthrough for the Python client with the self-hosted stack
- [How to add metadata to your documents and filter searches](https://github.com/NVIDIA/nv-ingest/blob/main/examples/metadata_and_filtered_search.ipynb)
- [How to reindex a collection](https://github.com/NVIDIA/nv-ingest/blob/main/examples/reindex_example.ipynb)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extraction/nv-ingest-python-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The [NeMo Retriever Library](overview.md) Python API provides a simple and flexi

!!! tip

There is a Jupyter notebook available to help you get started with the Python API. For more information, refer to [Python Client Quick Start Guide](https://github.com/NVIDIA/nv-ingest/blob/main/client/client_examples/examples/python_client_usage.ipynb).
For examples and walkthroughs using the Python API, refer to the [Python Client Quick Start Guide](quickstart-guide.md#ingest_python_example) and [Python API Reference](python-api-reference.md).


## Summary of Key Methods
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extraction/nv-ingest_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ nv-ingest-cli --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/nv-ingest/blob/main/client/client_examples/examples/cli_client_usage.ipynb).
For CLI examples and walkthroughs, refer to the [CLI Client Quick Start Guide](quickstart-guide.md#ingest_cli_example) and [CLI Reference](cli-reference.md).


## Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extraction/python-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The [NeMo Retriever Library](overview.md) Python API provides a simple and flexi

!!! tip

There is a Jupyter notebook available to help you get started with the Python API. For more information, refer to [Python Client Quick Start Guide](https://github.com/NVIDIA/NeMo-Retriever/blob/main/client/client_examples/examples/python_client_usage.ipynb).
For examples and walkthroughs using the Python API, refer to the [Python Client Quick Start Guide](quickstart-guide.md#ingest_python_example) and [Use the NeMo Retriever Library Python API](nv-ingest-python-api.md).


## Summary of Key Methods
Expand Down
14 changes: 3 additions & 11 deletions docs/docs/extraction/quickstart-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -319,10 +315,6 @@ image_caption:[]

### Using the `nv-ingest-cli`

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The 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 \
Expand Down Expand Up @@ -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`).

Expand Down Expand 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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extraction/releasenotes-nv-ingest.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Highlights for the 26.03 release include:
- [Prerequisites](prerequisites.md)
- [Deploy Without Containers (Library Mode)](quickstart-library-mode.md)
- [Deploy With Docker Compose (Self-Hosted)](quickstart-guide.md)
- [Deploy With Helm](helm.md)
- [Deploy With Helm](helm.md)
2 changes: 1 addition & 1 deletion docs/docs/extraction/support-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Advanced features require additional GPU support and disk space.
This includes the following:

- Audio extraction - parakeet-1-1b-ctc-en-us — Use the [Parakeet CTC English (en-US) ASR NIM](https://docs.nvidia.com/nim/speech/latest/asr/deploy-asr-models/parakeet-ctc-en-us.html) (`nvcr.io/nim/nvidia/parakeet-1-1b-ctc-en-us`) for processing audio files. For more information, refer to [Audio Processing](audio.md).
- Advanced visual parsing — Use [nemotron-parse](https://docs.nvidia.com/nim/vision-language-models/latest/examples/nemotron-parse/overview.html), which adds state-of-the-art text and table extraction. For more information, refer to [Advanced Visual Parsing ](nemoretriever-parse.md).
- Advanced visual parsing — Use [nemotron-parse](https://docs.api.nvidia.com/nim/reference/nvidia-nemotron-parse), which adds state-of-the-art text and table extraction. For more information, refer to [Advanced Visual Parsing ](nemoretriever-parse.md).
- VLM — Use [nemotron-nano-12b-v2-vl](https://build.nvidia.com/nvidia/nemotron-nano-12b-v2-vl/modelcard) for experimental image captioning of unstructured images.

!!! note
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/extraction/user-defined-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The 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)
Loading