docs(captum): fix in/is typo in Layer Attribution#3906
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
The Captum intro tutorial defined Layer Attribution as "...an input image in an example of layer attribution" - "in" used where "is" was intended. The corresponding Feature Attribution bullet a few lines above uses the parallel construction "...is an example of feature attribution," so the surrounding text already signals the intended phrasing. Replace "in" with "is". Fixes pytorch#3905
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3906
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3905
Description
Summary
Closes #3905. The Captum intro tutorial (
beginner_source/introyt/captumyt.py:51) ended its Layer Attribution definition with "...an input image in an example of layer attribution" - "in" where "is" was intended. Replace withis. The reporter caught this on the rendered docs page (https://docs.pytorch.org/tutorials/beginner/introyt/captumyt.html#id1).Why this matters
The bullet two lines above defines Feature Attribution using the parallel construction "...is an example of feature attribution," so the surrounding text already signals what the intended phrasing should be. The typo turns the Layer Attribution sentence into a non-sentence, which trips readers who are otherwise following the intuition Sphinx Gallery is trying to build.
How to test
make html-noplot GALLERY_PATTERN="captumyt.py"builds clean as a quick Sphinx structure validation (no GPU needed).Checklist
AI-assisted.