docs(nemo-retriever): 26.07 RC readiness corrections for NeMo Retriever Library - #2391
docs(nemo-retriever): 26.07 RC readiness corrections for NeMo Retriever Library#2391kheiss-uwzoo wants to merge 7 commits into
Conversation
Greptile SummaryThis PR corrects five customer-facing documentation issues for the 26.07 RC: it fixes broken
|
| Filename | Overview |
|---|---|
| nemo_retriever/README.md | Fixes LLM import paths (nemo_retriever.llm → nemo_retriever.models.llm), corrects torch/torchvision CUDA 13 pins to match pyproject.toml (2.11.0/0.26.0), splits local-GPU vs. remote-NIM install paths, and clarifies platform requirements. |
| docs/docs/extraction/prerequisites-support-matrix.md | Adds a platform summary note clarifying Linux/CUDA for local GPU vs. Windows/macOS for remote NIM; converts several MkDocs !!! admonitions to plain blockquotes; updates nemotron-parse install example to use uv pip install as the primary form. |
| docs/docs/extraction/overview.md | Renames H1 from question style to statement style with anchor preserved; rewrites intro sentences for conciseness; updates nemotron-parse note to lead with uv pip install. |
| docs/docs/index.md | Renames root H1 from 'What is NVIDIA NeMo Retriever?' to 'NVIDIA NeMo Retriever Overview' with backward-compatible anchor; change is purely cosmetic/heading style. |
| docs/docs/extraction/vdbs.md | Renames 'Why LanceDB?' section heading to 'LanceDB Overview' while preserving the #why-lancedb anchor so existing deep links continue to work. |
| docs/docs/extraction/audio-video.md | Updates two link labels from 'What is NeMo Retriever Library?' to 'NeMo Retriever Library Overview' to match the renamed H1 in overview.md. |
| docs/docs/extraction/getting-started-about.md | Updates link label for overview.md and adds inline note that local GPU inference requires Linux while remote NIM also supports Windows/macOS. |
| docs/docs/extraction/multimodal-extraction.md | Updates four link labels from 'What is NeMo Retriever Library?' to 'NeMo Retriever Library Overview' to reflect the renamed H1. |
| docs/docs/extraction/troubleshoot.md | Updates one link label for overview.md; troubleshoot pip install example intentionally remains as plain pip (not uv), per the PR's policy of uv as primary only in overview and support matrix. |
| docs/mkdocs.yml | Updates nav label from 'What is NeMo Retriever?' to 'NeMo Retriever Library Overview' to match the renamed H1 in overview.md. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User reads README / docs] --> B{Inference path?}
B -->|Local GPU - Linux only| C["Install: uv pip install nemo-retriever[local]"]
B -->|Remote NIM - Linux/Windows/macOS| D["Install: uv pip install nemo-retriever"]
C --> E["CUDA 13 override if needed\ntorch==2.11.0 torchvision==0.26.0\n-i https://download.pytorch.org/whl/cu130"]
C --> F["from nemo_retriever.models.llm\nimport LiteLLMClient, LLMJudge"]
D --> F
F --> G[Live RAG / LLM Judge pipeline]
Reviews (9): Last reviewed commit: "docs(extraction): use GitHub-friendly bl..." | Re-trigger Greptile
c138875 to
8094ff9
Compare
c97cde8 to
a7311ea
Compare
Align overview, nav, and LanceDB section titles with NVIDIA Template Library guidance while keeping FAQ questions unchanged.
Replace MkDocs admonition syntax with blockquotes so the page reads cleanly on GitHub preview while still rendering on docs.nvidia.com.
Description
Fix customer-facing RC documentation issues:
LiteLLMClientandLLMJudgefrom the supported public API,nemo_retriever.models.llm. The documentednemo_retriever.llmmodule is not included in currentnemo-retrieverwheels and fails withModuleNotFoundError.[local]dependency metadata innemo_retriever/pyproject.toml:torch==2.11.0andtorchvision==0.26.0.uv pip install nemo-retriever[nemotron-parse]the primary command in the extraction overview and support matrix, consistent with the UV-first README, while explicitly identifying plainpip installas equivalent for users who do not use UV.The branch was rebased onto current
main. Earlier NVAIE clarification and obsolete QA-link cleanup commits were dropped because equivalent updates are already present onmain. Heading renames were folded in from #2409 (now closed).Validation
pre-commit runfor changed documentation files: passednemo_retriever/pyproject.tomlTHIRD_PARTY_LICENSES.mdsnippet referenced bydocs/docs/license.md; the failure is unrelated to this diffChecklist