Skip to content

26.05 NeMo Retriever Library release notes#2065

Merged
kheiss-uwzoo merged 17 commits into
NVIDIA:mainfrom
kheiss-uwzoo:kheiss/26.05RNs
May 29, 2026
Merged

26.05 NeMo Retriever Library release notes#2065
kheiss-uwzoo merged 17 commits into
NVIDIA:mainfrom
kheiss-uwzoo:kheiss/26.05RNs

Conversation

@kheiss-uwzoo
Copy link
Copy Markdown
Collaborator

@kheiss-uwzoo kheiss-uwzoo commented May 19, 2026

Summary

Adds docs/docs/extraction/releasenotes.md as the published 26.05 release notes page for NeMo Retriever Library (26.5.0). The page documents what changed since 26.03 and follows the same presentation pattern as prior extraction release notes (intro, Helm upgrade link, highlights list).

26.03 release content is not duplicated on this page; readers are directed to the published 26.03 release notes via Release Notes for Previous Versions.

What's in the doc

  • 26.05 overview — graph-based ingest, Retriever Service v2, VLM captioning (26.03 deferral), Helm-first documentation story
  • Upgrade notes.extract(split_config=...), grouped Retriever(...) kwargs (vdb_kwargs, embed_kwargs, rerank), Helm service.installFfmpeg, Python 3.12
  • Discoverable highlight subsections — pipeline, CLI (supported vs experimental subcommands), service/deployment, models/OCR/captioning, multimodal, RAG, vector DB, evaluation, text-to-SQL/tabular, packaging, Helm, documentation
  • Navigation — previous-versions table (26.03 → 24.12.0) and related-topic links to prerequisites, deployment options, and Helm charts

Scope

Path Change
docs/docs/extraction/releasenotes.md New / updated 26.05 release notes only

No product code, Helm values, or workflow changes.

Test plan

  • MkDocs build includes releasenotes.md in the extraction nav without broken internal links (overview.md, deployment-options.md, prerequisites-support-matrix.md)
  • Release Notes for Previous Versions — 26.03 link resolves on the published 26.3.0 doc set
  • Spot-check Upgrade notes against nemo_retriever API (constructor kwargs, split_config, Python requires-python)
  • Doc preview: subsection headings render in the page TOC

@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners May 19, 2026 18:11
@kheiss-uwzoo kheiss-uwzoo requested a review from drobison00 May 19, 2026 18:11
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label May 19, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 19, 2026

Greptile Summary

This PR replaces the 26.03 body on releasenotes.md with full 26.05 content covering graph-based ingest, Retriever Service v2, VLM captioning, CLI support boundaries, and a Helm-first documentation story, while moving 26.03 to the previous-versions table.

  • The 26.03 release body is removed in favour of a structured set of ### subsections documenting 26.05 highlights, upgrade notes, and packaging changes.
  • The "Release Notes for Previous Versions" table and the Related Topics Helm link are both updated to point at versioned 26.3.0 and branch-pinned 26.05 URLs respectively.
  • One ### section heading is missing before the text-to-SQL/tabular bullet, which orphans that content from the page TOC.

Confidence Score: 4/5

Safe to merge after adding the missing section heading; no product code is touched.

The text-to-SQL/tabular bullet is structurally orphaned — no ### heading precedes it, so it falls outside any named section and is absent from the page TOC, directly contradicting the PR's goal of discoverable subsection headings. Everything else (previous-versions URLs, upgrade notes, Helm link) looks correct and consistent with prior release pages.

docs/docs/extraction/releasenotes.md — the orphaned text-to-SQL bullet between ### Evaluation and ### Packaging and platform.

Important Files Changed

Filename Overview
docs/docs/extraction/releasenotes.md 26.05 release notes added with subsection structure; one subsection heading missing before the text-to-SQL/tabular bullet, leaving it orphaned outside any named section.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[releasenotes.md] --> B["## 26.05 Release Notes (26.5.0)"]
    B --> C["### Upgrade notes"]
    B --> D["### Pipeline and ingestion"]
    B --> E["### CLI"]
    B --> F["### Retriever Service and deployment"]
    B --> G["### Models, OCR, and captioning"]
    B --> H["### Multimodal extraction"]
    B --> I["### Retrieval and RAG"]
    B --> J["### Vector database"]
    B --> K["### Evaluation"]
    B --> L["⚠️ ORPHANED BULLET — missing ### heading\n(Text-to-SQL and tabular)"]
    B --> M["### Packaging and platform"]
    B --> N["### Helm chart"]
    B --> O["### Documentation"]
    A --> P["## Release Notes for Previous Versions"]
    P --> Q["26.03 → 26.3.0 versioned URL ✓"]
    A --> R["## Related Topics"]
    R --> S["Helm Charts → pinned 26.05 branch ✓"]
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/docs/extraction/releasenotes.md:60-63
Missing section heading for text-to-SQL/tabular content — the bullet on line 63 is orphaned. Every other content category in this release has a `###` subsection heading, and the PR description explicitly lists "text-to-SQL/tabular" as a discoverable highlight subsection. Without the heading, this item falls visually under `### Evaluation` (separated only by a blank line), the page TOC omits it entirely, and readers scanning subsection headers cannot discover the text-to-SQL capabilities.

```suggestion
- BEIR-centric evaluation overhaul and `retriever skill-eval` benchmark CLI for the NeMo Retriever skill (experimental)  

### Text-to-SQL and tabular

- Text-to-SQL agent graph and tabular tooling for structured data retrieval, including tabular data ingestion  
```

Reviews (8): Last reviewed commit: "Update docs/docs/extraction/releasenotes..." | Re-trigger Greptile

Comment thread docs/docs/extraction/releasenotes.md Outdated
Comment thread docs/docs/extraction/releasenotes.md
Comment thread docs/docs/extraction/releasenotes.md Outdated
Expand releasenotes with categorized 26.05 changes, migration notes,
RC install guidance, and inline 26.03 section grounded in the 302-commit
compare between release branches.
Comment thread docs/docs/extraction/releasenotes.md Outdated
- Documentation: multimodal extraction is covered on one page with an in-page table of contents and redirects from the former per-topic URLs
- NeMo Retriever Library currently does not support image captioning via VLM; this feature was added in 26.05
- Documentation: multimodal extraction is covered on one page with an in-page table of contents and redirects from the former per-topic URLs
- Container images built from this repository no longer install `ffmpeg` and `ffprobe` by default. Audio and video extraction require these binaries on `PATH`; for Helm deployments set `service.installFfmpeg=true`, or install system FFmpeg manually in non-container environments.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 FFmpeg removal attributed to the wrong release

The added bullet — "Container images built from this repository no longer install ffmpeg/ffprobe by default" — describes a 26.05 breaking change (it appears verbatim in the 26.05 "Breaking changes and migration" section on line 29). Placing it in the 26.03 notes implies the removal happened in 26.03. A user running 26.03 who reads this could spend time debugging phantom audio/video failures that won't exist until they upgrade to 26.05, or conclude the 26.03 build is broken when it isn't. Since this is a 26.05 change, remove the bullet from the 26.03 section (the 26.05 breaking-changes section already documents it completely).

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/docs/extraction/releasenotes.md
Line: 175

Comment:
**FFmpeg removal attributed to the wrong release**

The added bullet — "Container images built from this repository no longer install `ffmpeg`/`ffprobe` by default" — describes a **26.05 breaking change** (it appears verbatim in the 26.05 "Breaking changes and migration" section on line 29). Placing it in the 26.03 notes implies the removal happened in 26.03. A user running 26.03 who reads this could spend time debugging phantom audio/video failures that won't exist until they upgrade to 26.05, or conclude the 26.03 build is broken when it isn't. Since this is a 26.05 change, remove the bullet from the 26.03 section (the 26.05 breaking-changes section already documents it completely).

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

Clarify supported vs experimental retriever subcommands per CLI README,
and narrow chunking migration to graph/library ingest (service .split() may remain).
Use intro + Helm link + flat Highlights list with nested sub-bullets
instead of categorized H3 sections and bold label prefixes.
@kheiss-uwzoo kheiss-uwzoo changed the title 26.05 Release Notes 26.05 NeMo Retriever Library release notes May 28, 2026
Resolve releasenotes.md conflict: keep 26.05 release notes and archive 26.03 via Previous Versions link; apply Greptile installFfmpeg YAML fix.
Comment thread docs/docs/extraction/releasenotes.md Outdated
Comment thread docs/docs/extraction/releasenotes.md Outdated
Comment thread docs/docs/extraction/releasenotes.md Outdated
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
kheiss-uwzoo and others added 2 commits May 29, 2026 11:14
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
Comment on lines +60 to +63
- BEIR-centric evaluation overhaul and `retriever skill-eval` benchmark CLI for the NeMo Retriever skill (experimental)


- Text-to-SQL agent graph and tabular tooling for structured data retrieval, including tabular data ingestion
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Missing section heading for text-to-SQL/tabular content — the bullet on line 63 is orphaned. Every other content category in this release has a ### subsection heading, and the PR description explicitly lists "text-to-SQL/tabular" as a discoverable highlight subsection. Without the heading, this item falls visually under ### Evaluation (separated only by a blank line), the page TOC omits it entirely, and readers scanning subsection headers cannot discover the text-to-SQL capabilities.

Suggested change
- BEIR-centric evaluation overhaul and `retriever skill-eval` benchmark CLI for the NeMo Retriever skill (experimental)
- Text-to-SQL agent graph and tabular tooling for structured data retrieval, including tabular data ingestion
- BEIR-centric evaluation overhaul and `retriever skill-eval` benchmark CLI for the NeMo Retriever skill (experimental)
### Text-to-SQL and tabular
- Text-to-SQL agent graph and tabular tooling for structured data retrieval, including tabular data ingestion
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/docs/extraction/releasenotes.md
Line: 60-63

Comment:
Missing section heading for text-to-SQL/tabular content — the bullet on line 63 is orphaned. Every other content category in this release has a `###` subsection heading, and the PR description explicitly lists "text-to-SQL/tabular" as a discoverable highlight subsection. Without the heading, this item falls visually under `### Evaluation` (separated only by a blank line), the page TOC omits it entirely, and readers scanning subsection headers cannot discover the text-to-SQL capabilities.

```suggestion
- BEIR-centric evaluation overhaul and `retriever skill-eval` benchmark CLI for the NeMo Retriever skill (experimental)  

### Text-to-SQL and tabular

- Text-to-SQL agent graph and tabular tooling for structured data retrieval, including tabular data ingestion  
```

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

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@kheiss-uwzoo kheiss-uwzoo merged commit 7fe75de into NVIDIA:main May 29, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants