docs(extraction): H200 support matrix + section anchors and API crosslinks (NVBugs 6261554)#2257
Conversation
Rename the Helm README minimal-install section, keep a legacy #recommended-minimal-install-2605 alias, point extraction docs at blob/main, and use version-neutral prose in chart default notes.
Keep PR NVIDIA#2243 scoped to minimal-install de-versioning only; the support matrix anchor was not renamed on main.
Add stable { #anchor } IDs and an on-page TOC to heavily linked extraction
docs so cross-page fragments survive heading edits and match vdbs.md style.
Add same-section links to nemo-retriever-api-reference.md on extraction pages where python fences lacked an adjacent API guide crosslink.
Published NRL docs target the 26.05 train; keep (26.05) labels and 26.05-pinned Helm URLs while section anchors and API crosslinks remain.
Apply refer-to link CTAs, route ffmpeg guidance to audio-video.md, and clear NRL doc-leakage violations on extraction pages touched by NVIDIA#2257.
Drop the self-referential overview Related Topics entry and route prerequisites/deployment crosslinks to getting-started-about.md and deployment-options.md instead.
Resolve conflicts: keep H200 NVL matrix updates and section anchors; accept main OCR v2, starter-kits rename, custom-metadata removal, and answer_llm Helm README rows.
…A#2257) Deduplicate deployment-options bullets in getting-started-about and align concepts.md with refer-to API guide CTA after ::p/::r pass.
Greptile SummaryDocumentation-only update to the NeMo Retriever extraction docs, combining a support-matrix fix (NVBugs 6261554) with anchor/crosslink hygiene across 11 files. No runtime, Helm, or Python code changes are included.
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/prerequisites-support-matrix.md | Core change: H200 NVL Parakeet rows flipped from 1¹ to Not supported⁴; intro callout and footnote ⁴ updated consistently; three new section anchors added. |
| docs/docs/extraction/deployment-options.md | Two section anchors added; circular docs.nvidia.com link replaced with local getting-started-about.md reference in two places. |
| docs/docs/extraction/concepts.md | Five section anchors added to top-level headings; API guide crosslink phrasing standardized to "For parameter details, refer to". |
| docs/docs/extraction/embedding.md | API guide crosslink moved from page intro and duplicated before each of the three Python code snippet blocks for closer proximity. |
| docs/docs/extraction/nimclient.md | Three API guide crosslinks added before Custom NIMs, Real-World Examples, and UDFs sections; no structural changes. |
| docs/docs/extraction/audio-video.md | API guide crosslink inserted before hosted-inference Python snippet; no other changes. |
| docs/docs/extraction/nemo-retriever-api-reference.md | Stable anchor added to PDF pre-split heading (referenced from concepts.md); "See" changed to "Refer to" per style standardization. |
| docs/docs/extraction/workflow-document-ingestion.md | Two section anchors added to Ingest and extract and Choose how you call the library headings. |
| docs/docs/extraction/getting-started-about.md | Circular docs.nvidia.com link replaced with cleaner description; deploy step description tightened. |
| docs/docs/extraction/overview.md | Circular docs.nvidia.com self-link removed from Related links section. |
| docs/docs/extraction/troubleshoot.md | Circular docs.nvidia.com link replaced with local getting-started-about.md reference in the Related links footer. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["prerequisites-support-matrix.md\n(H200 NVL: Not supported⁴ for Parakeet ASR)"] -->|"crosslinks via #model-hardware-requirements\n#core-and-advanced-pipeline-features\n#related-topics"| A
A -->|"audio-video.md anchor"| B["audio-video.md\n(#parakeet-hosted-inference-build-nvidia)"]
B -->|"API guide crosslink"| C["nemo-retriever-api-reference.md\n(#pdf-pre-splitting-for-parallel-ingest)"]
D["embedding.md\nnimclient.md"] -->|"API guide crosslinks\n(near Python snippets)"| C
E["deployment-options.md\noverview.md\ntroubleshoot.md\ngetting-started-about.md"] -->|"circular docs.nvidia.com links removed\nreplaced with local relative links"| F["getting-started-about.md\ndeployment-options.md"]
G["concepts.md\nworkflow-document-ingestion.md"] -->|"section anchors added"| G
%%{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["prerequisites-support-matrix.md\n(H200 NVL: Not supported⁴ for Parakeet ASR)"] -->|"crosslinks via #model-hardware-requirements\n#core-and-advanced-pipeline-features\n#related-topics"| A
A -->|"audio-video.md anchor"| B["audio-video.md\n(#parakeet-hosted-inference-build-nvidia)"]
B -->|"API guide crosslink"| C["nemo-retriever-api-reference.md\n(#pdf-pre-splitting-for-parallel-ingest)"]
D["embedding.md\nnimclient.md"] -->|"API guide crosslinks\n(near Python snippets)"| C
E["deployment-options.md\noverview.md\ntroubleshoot.md\ngetting-started-about.md"] -->|"circular docs.nvidia.com links removed\nreplaced with local relative links"| F["getting-started-about.md\ndeployment-options.md"]
G["concepts.md\nworkflow-document-ingestion.md"] -->|"section anchors added"| G
Reviews (3): Last reviewed commit: "Merge branch 'main' into docs/extraction..." | Re-trigger Greptile
…VIDIA#2257) Remove misplaced API guide links from nimclient Error Handling and Debugging Tips. Drop manual On this page TOC from prerequisites-support-matrix; section anchors remain for deep links.
randerzander
left a comment
There was a problem hiding this comment.
one nit, can be followup PR
Align with PR NVIDIA#2257 review: relocate developer-facing NimClient content from published extraction docs into nemo_retriever/developer_docs, index it in developer_docs/README.md, and redirect legacy nimclient URLs.
Summary
Docs-only extraction update (11 files). Combines the #2240 H200 NVL support-matrix fix and #2245 anchor/crosslink hygiene into one reviewable batch. Rebased on current
main(no Helm README or runtime changes).NVBugs 6261554 — H200 NVL Parakeet unsupported
nimOperator.audio) as not supported on H200 NVL, in addition to B200 and other Blackwell GPUs, inprerequisites-support-matrix.mdNavigation — section anchors and on-page TOC
{ #anchor }IDs on heavily cross-linked headings inprerequisites-support-matrix.md,deployment-options.md,workflow-document-ingestion.md,nemo-retriever-api-reference.md, andconcepts.mdprerequisites-support-matrix.md(anchors aligned with current#image-captioning, not legacy 26.05 labels)Crosslinks and handoffs
embedding.md,nimclient.md, andaudio-video.mddocs.nvidia.com/.../overview/self-links; route prerequisites/deployment handoffs throughgetting-started-about.mdanddeployment-options.md(overview.md,deployment-options.md,troubleshoot.md,getting-started-about.md)nemo-retriever-api-reference.md,concepts.md)Supersedes: #2240, #2245
Out of scope (already on
mainor separate PRs): Helm chart README edits, OCR v2 defaults,custom-metadata.mdconsolidation →vdbs.md,starter-kits.mdrenameFiles changed
prerequisites-support-matrix.mddeployment-options.mdconcepts.mdembedding.md,nimclient.md,audio-video.mdnemo-retriever-api-reference.mdworkflow-document-ingestion.mdgetting-started-about.md,overview.md,troubleshoot.mdTest plan
check-nrl-doc-leakage.ps1 -Base mainpasses on the branch diffprerequisites-support-matrix.md(#on-this-page,#model-hardware-requirements,#image-captioning)latest/extraction/prerequisites-support-matrix/renders the H200 footnote and on-page TOC