Skip to content

Commit a4d075d

Browse files
committed
Merge upstream/main into docs/ocr-v2-defaults
Resolve conflict in multimodal-extraction.md by keeping the PR branch OCR section with Helm README link and consistent refer-to CTAs.
2 parents ae79b88 + 85b490a commit a4d075d

17 files changed

Lines changed: 43 additions & 194 deletions

.github/workflows/nrl-docs-nvidia-publish.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ jobs:
134134
EMAILS="${NOTIFY_INPUT}"
135135
fi
136136
fi
137+
if [[ -z "${EMAILS}" ]]; then
138+
EMAILS="kheiss@nvidia.com"
139+
fi
137140
echo "emails_csv=${EMAILS}" >> "$GITHUB_OUTPUT"
138141
139142
build:

docs/docs/extraction/agentic-retrieval-concept.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ NeMo Retriever Library focuses on document ingestion, embeddings, vector stores,
77
**Related**
88

99
- [Semantic retrieval](vdbs.md#semantic-retrieval)
10-
- Framework examples: [LangChain, LlamaIndex, Haystack](integrations-langchain-llamaindex-haystack.md)
10+
- Framework examples: [Starter kits](starter-kits.md)

docs/docs/extraction/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ Token-based splitting uses the Llama 3.2 1B tokenizer (default `meta-llama/Llama
3636

3737
- **Library mode** — Run without the full container stack where appropriate; see [Deployment options](deployment-options.md).
3838
- **Kubernetes / Helm (self-hosted)** — See [Deploy (Helm chart)](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) and [deployment options](deployment-options.md) for running the full microservices pipeline on your infrastructure.
39-
- **Notebooks**[Jupyter examples](notebooks/index.md) for experimentation and RAG demos.
39+
- **Notebooks**[Jupyter examples](starter-kits.md) for experimentation and RAG demos.
4040

4141
For a concise comparison, refer to [Deployment options](deployment-options.md).

docs/docs/extraction/custom-metadata.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

docs/docs/extraction/deployment-options.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,11 @@ Build and run the NeMo Retriever service image with the [Docker service image gu
2424

2525
**Core NIMs for the default extraction pipeline** (26.05): `page_elements`, `table_structure`, `ocr`, and `vlm_embed` (`llama-nemotron-embed-vl-1b-v2:1.12.0`). These four are auto-wired into the retriever service. **Nemotron Parse**, **Nemotron 3 Nano Omni**, the **VL reranker**, and **Parakeet ASR** are optional and not auto-wired. For a minimal GPU footprint, disable optional keys you do not need (refer to [Recommended minimal install (26.05)](https://github.com/NVIDIA/NeMo-Retriever/blob/26.05/nemo_retriever/helm/README.md#recommended-minimal-install-2605)). Refer to [Pre-Requisites & Support Matrix — Default Helm NIMs](prerequisites-support-matrix.md#default-helm-nims).
2626

27-
For audio and video extraction in Kubernetes, set `service.installFfmpeg=true` so the service installs `ffmpeg` and `ffprobe` at container startup. This runtime install requires package-repository egress and cluster policy that allows the image's scoped sudo use. For Helm chart procedures, OpenShift-specific configuration, and air-gapped alternatives, refer to [Audio and video (Parakeet ASR)](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md#audio-video-parakeet) and [OpenShift deployment](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/openshift.md) in the Helm chart directory.
27+
For audio and video extraction in Kubernetes, set `service.installFfmpeg=true` so the service container installs `ffmpeg` and `ffprobe` at startup. This runtime install requires package-repository network egress, a writable root filesystem, and security policy that allows the image's scoped sudo use. If your cluster blocks startup package installation, use a custom service image that already contains `ffmpeg` and `ffprobe`, then set `service.image.repository` and `service.image.tag`. For Parakeet ASR chart values, OpenShift-specific Helm configuration, and air-gapped alternatives, refer to [Audio and video (Parakeet ASR)](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md#audio-video-parakeet) and [OpenShift deployment](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/openshift.md) in the Helm chart directory.
2828

2929
### I want examples and notebooks
3030

31-
1. [Jupyter Notebooks](notebooks/index.md)
32-
2. [Integrate with LangChain, LlamaIndex, Haystack](integrations-langchain-llamaindex-haystack.md)
31+
1. [Jupyter Notebooks](starter-kits.md)
3332

3433
### I need API details and keys
3534

docs/docs/extraction/getting-started-about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Typical order:
99
3. Deploy using one of:
1010
- [Deployment options](deployment-options.md) for how to run NeMo Retriever Library
1111
- **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) for Kubernetes, plus [NeMo Retriever Library install docs](https://docs.nvidia.com/nemo/retriever/latest/extraction/overview/) for the published charts
12-
4. Explore [Jupyter Notebooks](notebooks/index.md) for end-to-end examples.
12+
4. Explore [Jupyter Notebooks](starter-kits.md) for end-to-end examples.
1313

1414
If you are new to the product, read [What is NeMo Retriever Library?](overview.md) and [Concepts](concepts.md) under **Introduction** first.

docs/docs/extraction/integrations-langchain-llamaindex-haystack.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/docs/extraction/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ NeMo Retriever Library supports the following file types:
4949
- [Deployment options](deployment-options.md) — library, Helm, hosted vs self-hosted NIMs in one place
5050
- [Deploy on Kubernetes with Helm](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md)
5151
- [NeMo Retriever Library — prerequisites / deployment](https://docs.nvidia.com/nemo/retriever/latest/extraction/overview/) (supported Helm charts)
52-
- [Notebooks](notebooks/index.md)
53-
- [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Integrations](integrations-langchain-llamaindex-haystack.md).
52+
- [Notebooks](starter-kits.md)
53+
- [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Starter kits](starter-kits.md).
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Notebooks for NeMo Retriever Library
1+
# Starter Kits for NeMo Retriever Library
22

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

55
## Dataset Downloads for Benchmarking
66

@@ -10,9 +10,9 @@ If you plan to run benchmarking or evaluation tests, you must download the [Benc
1010

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

13-
- [Quickstart: retriever CLI](../../reference/retriever-cli-quickstart.md)
14-
- [Workflow: Ingest documents](../workflow-document-ingestion.md)
15-
- [How to add metadata to your documents and filter searches](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/nemo_retriever_retriever_query_metadata_filter.ipynb)
13+
- [Quickstart: retriever CLI](../reference/retriever-cli-quickstart.md)
14+
- [Workflow: Ingest documents](workflow-document-ingestion.md)
15+
- [Adding Custom Metadata for Filtered Search/Retrieval](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/nemo_retriever_retriever_query_metadata_filter.ipynb) — also summarized on [Vector databases — Metadata and filtering](vdbs.md#metadata-and-filtering)
1616

1717

1818
For more advanced scenarios, try one of the following notebooks:

0 commit comments

Comments
 (0)