Kheiss/readme quickstart by kheiss-uwzoo · Pull Request #1492 · NVIDIA/NeMo-Retriever

kheiss-uwzoo · 2026-03-05T17:15:41Z

Pull Request Summary: NeMo Retriever README — NVIDIA Style Guide and PRD Alignment

Overview

Updates to nemo_retriever/README.md to align with the NVIDIA Writing Style Guide and the Ingest 2.0 PRD for NeMo Retriever Library, covering voice and tone, formatting, links, acronyms, structure, and naming/positioning.

Changes

Voice and Tone (PACE)

Contractions: Replaced "it is" with "it's" for a more conversational tone.
Latinisms: Replaced "via" with "through" (per guidance to prefer "by" or "through" instead of "via").

Acronyms and First Use

RAG: First use now spelled out as "retrieval-augmented generation (RAG) ingestion pipeline."
OCR: First use now spelled out as "If optical character recognition (OCR) fails…".

Links

Replaced generic or bare link text with descriptive text that matches the destination (avoiding "here," "read more," and raw URLs):

[docs.nvidia](...benchmarking/) → NeMo Retriever extraction benchmarking documentation
[docs.nvidia](...extraction/audio/) → NeMo Retriever audio extraction documentation
[docs.nvidia](...25.6.3/extraction/audio/) → NeMo Retriever audio extraction documentation (25.6.3)
[docs.nvidia](...ray.html) → NeMo Ray run guide
[huggingface](...parakeet-ctc-1.1b) → Parakeet CTC 1.1B model on Hugging Face
[discuss.ray](...) → Connecting to a remote Ray cluster on Kubernetes
[cohesity](...) → How Cohesity uses NVIDIA NeMo Retriever microservices to improve RAG AI retrieval recall (Cohesity blog)

Formatting and Structure

Wrapped the LD_LIBRARY_PATH example in a fenced code block and introduced it with a full sentence and colon.
Removed a duplicate "Quick end‑to‑end test" section (repeated ## 8 heading, explanatory paragraph, and extra horizontal rule).
Added a missing comma in the leading sentence: "For example, the following command…".
Fixed a double space in "In this step, you uninstall" to a single space after "you".

PRD Conformance

Conformance: Yes (with 2 fixes applied)

The README was checked against the Ingest 2.0 PRD (NeMo Retriever Library). It already matched the PRD’s naming and positioning; two small fixes were made so it fully conforms.

Fixes Applied

Python package name (PRD: nemo_retriever):
- Was: “installs the nemoretriever Python package”
- Now: “installs the nemo_retriever Python package”
- PRD specifies the Python import as nemo_retriever (lowercase, underscore).
Typo in file extension:
- Was: “used for .txt ingestion” (with a trailing space)
- Now: “used for .txt ingestion”

What Already Matched the PRD

Product name: “NeMo Retriever Library” (title case, space‑separated) used consistently.
GitHub repo: NVIDIA/NeMo-Retriever referenced correctly.
PyPI: nemo-retriever (lowercase, hyphenated) in install commands.
Python: nemo_retriever in paths and module references (aside from the one nemoretriever fix).
No legacy names: no nv-ingest, nv_ingest, or abbreviations like nr / nemo-ret.
Hyphens vs underscores: external identifiers use hyphens (nemo-retriever); Python/internal use underscores (nemo_retriever).
Scope: library‑first install, Ray, NIM, HuggingFace, PDF/HTML/text/audio, LanceDB, and the benchmark harness all reflected as in the PRD.

Optional Follow-up

Benchmark CLI naming: the PRD says the benchmark CLI is nemo-retriever-bench, while the README currently documents retriever harness (for example, retriever harness run).
- If the shipped command is actually nemo-retriever-bench, add a short note or adjustment in the benchmark section.
- If retriever harness is the correct, shipped interface, the README is fine as‑is.

A short conformance report was saved at docs/README_PRD_Conformance.md for reference and for inclusion in the PR if desired.

Files Changed

nemo_retriever/README.md

Reference

NVIDIA Style Guide (April 2025): Voice and Tone, Links, Abbreviations and Acronyms, Latinisms, Formatting, Technical Content.
Ingest 2.0 PRD (NeMo Retriever Library): naming, positioning, and scope.

…-ingest into kheiss/readme-quickstart

kheiss-uwzoo

changed title and opening paragraph

Changed opening paragraph to be more specific

kheiss-uwzoo

updated opening

sosahi · 2026-03-05T20:14:52Z

nemo_retriever/README.md

-## Prerequisites
+This quick start guide shows how to run NeMo Retriever in **library mode**, directly from your application, without Docker. In library mode, NeMo Retriever Library supports two deployment options:
+- Load Hugging Face models locally on your GPU.
+- Use locally deployed NeMo Retriever NIM endpoints for embedding and OCR.


it's not just for embedding and OCR. It includes all the NIMs (page-elements, OCR, embedding, by default, and graphic-elements and table-structure optionally)
@edknv and @ChrisJar to confirm this statement.

nemo_retriever/README.md

nkmcalli · 2026-03-06T03:00:56Z

nemo_retriever/README.md

-This installs the retriever in editable mode and its in-repo dependencies. Core dependencies (see `nemo_retriever/pyproject.toml`) include Ray, pypdfium2, pandas, LanceDB, PyYAML, torch, transformers, and the Nemotron packages (page-elements, graphic-elements, table-structure). The retriever also depends on the sibling packages `nv-ingest`, `nv-ingest-api`, and `nv-ingest-client` in this repo.

-### OCR and CUDA 13 runtime
+## 2. Create and activate the NeMo Retriever Library environment


Numbered steps don't go in headings. Remove the number from the heading, or remove the heading.

Updated document based on your comments

nemo_retriever/README.md

nkmcalli · 2026-03-06T03:07:38Z

nemo_retriever/README.md

+- `run.runtime.summary.json`: run totals (input files, pages, elapsed seconds)  
+- `run.ray.timeline.json`: detailed Ray execution timeline  
+- `run.rd_dataset.stats.txt`: Ray dataset stats dump  


Correct format: Change code formatting to bold, change colons to dash (Alt+0150)

nkmcalli · 2026-03-06T03:08:08Z

nemo_retriever/README.md

+- `bo20`: ~9.0 MiB total, ~8.6 MiB LanceDB  
+- `jp20`: ~36.8 MiB total, ~36.2 MiB LanceDB  


Fix formatting

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

updated per Nicole's review

Fixed formatting per Nicole's review

Updated formatting per Nicole's review

changed from step to procedure

kheiss-uwzoo

updated per Nicole review comments

kheiss-uwzoo · 2026-03-06T16:04:25Z

nemo_retriever/README.md

-This installs the retriever in editable mode and its in-repo dependencies. Core dependencies (see `nemo_retriever/pyproject.toml`) include Ray, pypdfium2, pandas, LanceDB, PyYAML, torch, transformers, and the Nemotron packages (page-elements, graphic-elements, table-structure). The retriever also depends on the sibling packages `nv-ingest`, `nv-ingest-api`, and `nv-ingest-client` in this repo.

-### OCR and CUDA 13 runtime
+## 2. Create and activate the NeMo Retriever Library environment


Updated document based on your comments

removed Library Mode

kheiss-uwzoo added 18 commits February 19, 2026 10:36

Update PDF blueprint architecture diagram

cd3c368

Merge remote-tracking branch 'upstream/main'

70b5a80

Merge remote-tracking branch 'upstream/main'

7f0248c

Merge remote-tracking branch 'upstream/main'

0dd5f1b

Merge remote-tracking branch 'upstream/main'

dea2770

Merge remote-tracking branch 'upstream/main'

3ff2f1f

Merge remote-tracking branch 'upstream/main'

a886244

Merge remote-tracking branch 'upstream/main'

b44f7ad

Merge remote-tracking branch 'upstream/main'

addf637

Merge remote-tracking branch 'upstream/main'

5900322

Merge remote-tracking branch 'upstream/main'

d12df70

updating README

ca31df9

Updated README.md quick start guide

c2add7d

Delete README.md

838a5e3

file update

44cdd0b

update file

ec33abf

Merge branch 'kheiss/readme-quickstart' of github.com:kheiss-uwzoo/nv…

fd8680a

…-ingest into kheiss/readme-quickstart

Merge branch 'main' into kheiss/readme-quickstart

03592e9

kheiss-uwzoo added the doc Improvements or additions to documentation label Mar 5, 2026

kheiss-uwzoo requested review from jdye64, nkmcalli, randerzander and sosahi March 5, 2026 17:46

Update README.md

10cc850

kheiss-uwzoo commented Mar 5, 2026

View reviewed changes

Merge branch 'main' into kheiss/readme-quickstart

de6a180

kheiss-uwzoo marked this pull request as ready for review March 5, 2026 20:05

kheiss-uwzoo requested a review from a team as a code owner March 5, 2026 20:05

Update README.md

e0140c6

Changed opening paragraph to be more specific

kheiss-uwzoo commented Mar 5, 2026

View reviewed changes

sosahi reviewed Mar 5, 2026

View reviewed changes

nkmcalli requested changes Mar 6, 2026

View reviewed changes

kheiss-uwzoo and others added 11 commits March 6, 2026 07:11

Update nemo_retriever/README.md

07950df

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update nemo_retriever/README.md

147bb43

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update nemo_retriever/README.md

627463f

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update nemo_retriever/README.md

1320b9e

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update nemo_retriever/README.md

a3ae67b

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update nemo_retriever/README.md

da4d5dc

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update nemo_retriever/README.md

827f701

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

Update README.md

037aacb

updated per Nicole's review

Update README.md

4c3aa67

Fixed formatting per Nicole's review

Update README.md

c3976f7

Updated formatting per Nicole's review

Update README.md

6073283

changed from step to procedure

kheiss-uwzoo commented Mar 6, 2026

View reviewed changes

kheiss-uwzoo requested a review from nkmcalli March 6, 2026 16:23

Merge branch 'main' into kheiss/readme-quickstart

90ca0b2

kheiss-uwzoo requested a review from janishaa-beep March 6, 2026 20:06

Update README.md

6f1e734

removed Library Mode

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Kheiss/readme quickstart#1492

Kheiss/readme quickstart#1492
kheiss-uwzoo wants to merge 34 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/readme-quickstart

kheiss-uwzoo commented Mar 5, 2026 •

edited

Loading

Uh oh!

kheiss-uwzoo left a comment

Uh oh!

kheiss-uwzoo left a comment

Uh oh!

sosahi Mar 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nkmcalli Mar 6, 2026

Uh oh!

kheiss-uwzoo Mar 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nkmcalli Mar 6, 2026

Uh oh!

nkmcalli Mar 6, 2026

Uh oh!

kheiss-uwzoo left a comment

Uh oh!

kheiss-uwzoo Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		- `bo20`: ~9.0 MiB total, ~8.6 MiB LanceDB
		- `jp20`: ~36.8 MiB total, ~36.2 MiB LanceDB

Conversation

kheiss-uwzoo commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Summary: NeMo Retriever README — NVIDIA Style Guide and PRD Alignment

Overview

Changes

Voice and Tone (PACE)

Acronyms and First Use

Links

Formatting and Structure

PRD Conformance

Fixes Applied

What Already Matched the PRD

Optional Follow-up

Files Changed

Reference

Uh oh!

kheiss-uwzoo left a comment

Choose a reason for hiding this comment

Uh oh!

kheiss-uwzoo left a comment

Choose a reason for hiding this comment

Uh oh!

sosahi Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nkmcalli Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

kheiss-uwzoo Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nkmcalli Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

nkmcalli Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

kheiss-uwzoo left a comment

Choose a reason for hiding this comment

Uh oh!

kheiss-uwzoo Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kheiss-uwzoo commented Mar 5, 2026 •

edited

Loading