Skip to content

docs: OCR v2 polish on multimodal-extraction (Helm/local HF)#2259

Open
kheiss-uwzoo wants to merge 6 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/ocr-v2-defaults
Open

docs: OCR v2 polish on multimodal-extraction (Helm/local HF)#2259
kheiss-uwzoo wants to merge 6 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/ocr-v2-defaults

Conversation

@kheiss-uwzoo

@kheiss-uwzoo kheiss-uwzoo commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

Docs-only polish for multimodal-extraction.md: scannable Helm / NVCF hosted / local Hugging Face OCR v2 guidance and a clearer chart/captioning note.

Merge after #2295. Hosted-default docs assume CPU actors default to nemotron-ocr-v2 on build.nvidia.com once that eng PR lands.

Does not change releasenotes.md. The 26.05 section correctly records what 26.5.0 shipped (HF v2, Helm v1); #2239 merged after that release.

Changes

  • multimodal-extraction.md: Split OCR deployment guidance (Helm / NVCF hosted / local HF); chart pdfium-path callout preserved from main; Omni caption routing note

PR scope check

  • Base: main
  • Files changed: 1 — docs/docs/extraction/multimodal-extraction.md
  • Red flags: none

Test plan

@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 22, 2026 18:11
@kheiss-uwzoo kheiss-uwzoo requested a review from drobison00 June 22, 2026 18:11
@greptile-apps

greptile-apps Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Documentation-only polish for multimodal-extraction.md that splits the OCR deployment section into three scannable sub-entries (Helm/NIM, NVCF hosted, local Hugging Face) and clarifies that chart-labeled PDF regions bypass the Omni caption stage.

  • OCR section restructured: Single paragraph replaced by three bold-headed deployment variants; the new anchor link to prerequisites-support-matrix.md#nemotron-ocr-v2-language-mode resolves correctly to the existing "OCR artifacts (Helm vs local Hugging Face)" section.
  • Chart/captioning note tightened: Explicit statement added that chart-labeled regions remain on the layout-and-OCR path and are not routed through the Omni caption stage.
  • Merge dependency: The NVCF default-endpoint claim (line 81) describes behavior that lands in PR feat: switch hosted OCR CPU actor defaults to Nemotron OCR v2 #2295; the PR description acknowledges this ordering requirement, but there is no enforcement mechanism preventing an out-of-order merge.

Confidence Score: 4/5

Safe to merge only after PR #2295 lands; merging in isolation publishes the NVCF default-endpoint description before the backing code change exists.

The single changed file is documentation. Every internal anchor and cross-reference validates. One section — the NVCF hosted-default claim — documents behavior that the current codebase does not yet implement; the CPU actor sets the OCR URL to an empty string when ocr_invoke_url is omitted, so remote OCR does not fire. The PR description explicitly states this PR must follow #2295, but nothing in the merge process enforces that ordering.

docs/docs/extraction/multimodal-extraction.md — specifically the NVCF hosted-inference paragraph (line 81) which describes a default that does not exist in the current codebase.

Important Files Changed

Filename Overview
docs/docs/extraction/multimodal-extraction.md Documentation polish splitting OCR guidance into Helm/NIM, NVCF hosted, and local HF sections; anchor link to prerequisites-support-matrix.md validates correctly, but the NVCF default claim documents future behavior contingent on PR #2295 merging first.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[OCR / Scanned Document] --> B{Deployment mode?}
    B -->|Helm / NIM| C[Nemotron OCR v2 NIM\nnvcr.io/nim/nvidia/nemotron-ocr-v2:1.4.0]
    B -->|NVCF hosted\nno ocr_invoke_url set| D[build.nvidia.com\nNemotron OCR v2 endpoint\n⚠ requires PR 2295]
    B -->|Local Hugging Face| E[Nemotron OCR v2\nmultilingual mode]
    C --> F[OCR Artifacts]
    D --> F
    E --> F
    G[Chart-labeled PDF region] -->|NOT routed| H[Omni Caption Stage]
    G -->|stays on| I[Layout-and-OCR path]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[OCR / Scanned Document] --> B{Deployment mode?}
    B -->|Helm / NIM| C[Nemotron OCR v2 NIM\nnvcr.io/nim/nvidia/nemotron-ocr-v2:1.4.0]
    B -->|NVCF hosted\nno ocr_invoke_url set| D[build.nvidia.com\nNemotron OCR v2 endpoint\n⚠ requires PR 2295]
    B -->|Local Hugging Face| E[Nemotron OCR v2\nmultilingual mode]
    C --> F[OCR Artifacts]
    D --> F
    E --> F
    G[Chart-labeled PDF region] -->|NOT routed| H[Omni Caption Stage]
    G -->|stays on| I[Layout-and-OCR path]
Loading

Reviews (10): Last reviewed commit: "docs: add NVCF hosted OCR v2 default to ..." | Re-trigger Greptile

Comment thread nemo_retriever/tests/test_video_frame_ocr_actor.py Outdated
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Jun 22, 2026
Address PR review: main branch Helm chart defaults to Nemotron OCR v2
(nemotron-ocr-v2:1.4.0). Broader OCR doc and chart updates are in NVIDIA#2259.
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Jun 22, 2026
Address PR NVIDIA#2166 review: main branch Helm chart defaults to Nemotron OCR v2
(nemotron-ocr-v2:1.4.0). Remaining OCR documentation and chart code in NVIDIA#2259.
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 22, 2026
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jun 22, 2026
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 22, 2026 21:15
@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review June 24, 2026 16:43
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 24, 2026 16:49
@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review June 24, 2026 22:05
@kheiss-uwzoo kheiss-uwzoo force-pushed the docs/ocr-v2-defaults branch from a4d075d to 56819c7 Compare June 24, 2026 22:11
@kheiss-uwzoo kheiss-uwzoo changed the title Switch default OCR from v1 to v2 on main Complete OCR v2 sweep: hosted defaults, release notes, and doc polish Jun 24, 2026
After NVIDIA#2239, Nemotron OCR v2 is the Helm NIM default; update the 26.05
release notes so they no longer state v1 is the chart default.
Link Helm defaults to the chart README instead of pinning nvcr.io inline,
and use refer-to CTAs per NRL style rules.
Split multimodal-extraction OCR deployment guidance for scannability,
add hosted-remote default note, and fix Hugging Face spelling in release notes.
Replace via with with/through per NVIDIA style guide and fix double
space before reference answer generation.
@kheiss-uwzoo kheiss-uwzoo force-pushed the docs/ocr-v2-defaults branch from 9e26e17 to ef10bfc Compare July 2, 2026 17:02
@kheiss-uwzoo kheiss-uwzoo changed the title Complete OCR v2 sweep: hosted defaults, release notes, and doc polish docs: OCR v2 release notes and multimodal-extraction polish (Helm/local HF) Jul 2, 2026
Comment thread docs/docs/extraction/releasenotes.md Outdated
- Nemotron OCR v2 is the default OCR engine for HuggingFace, with CLI language selectors and unified OCR actors. For Helm NIM deployments, Nemotron OCR v1 is the default.
- Nemotron Parse is available as an alternate PDF extraction method (v1.2 HTTP interface; optional Helm NIM; local inference via vLLM where configured)
- VLM image captioning via vLLM (including Omni caption model profiles) addresses the capability deferred in 26.03
- Nemotron OCR v2 is the default OCR engine for Hugging Face and Helm NIM deployments, with CLI language selectors and unified OCR actors.

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.

Should this live in a new release notes section? As-is, this would be changing the description of OCR defaults for 26.5.0, but #2239 didn't land until after this release

NVIDIA#2239 merged after 26.5.0, so the 26.05 release notes must keep the
historical HF v2 / Helm v1 split. Helm v2 current-state docs stay in
multimodal-extraction.md only.
@kheiss-uwzoo kheiss-uwzoo changed the title docs: OCR v2 release notes and multimodal-extraction polish (Helm/local HF) docs: OCR v2 polish on multimodal-extraction (Helm/local HF) Jul 2, 2026
Documents hosted CPU actor defaults after NVIDIA#2295 lands. Merge NVIDIA#2295
before this PR per eng review.
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