Skip to content

docs(cli): use hosted VL embed model in hosted NIM examples (NVBug 6657245) - #2610

Draft
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6657245-hosted-embed-vl-model
Draft

docs(cli): use hosted VL embed model in hosted NIM examples (NVBug 6657245)#2610
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6657245-hosted-embed-vl-model

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Follow-up to docs(cli): use hosted VL rerank defaults in CLI example (NVBug 6657245) #2576. The rerank URL/model/key fix is still correct.
  • nvidia/llama-nemotron-embed-1b-v2 now returns HTTP 410 on integrate.api.nvidia.com (EOL 2026-08-25), so the hosted ingest example fails before the rerank example can run.
  • Change --embed-model-name to nvidia/llama-nemotron-embed-vl-1b-v2 in the hosted ingest and rerank examples only. Leave local Hugging Face checkpoint mentions unchanged.

Fixes the remaining runnable-example gap on NVBug 6657245.

Test plan

  • Diff is docs-only: nemo_retriever/docs/cli/README.md (2 token replacements)
  • Hosted examples match the support-matrix default NVCF embed model nvidia/llama-nemotron-embed-vl-1b-v2
  • Fast-text and checkpoint-list mentions of llama-nemotron-embed-1b-v2 are unchanged
  • QA: copy the hosted ingest then rerank examples verbatim on a CPU-only host with NVIDIA_API_KEY

pre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main

Base: upstream/main (afbddc61)
Files: nemo_retriever/docs/cli/README.md

Check Result
Leakage (page roles + see [ CTAs) PASS — no CTA/link changes
Allowed paths PASS — 1 documentation file
mkdocs --strict not re-run this follow-up; snippet include is unchanged except two model IDs
::a audit PASS — VL embed ID matches VL_EMBED_MODEL and the Default NVCF endpoints table
::p polish none needed — one-token model ID swap
::r style 100% — identifiers only

Code drift (not in this docs PR): operators/rerank.py:207 still names inference-api.nvidia.com in a docstring. QA marked that optional and not a closure blocker.

PR: this draft (follow-up to #2576)

…57245)

The text embed-1b-v2 model now returns HTTP 410 on integrate.api.nvidia.com. Point the hosted ingest and rerank examples at llama-nemotron-embed-vl-1b-v2 so the section is runnable.
@kheiss-uwzoo
kheiss-uwzoo requested a review from jperez999 August 28, 2026 23:15
@kheiss-uwzoo kheiss-uwzoo self-assigned this Aug 28, 2026
@kheiss-uwzoo kheiss-uwzoo added doc Improvements or additions to documentation 26.08.1 labels Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

26.08.1 doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant