Fix docs CI: remove redundant quotes from GradScaler annotations after adding from __future__ import annotations#3586
Closed
Fix docs CI: remove redundant quotes from GradScaler annotations after adding from __future__ import annotations#3586
from __future__ import annotations#3586Conversation
Root cause: from __future__ import annotations was added but quoted "torch.amp.GradScaler" annotations remained. This caused Sphinx's get_type_hints() to fail when evaluating '"torch.amp.GradScaler" | None' (TypeError: unsupported operand for |: str and NoneType). Fix: remove quotes from torch.amp.GradScaler annotations (safe since from __future__ import annotations handles forward references), and add torch.amp.GradScaler to nitpick_ignore in docs/source/conf.py. Co-authored-by: vfdev-5 <[email protected]>
Copilot
AI
changed the title
[WIP] Investigate and fix CI job failure
Fix docs CI: remove redundant quotes from GradScaler annotations after adding Feb 24, 2026
from __future__ import annotations
2 tasks
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
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.
PR #3576 introduced
from __future__ import annotationsbut lefttorch.amp.GradScalerin explicit forward-reference quotes (e.g.,"torch.amp.GradScaler" | None). With PEP 563, all annotations are stored as raw strings, so the quoted form becomes the literal string'"torch.amp.GradScaler" | None'. Sphinx'sget_type_hints()then tries toevalthat expression and hits aTypeError(str | NoneTypeis not a valid union), producing 2 warnings that are treated as errors in CI.Changes
ignite/engine/__init__.pyfrom __future__ import annotationsSequenceimport tocollections.abc; dropDict,Optional,Tuple,Unionfromtypingtypingannotations with modernX | Y,X | None,dict[...],tuple[...]syntaxtorch.amp.GradScalerin annotations — redundant (and harmful) oncefrom __future__ import annotationsis presentdocs/source/conf.py("py:class", "torch.amp.GradScaler")tonitpick_ignoreso Sphinx silences the unresolvable cross-reference rather than erroring✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.