Uh oh!
There was an error while loading. Please reload this page.
Docs fix for 2.9 - #2302
Conversation
There was a problem hiding this comment.
Greptile Overview
Greptile Summary
This PR fixes a circular import issue in the PyTorch backend that prevented documentation generation in v2.9. The problem arose from PR #2256's quantization API generalization, which created a circular dependency: utils.py imports torch_version from the parent package (line 15), while also defining its own torch_version() function (lines 780-782). The fix moves the torch_version import in jit.py from the package root to the utils module and adds a local torch_version() function definition in utils.py. This resolves the cycle by establishing a clear dependency hierarchy where utils.py provides the utility function and other modules consume it directly, allowing Sphinx autodoc to successfully traverse the module tree during documentation builds.
Important Files Changed
| Filename | Score | Overview |
|---|---|---|
| transformer_engine/pytorch/jit.py | 5/5 | Changed import source for torch_version from package root to .utils module to break circular dependency |
| transformer_engine/pytorch/utils.py | 2/5 | Added torch_version() function definition but left conflicting import statement on line 15, creating incomplete circular-import fix; missing final newline |
Confidence score: 2/5
- This PR attempts to fix a documentation build issue but only partially resolves the circular import problem
- Score lowered because
transformer_engine/pytorch/utils.pystill importstorch_versionfrom the parent package (line 15) while also defining it locally (line 780), which does not fully break the circular dependency—the import statement on line 15 must be removed for a complete fix. Additionally, the file is missing a final newline at line 782, violating POSIX standards. - Pay close attention to
transformer_engine/pytorch/utils.py—verify that removing the import on line 15 does not break other code that might depend ontorch_versionbeing re-exported from the parent module, and ensure the final newline is added to satisfy linters
2 files reviewed, 2 comments
| import torch | ||
| from packaging.version import Version as PkgVersion | ||
| from . import torch_version |
There was a problem hiding this comment.
logic: circular import – torch_version is imported from . (line 15) but also defined locally (line 780)
Prompt To Fix With AI
This is a comment left during a code review.
Path: transformer_engine/pytorch/utils.py
Line: 15:15
Comment:
**logic:** circular import – `torch_version` is imported from `.` (line 15) but also defined locally (line 780)
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
I see, but the docs are generated properly
| @functools.lru_cache(maxsize=None) | ||
| def torch_version() -> tuple[int, ...]: | ||
| """Get PyTorch version""" | ||
| return PkgVersion(str(torch.__version__)).release No newline at end of file |
There was a problem hiding this comment.
style: missing newline at end of file (violates POSIX standard)
Prompt To Fix With AI
This is a comment left during a code review.
Path: transformer_engine/pytorch/utils.py
Line: 782:782
Comment:
**style:** missing newline at end of file (violates POSIX standard)
How can I resolve this? If you propose a fix, please make it concise.for more information, see https://pre-commit.ci
pggPL
commented
Oct 24, 2025
/te-ci pytorch |
| import torch | ||
| from packaging.version import Version as PkgVersion | ||
| from . import torch_version |
There was a problem hiding this comment.
| from . import torch_version |
| @functools.lru_cache(maxsize=None) | ||
| def torch_version() -> tuple[int, ...]: | ||
| """Get PyTorch version""" | ||
| return PkgVersion(str(torch.__version__)).release |
There was a problem hiding this comment.
This is already defined in __init__.py, which is the correct place for it.
Also, I do see the correct docs in our full CI. Maybe the github docs job has some issue? |
pggPL
commented
Oct 24, 2025
That's weird, I get wrong docs locally, but indeed it seems that docs from nightly pipeline are ok. Even if they also have warning about circular imports. But if you use main CI to get the docs which are published, that means this is not urgent and I can continue my work in #2301 |
Description
Due to circular imports caused by #2256 docs are not properly generated.
This is not python issue, it affects only docs.
2.8
current 2.9
after fix
Maybe it's not good idea to merge it, since this PR includes code changes, but maybe you can just take the docs from this PR for publishing.