Back to Skills

nemotron-retrieval-recipes

Use when planning, debugging, tuning, evaluating, exporting, or deploying public Nemotron `embed`/`rerank` retrieval recipes.

2,713stars315forksUpdated 7/29/2026

Security Assessment

Safe(93/100)
Security Score93/100

About nemotron-retrieval-recipes

Nemotron Retrieval Recipes is an operational assistant skill for working with NVIDIA's public Nemotron `embed` and `rerank` retrieval recipes inside a source checkout or installed package. It exists to route a user's retrieval failure to the correct recipe family, reconcile documentation against the actively-changing checkout (CLI, configs, containers, and output paths), avoid accidental long-running launches, protect secrets, and return concrete preview, dry-run, and execution commands. The skill treats the current checkout as authoritative over its own bundled references and memory, and reports a blocker rather than guessing when a required recipe directory, CLI command, config, or env profile is missing.

The skill maps the full pipeline across stages: Stage 0 synthetic data generation (SDG), Stage 1 prep (hard-negative mining and BEIR eval data), Stage 2 contrastive fine-tuning, Stage 3 evaluation, Stage 4 export (ONNX/TensorRT for the Llama profile), and Stage 5 deployment (vLLM or NIM backends). It provides two model profiles (`default` for Nemotron-3-Embed and `llama` for llama-nemotron-embed), references for embedding vs. reranking selection, remote/batch execution via `env.toml` profiles, and evaluation tooling. It emphasizes dry-run previews and dotlist config overrides rather than editing recipe defaults.

Target users are ML engineers and applied researchers tuning first-stage (bi-encoder) or second-stage (cross-encoder) retrieval models who diagnose issues like low Recall@k or poor top-rank ordering. It is best suited to teams running Nemotron retrieval fine-tuning end to end on GPU infrastructure, and explicitly scopes out generic retrieval theory, vector-database selection, and non-recipe Docker/Slurm/NIM troubleshooting.

FAQ

When should I use the embed recipe versus the rerank recipe?

Use the embed reference for first-stage retrieval problems such as low Recall@k, missing relevant documents, or poorly matched domain terms. Use the rerank reference when recall is acceptable but top-rank ordering is poor, for example low nDCG with good Recall. Use both only when the user asks about both families or which to choose.

What are the prerequisites for running the recipes?

A repo environment set up with `uv sync` (all or the smallest relevant extra), an `NVIDIA_API_KEY` for Stage 0 SDG, CUDA/NVIDIA drivers and sufficient VRAM for GPU stages, a NeMo Export-Deploy container for TensorRT export, Docker for deployment, and optionally NGC access with `NGC_API_KEY` for Llama Embed and rerank deployment.

How does the skill handle my data and credentials?

Stage 0 SDG can transmit corpus content to NVIDIA-hosted inference endpoints, so the skill requires you to confirm your data-governance policy permits that transfer before running on proprietary or regulated data; otherwise it directs you to a private or air-gapped path. It keeps API keys in environment variables or a secrets manager, never hardcodes or dumps them, and never asks users to paste secret values.

Will the skill launch long-running GPU or cluster jobs on its own?

No. It uses Bash only for repo-scoped inspection, help, and dry-run commands by default, and does not run API, GPU, Docker, Slurm, or NIM work unless you explicitly ask for it.

What is out of scope for this skill?

Generic retrieval theory, generic vector-database selection, generic benchmark advice, and non-recipe Docker/Slurm/NIM troubleshooting. For those it stops with a short scope note rather than inspecting recipe files.

All Files

11 files
BENCHMARK.md3.1 KB
View
references/embed.md11.3 KB
View
skill.oms.sig5.8 KB
View
evals/.gitignore0.0 KB
View
references/rerank.md9.3 KB
View
evals/EVAL.md4.3 KB
View
skill-card.md3.9 KB
View
evals/evals.json19.5 KB
View
SKILL.md10.2 KB
View
references/evaluation.md3.5 KB
View
references/remote.md2.0 KB
View

Install nemotron-retrieval-recipes

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill

Repository

nvidia/skills