docs: add info on running offline to FAQ

[marta-sd]

Added FAQ section on offline usage with guidance for configuring local caching and pre-populating data

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[marta-sd]

@CodeRabbit review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Walkthrough

Added a new FAQ subsection addressing offline usage of Evaluator, detailing local cache configuration and pre-population guidance. Documentation markers were added to a YAML example file without modifying configuration values or behavior.

Changes

Cohort / File(s)	Summary
FAQ Documentation docs/references/faq.md	Added new FAQ subsection "Can I use Evaluator without internet access?" with offline usage guidance, local cache configuration instructions, and HF caching example reference
YAML Documentation Markers packages/nemo-evaluator-launcher/examples/slurm_vllm_advanced_hf_caching.yaml	Inserted documentation snippet markers (comment tags) before defaults block and after evaluation tasks for documentation purposes; no configuration changes

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Both changes are purely documentation additions with no logic, configuration, or behavioral modifications
• The YAML markers are simple comment insertions that do not affect functionality

Poem

🐰 Offline whispers, caches glow,
Local paths help data flow,
No net required, we're standing tall,
Markers mark the way for all! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately describes the main change—adding FAQ information about offline usage—and is concise and clear.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch martas/offline-faq

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f44145 and 2959ef7.

📒 Files selected for processing (2)

• docs/references/faq.md (1 hunks)
• packages/nemo-evaluator-launcher/examples/slurm_vllm_advanced_hf_caching.yaml (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-12-10T21:34:56.965Z

Learnt from: marta-sd
Repo: NVIDIA-NeMo/Evaluator PR: 523
File: packages/nemo-evaluator-launcher/examples/local_reasoning.yaml:55-55
Timestamp: 2025-12-10T21:34:56.965Z
Learning: When editing YAML configuration in the Nemo Evaluator launcher examples, align mapping.toml section names with the actual container/image naming convention used by simple-evals (hyphenated, e.g., 'simple-evals'). This ensures consistency between the container naming and config sections. Apply this guideline to all YAML files under packages/nemo-evaluator-launcher/examples that define mapping.toml sections, and adjust section keys to match the container/framework naming convention used by the published image.

Applied to files:

• packages/nemo-evaluator-launcher/examples/slurm_vllm_advanced_hf_caching.yaml

🔇 Additional comments (2)

packages/nemo-evaluator-launcher/examples/slurm_vllm_advanced_hf_caching.yaml (1)

34-34: Documentation markers correctly delineate the offline caching example.

The start and end markers are placed to include a complete, representative example covering execution with HF cache mounts, environment variables for offline mode, and typical deployment/evaluation configuration. The markers use standard Sphinx snippet format and introduce no functional changes to the configuration.

Also applies to: 86-86

docs/references/faq.md (1)

321-342: Well-integrated offline usage FAQ with clear guidance.

The new section provides a clear explanation of HF Hub dependencies, practical guidance for offline setup, and references an example configuration. The relative path in the literalinclude directive resolves correctly, and both required documentation markers (# [docs-start-snippet] and # [docs-end-snippet]) are present in the YAML file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[marta-sd]

/ok to test 2959ef7