Skip to content

docs(26.05): extraction reconcile updates scoped to 26.5.0 behavior#2313

Merged
kheiss-uwzoo merged 6 commits into
NVIDIA:26.05from
kheiss-uwzoo:docs/pr2311-kurt-extraction-reconcile
Jul 8, 2026
Merged

docs(26.05): extraction reconcile updates scoped to 26.5.0 behavior#2313
kheiss-uwzoo merged 6 commits into
NVIDIA:26.05from
kheiss-uwzoo:docs/pr2311-kurt-extraction-reconcile

Conversation

@kheiss-uwzoo

@kheiss-uwzoo kheiss-uwzoo commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

Cherry-picks June–July documentation bug fixes from main onto 26.05, scoped to 26.5.0 behavior only. Does not port main-only information architecture (new pages, nav renumbering, page consolidation, module-path reorg, or blob/main link retargeting).

Prior commits that attempted to align extraction docs byte-for-byte with main were reverted in cb23e1d9. The PR now restores the 26.05 release doc surface (custom-metadata.md, integrations-langchain-llamaindex-haystack.md, nimclient.md, 26.05 module paths, blob/26.05 chart links) and applies only vetted doc corrections.

Net scope vs upstream/26.05: 4 files, +33 / -17 lines. Docs-only — no .py, test, or chart changes.

File changes (vs upstream/26.05)

File What changed Why (26.5.0)
faq.md Chart caption FAQ links to multimodal-extraction.md; Nemotron Parse FAQ notes chart modality requires pdfium layout path NVBugs 6365988 — extract_method=nemotron_parse does not emit chart/infographic modality rows
multimodal-extraction.md Admonition: chart modality requires default pdfium path; Nemotron Parse note; caption scope prose for chart-classified PDF regions Same — accurate extraction/retrieval guidance for 26.05 pipeline
prerequisites-support-matrix.md H200 NVL marked not supported for self-hosted Parakeet ASR; RTX PRO 4500 marked supported for Nemotron Parse (dedicated GPU + disk); footnote ⁴ updated NVBugs 6261554, 6195537 — hardware matrix matches 26.05 release
troubleshoot.md OOM section: replace stale save_to_disk guidance with supported batching, output sinks, and return_results=False NVBugs 6187338, 6262715 — matches 26.05 API surface

Intentionally not in this PR (main-only or already on 26.05)

Item Reason
Delete custom-metadata.md, add customize-extend.md / starter-kits.md Main IA — pages ship in 26.05 release
nemo_retriever.common.params / graph.retriever module paths Main code reorg — 26.05 uses params and retriever
MCP workflow (/mcp, mcp-stdio, ingest_documents) Not shipped in 26.05 — 26.05 baseline already correct
Helm OCR v2 / blob/main chart links Main chart default — 26.05 chart defaults OCR v1
OpenShift nav link (helm/openshift.md) File does not exist on 26.05 branch
mkdocstrings path fix (#2234) Main reorg only
Broken-link fixes (#2226), stale tag cleanup (#2256) Already present on upstream/26.05

26.05 release alignment

Topic Documented behavior
Agentic MCP Not shipped — 26.05 baseline unchanged (no MCP section added)
Helm OCR v1 nemotron-ocr-v1:1.3.0 under nimOperator.ocr (unchanged on 26.05)
Chart modality Requires default pdfium layout path; not available on nemotron_parse
Parakeet ASR Not supported on B200, Blackwell, or H200 NVL
Nemotron Parse Supported on RTX PRO 4500 (dedicated GPU)

Self-review

  • Docs-only PR scope (docs/docs/extraction/** only — no mkdocs.yml, no .py)
  • Net diff vs upstream/26.05 is 4 Markdown files only
  • 26.05 release pages preserved (custom-metadata.md, integrations, nimclient.md)
  • No main-only module paths or blob/main link retargeting
  • Chart modality, hardware matrix, and OOM guidance match 26.5.0 behavior

Test plan

  • Pre-commit hooks passed on cb23e1d9
  • git diff upstream/26.05...HEAD --name-only — 4 doc files, no .py
  • CI: Retriever Unit Tests should pass (custom-metadata.md restored; test expects this page on 26.05)
  • CI: Docker amd64 build — pre-existing base-branch dependency issue (llvmlite/Python 3.12), unrelated to docs

Port Kurt-owned extraction workflow, API reference, support matrix, and nav/IA reconcile changes from PR 2311 onto 26.05. Includes the Greptile fixes for ASRParams and mkdocstrings module paths.
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners July 7, 2026 23:02
@kheiss-uwzoo kheiss-uwzoo requested review from charlesbluca and removed request for a team July 7, 2026 23:02
@greptile-apps

greptile-apps Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates the 26.05 extraction documentation. The main changes are:

  • Clarified Nemotron Parse and chart modality guidance.
  • Updated image captioning scope for chart and infographic regions.
  • Adjusted GPU support notes for Parakeet ASR and Nemotron Parse.
  • Reworked OOM troubleshooting guidance for batching, sinks, and service responses.

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed documentation.

Important Files Changed

Filename Overview
docs/docs/extraction/faq.md Clarifies FAQ guidance for Nemotron Parse and chart-filtered retrieval.
docs/docs/extraction/multimodal-extraction.md Adds chart modality and captioning scope details for the multimodal extraction page.
docs/docs/extraction/prerequisites-support-matrix.md Updates GPU support rows and notes for audio/video extraction and Nemotron Parse.
docs/docs/extraction/troubleshoot.md Updates OOM troubleshooting with batching, sink routing, and service response options.

Reviews (6): Last reviewed commit: "docs(26.05): scope extraction docs to 26..." | Re-trigger Greptile

Comment thread docs/docs/extraction/workflow-agentic-retrieval.md Outdated
Comment thread docs/docs/extraction/prerequisites-support-matrix.md Outdated
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jul 7, 2026
@kheiss-uwzoo kheiss-uwzoo added doc Improvements or additions to documentation 26.05 labels Jul 7, 2026
Address PR 2313 review: remove the inaccurate MCP section from workflow-agentic-retrieval (no /mcp, mcp-stdio, or ingest_documents on the 26.05 retriever service) and document the supported Python API + VDB retrieval orchestration path instead. Correct support matrix OCR references to match the chart default (nemotron-ocr-v1:1.3.0), not v2.
Match main with no exceptions per review directive. Reverts the 26.05-only deltas so the PR-touched docs are identical to main: restore MCP agentic section, OCR v2 references in the support matrix, and the main module paths in audio-video and the API reference (mkdocstrings + ASRParams import).
Comment thread docs/docs/extraction/workflow-agentic-retrieval.md Outdated
Comment thread docs/docs/extraction/prerequisites-support-matrix.md Outdated
26.05 retriever service does not expose /mcp, mcp-stdio, or ingest_documents. Document the supported Python API, VDB retrieval, and starter-kit orchestration path instead.
Comment thread docs/docs/extraction/prerequisites-support-matrix.md Outdated
Align nimOperator.ocr with the 26.05 chart default (nemotron-ocr-v1:1.3.0). Keep local Hugging Face OCR v2 paragraph unchanged.
@kheiss-uwzoo kheiss-uwzoo changed the title docs(26.05): split Kurt extraction reconcile updates docs(26.05): extraction reconcile updates scoped to 26.5.0 behavior Jul 8, 2026
Revert main-only information-architecture and code-path churn that did not
apply to the 26.05 release (restored custom-metadata, integrations, and
nimclient pages; dropped main-only customize-extend and starter-kits pages;
reverted nemo_retriever.common.params / graph.retriever module paths and
blob/main link retargeting back to the 26.05 surface).

Re-apply only genuine June-July documentation fixes valid for 26.5.0:
- faq.md, multimodal-extraction.md: chart modality requires the default
  pdfium layout path; nemotron_parse does not emit chart/infographic rows
- prerequisites-support-matrix.md: H200 NVL unsupported for self-hosted
  Parakeet ASR; nemotron-parse supported on RTX PRO 4500
- troubleshoot.md: replace stale save_to_disk OOM guidance with supported
  batching / output-sink / return_results guidance

Docs-only; no runtime, test, or chart changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

26.05 doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants