docs(nemo-retriever): 26.07 RC readiness corrections for NeMo Retriever Library - #2391
Conversation
Greptile SummaryThis is a documentation-only PR that fixes several customer-facing issues in the NeMo Retriever Library 26.07 RC docs. The changes are accurate and internally consistent based on verification against the actual module structure and
|
| Filename | Overview |
|---|---|
| nemo_retriever/README.md | Fixes LiteLLMClient/LLMJudge import paths, aligns torch/torchvision CUDA 13 override command with pyproject.toml pins, and restructures intro to separate local GPU vs. remote NIM paths. All technical content verified correct. |
| docs/docs/extraction/overview.md | H1 renamed from question style to statement style with anchor preserved; nemotron-parse note updated to show uv pip install as primary with pip install as equivalent alternative. |
| docs/docs/extraction/prerequisites-support-matrix.md | Adds platform summary banner, rewrites Linux/CUDA requirements to distinguish local GPU vs. remote NIM paths, converts some MkDocs admonitions to blockquotes (one admonition at line 116 remains in !!! style, creating a minor formatting inconsistency). |
| docs/docs/extraction/vdbs.md | "Why LanceDB?" section heading and TOC entry renamed to "LanceDB Overview"; the explicit anchor id #why-lancedb is preserved on the heading, so the TOC link continues to resolve correctly. |
| docs/docs/index.md | Root index H1 renamed to statement style; explicit anchor #what-is-nvidia-nemo-retriever added to preserve any existing inbound links. |
| docs/mkdocs.yml | Nav label for extraction/overview.md updated to "NeMo Retriever Library Overview" to match the renamed H1; no other nav or plugin configuration touched. |
| docs/docs/extraction/multimodal-extraction.md | Four cross-reference link labels updated from "What is NeMo Retriever Library?" to "NeMo Retriever Library Overview"; no content changes. |
| docs/docs/extraction/audio-video.md | Two cross-reference link labels updated to match renamed overview heading; no content changes. |
| docs/docs/extraction/getting-started-about.md | Step 2 in the getting-started flow now notes that remote NIM workflows support Windows x64 and macOS; final link updated to new overview heading text. |
| docs/docs/extraction/troubleshoot.md | One cross-reference link label updated; troubleshoot pip install example intentionally left as plain pip install since the PR treats it as equivalent to uv pip install. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User installs nemo-retriever] --> B{Inference path?}
B --> C["Local GPU (Linux only)\nuv pip install nemo-retriever[local]"]
B --> D["Remote NIM\nuv pip install nemo-retriever\n(Linux / Windows x64 / macOS x64/ARM64)"]
C --> E["Override torch/torchvision\ntorch==2.11.0, torchvision==0.26.0\n-i https://download.pytorch.org/whl/cu130"]
C --> F["Optional: Nemotron Parse\nuv pip install nemo-retriever[nemotron-parse]"]
D --> G["from nemo_retriever.models.llm import LiteLLMClient, LLMJudge"]
E --> H[Run GPU-accelerated ingestion pipeline]
F --> H
Reviews (10): 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.
76f3828 to
91976b0
Compare
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