Skip to content

Remove debug mode references from documentation#6175

Merged
mdabek-nvidia merged 2 commits intoNVIDIA:mainfrom
mdabek-nvidia:remove_pipeline_mode_documentation
Jan 29, 2026
Merged

Remove debug mode references from documentation#6175
mdabek-nvidia merged 2 commits intoNVIDIA:mainfrom
mdabek-nvidia:remove_pipeline_mode_documentation

Conversation

@mdabek-nvidia
Copy link
Copy Markdown
Collaborator

Category:

Other

Description:

The debug mode is not maintained anymore after the introduction of dynamic mode. Feature documentation will be removed.

Additional information:

Affected modules and functionalities:

Key points relevant for the review:

Tests:

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Checklist

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: DALI-4509

Signed-off-by: Marek Dabek <mdabek@nvidia.com>
@mdabek-nvidia
Copy link
Copy Markdown
Collaborator Author

!build

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [42716577]: BUILD STARTED

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [42716577]: BUILD PASSED

Signed-off-by: Marek Dabek <mdabek@nvidia.com>
@mdabek-nvidia mdabek-nvidia marked this pull request as ready for review January 28, 2026 11:07
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jan 28, 2026

Greptile Overview

Greptile Summary

This PR completes the removal of debug mode documentation by eliminating the "Experimental Pipeline Features" section and its reference to @nvidia.dali.pipeline.experimental.pipeline_def.

Key changes:

  • Removed "Experimental Pipeline Features" section header from pipeline.rst
  • Removed @nvidia.dali.pipeline.experimental.pipeline_def autodoc reference from pipeline.rst
  • No changes to other_index.py (debug_mode.ipynb entry was already removed in previous commit)

Remaining cleanup needed:

  • docs/FAQ.rst still references debug mode at lines 79 and 86 with links to examples/general/debug_mode.html
  • docs/examples/general/debug_mode.ipynb file still exists in the repository
  • Consider updating FAQ answers or removing those Q&A entries as debug mode is no longer supported

Confidence Score: 4/5

  • Safe to merge with minor documentation cleanup pending
  • Documentation changes are straightforward and correct, but incomplete - FAQ.rst still references the removed debug mode feature and the debug_mode.ipynb file still exists
  • No files in this PR require special attention, but docs/FAQ.rst (not in PR) needs updating

Important Files Changed

Filename Overview
docs/examples/other_index.py Removed debug_mode.ipynb from documentation index - clean removal with proper formatting
docs/pipeline.rst Removed experimental pipeline features section header and autodoc reference

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation System
    participant User as Documentation Reader
    
    Note over Dev,User: Debug Mode Deprecation Flow
    
    Dev->>Docs: Remove debug mode section (commit 5303d77)
    activate Docs
    Docs-->>Docs: Delete debug mode documentation
    deactivate Docs
    
    Dev->>Docs: Remove experimental features header (this PR)
    activate Docs
    Docs-->>Docs: Delete "Experimental Pipeline Features" section
    Docs-->>Docs: Remove pipeline.experimental.pipeline_def reference
    deactivate Docs
    
    Note over Docs: Remaining cleanup needed
    
    User->>Docs: Access FAQ.rst
    Docs-->>User: Returns broken debug_mode.html links
    
    Note over Dev: TODO: Update FAQ.rst<br/>TODO: Remove debug_mode.ipynb file
Loading

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@@ -75,6 +75,5 @@
doc_entry("custom_operations/index.py"),
doc_entry("advanced/serialization.ipynb"),
doc_entry("legacy_getting_started.ipynb"),
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider removing docs/examples/general/debug_mode.ipynb file itself to complete the cleanup.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@mdabek-nvidia
Copy link
Copy Markdown
Collaborator Author

!build

1 similar comment
@mdabek-nvidia
Copy link
Copy Markdown
Collaborator Author

!build

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [42814013]: BUILD STARTED

@dali-automaton
Copy link
Copy Markdown
Collaborator

CI MESSAGE: [42814013]: BUILD PASSED

@mdabek-nvidia mdabek-nvidia merged commit cd5f982 into NVIDIA:main Jan 29, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants