Skip to content

docs: restore agentic retrieval README example#2307

Open
kheiss-uwzoo wants to merge 4 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/restore-agentic-readme
Open

docs: restore agentic retrieval README example#2307
kheiss-uwzoo wants to merge 4 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/restore-agentic-readme

Conversation

@kheiss-uwzoo

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

Copy link
Copy Markdown
Collaborator

Summary

  • Restores the Run agentic retrieval section in nemo_retriever/README.md now that the feature has merged.
  • Adds CLI and Python examples for querying an existing LanceDB index with agentic retrieval, plus a link to the detailed CLI reference.
  • Removes internal QA evaluation guide links from the package quickstart; the README should not point customers at tools/evaluation/ benchmark docs.

Test plan

  • Confirmed PR scope is one file: nemo_retriever/README.md.
  • Ran pre-commit hooks through git commit.
  • Ran DORI ::a checks: validate_code_blocks.py passes and detect_drift.py reports no drift.
  • Ran verify_docs.py on nemo_retriever/README.md: passes with 0 link issues.
  • Checked README link CTA style for see [ patterns: no matches.
  • Checked IDE diagnostics for nemo_retriever/README.md: no linter errors.
  • Self-review: no references to internal QA/benchmark docs remain in the customer-facing README.

@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners July 7, 2026 14:40
@kheiss-uwzoo kheiss-uwzoo requested a review from nkmcalli July 7, 2026 14:40
@greptile-apps

greptile-apps Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This docs-only PR restores the Run agentic retrieval section to nemo_retriever/README.md now that the feature has landed, and fixes two stale links that pointed to ./src/nemo_retriever/evaluation/README.md (a path that no longer exists after the module reorganization).

  • Adds a complete CLI and Python walkthrough for agentic retrieval, including a smoke-test recipe and a cross-reference to docs/cli/README.md#agentic-retrieval.
  • Replaces the two removed QA-evaluation deep-links with self-contained inline guidance so the paragraph remains actionable without the stale anchors.

Confidence Score: 5/5

Safe to merge — documentation only, all API references and CLI flags verified against the live implementation.

All changed content is documentation. The Python imports, field names, and the cross-reference anchor were each confirmed against the current source. The removed evaluation links pointed to a path that no longer exists in the repo.

No files require special attention.

Important Files Changed

Filename Overview
nemo_retriever/README.md Documentation-only change: two stale evaluation links removed, new agentic retrieval section added with verified API imports and CLI flags matching the actual implementation.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User runs `retriever query --agentic`] --> B{GPU available?}
    B -->|Yes| C[Local GPU embedding]
    B -->|No| D[Hosted NVIDIA endpoint\nrequires NVIDIA_API_KEY]
    C --> E[LanceDB index lookup]
    D --> E
    E --> F[ReAct LLM loop\nnvidia/llama-3.3-nemotron-super-49b-v1.5]
    F -->|sub-query| E
    F --> G[Ranked document IDs as JSON]
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[User runs `retriever query --agentic`] --> B{GPU available?}
    B -->|Yes| C[Local GPU embedding]
    B -->|No| D[Hosted NVIDIA endpoint\nrequires NVIDIA_API_KEY]
    C --> E[LanceDB index lookup]
    D --> E
    E --> F[ReAct LLM loop\nnvidia/llama-3.3-nemotron-super-49b-v1.5]
    F -->|sub-query| E
    F --> G[Ranked document IDs as JSON]
Loading

Reviews (3): Last reviewed commit: "docs: remove internal QA evaluation link..." | Re-trigger Greptile

@kheiss-uwzoo kheiss-uwzoo self-assigned this Jul 7, 2026
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jul 7, 2026
Comment thread nemo_retriever/README.md Outdated
@kheiss-uwzoo kheiss-uwzoo requested a review from randerzander July 7, 2026 15:53
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