Skip to content

docs(extraction): document --ray-log-to-driver instead of removed Ray log presets (NVBug 6620618) - #2614

Draft
kheiss-uwzoo wants to merge 2 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6620618-ray-logging-preset
Draft

docs(extraction): document --ray-log-to-driver instead of removed Ray log presets (NVBug 6620618)#2614
kheiss-uwzoo wants to merge 2 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6620618-ray-logging-preset

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Docs-only fix for NVBug 6620618. The Ray logging page documented INGEST_RAY_LOG_LEVEL presets (PRODUCTION, DEVELOPMENT, DEBUG) that were removed with the legacy nv-ingest framework. Setting the variable is a silent no-op on current main.
  • Remove the preset quick start, the three preset sections, the configuration-table row, the invalid-value warning, and the examples that depended on the preset.
  • Document the supported control: --ray-log-to-driver / --no-ray-log-to-driver on retriever ingest batch, and ray_log_to_driver on create_ingestor. Keep the nine upstream RAY_* environment variables.

Test plan

  • Confirm INGEST_RAY_LOG_LEVEL no longer appears in published docs
  • Confirm the page documents --ray-log-to-driver / --no-ray-log-to-driver as batch-only, default enabled
  • Confirm Python examples use create_ingestor(run_mode=batch, ray_log_to_driver=False) and .ingest()
  • Confirm the nine RAY_* rows remain and RAY_LOG_TO_DRIVER is described as not controlling the NRL batch ray.init(log_to_driver=...) path
  • python -m mkdocs build --strict --config-file mkdocs.yml from docs/

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

Base: upstream/main
Files: ray-logging.md

Check Result
Leakage (page roles + see [ CTAs) PASS — no see [ CTAs; no nimOperator / nvcr.io/nim / installFfmpeg
Allowed paths PASS — 1 documentation file
mkdocs --strict PASS — exit 0 after hiding untracked leftover pages (custom-metadata.md, user-defined-stages.md) that are not in this diff
::a audit PASS — INGEST_RAY_LOG_LEVEL absent from Python source; ray_log_to_driver default True; CLI flag is batch-only; ensure_local_ray_runtime passes log_to_driver to ray.init() (95%)
::p polish Applied — replaced dead preset path with working CLI/Python control; kept RAY_* reference; glob-based .files() example
::r style 95% — no blocking issues

Code drift (not in this docs PR): none. The library does not read INGEST_RAY_LOG_LEVEL. Reimplementing the preset would be a separate eng PR.

Overlap: Draft PR #2606 also edits ray-logging.md (adds one Related Topics link). Resolve that one-line conflict if both land.

PR: draft against main

@kheiss-uwzoo
kheiss-uwzoo requested a review from jperez999 August 28, 2026 21:29
@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