Skip to content

Fix CausalConv1d sample links and backends architecture fence - #518

Merged
Anerudhan merged 1 commit into
NVIDIA:developfrom
pmdavies-nv:pdavies/fix-causalconv-backends-docs
Aug 7, 2026
Merged

Fix CausalConv1d sample links and backends architecture fence#518
Anerudhan merged 1 commit into
NVIDIA:developfrom
pmdavies-nv:pdavies/fix-causalconv-backends-docs

Conversation

@pmdavies-nv

@pmdavies-nv pmdavies-nv commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Before submitting

  • I agree to license this contribution under the terms of LICENSE.txt.
  • I ran pre-commit run and committed any formatting changes.
  • I added GitHub labels: one cat-*, one or more mod-*, and one orig-* (see label list).

Affected area

  • Documentation or samples

Summary

  • Replace broken relative ../../samples/python/*.ipynb links in docs/operations/CausalConv1d.md with GitHub absolute URLs.
  • Mark the architecture diagram code block in docs/python_graph_and_execution_backends.md as text.

Why

  • Relative sample notebook links do not resolve when these docs are consumed outside this repository (samples are not present in the docs publishing context).
  • The untyped architecture fence can be misinterpreted by syntax highlighters because of Unicode arrows.

Related issues

N/A

API and compatibility impact

None

Testing

  • Docs-only change; verified link targets match existing samples/python/ notebooks and followed the same absolute-URL pattern used elsewhere in docs/.

Summary by CodeRabbit

  • Documentation
    • Updated notebook references with direct GitHub links for forward and backward examples.
    • Clarified the architecture diagram’s code block language annotation.

Point notebook links at GitHub absolute URLs so they resolve outside this repo, and mark the Unicode architecture diagram as text to avoid highlighter issues.
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 3678732e-8793-48ae-be5e-fb71c3db338c

📥 Commits

Reviewing files that changed from the base of the PR and between 3f17f5b and 61edddf.

📒 Files selected for processing (2)
  • docs/operations/CausalConv1d.md
  • docs/python_graph_and_execution_backends.md

📝 Walkthrough

Walkthrough

The change updates three CausalConv1d notebook link pairs to absolute GitHub URLs and marks an architecture diagram code fence as text.

Changes

Documentation updates

Layer / File(s) Summary
Documentation references and markup
docs/operations/CausalConv1d.md, docs/python_graph_and_execution_backends.md
The NHW, NWH, and B2B notebook links now use absolute GitHub URLs. The architecture diagram fence now uses the text annotation.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: anerudhan

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes both documentation changes: fixing CausalConv1d links and annotating the backends architecture fence.
Description check ✅ Passed The description includes all required sections and clearly explains the documentation changes, rationale, compatibility impact, and testing performed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@Anerudhan Anerudhan added cat-doc Documentation changes, examples, API references, tutorials, or wording fixes. mod-frontend cuDNN frontend APIs, operation graph construction, plans, and user-facing wrappers. orig-nv-eng Reported or requested by NVIDIA engineering. labels Aug 7, 2026
@Anerudhan Anerudhan added this to the Frontend 1.28.0 milestone Aug 7, 2026
@Anerudhan
Anerudhan merged commit 503435f into NVIDIA:develop Aug 7, 2026
1 check passed
@pmdavies-nv
pmdavies-nv deleted the pdavies/fix-causalconv-backends-docs branch August 7, 2026 22:30
@Anerudhan Anerudhan mentioned this pull request Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cat-doc Documentation changes, examples, API references, tutorials, or wording fixes. mod-frontend cuDNN frontend APIs, operation graph construction, plans, and user-facing wrappers. orig-nv-eng Reported or requested by NVIDIA engineering.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants