[BE] detect CXX pytree requirement with `TorchVersion` #151102

XuehaiPan · 2025-04-11T10:16:43Z

Stack from ghstack (oldest at bottom):

[ghstack-poisoned]

pytorch-bot · 2025-04-11T10:16:46Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/151102

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 9f93511 with merge base 9e50c21 ():
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

[ghstack-poisoned]

ghstack-source-id: 586d3ba Pull Request resolved: pytorch#151102

zou3519 · 2025-04-14T19:31:13Z

sorry please dont' land this yet it might merge conflict with #151257

[ghstack-poisoned]

XuehaiPan · 2025-04-15T14:08:14Z

torch/utils/_pytree.py

@@ -170,16 +172,16 @@ class _SerializeNodeDef(NamedTuple):
 # NB: we try really hard to not import _cxx_pytree (which depends on optree)
 # as much as possible. This is for isolation: a user who is not using C++ pytree
 # shouldn't pay for it, and it helps makes things like cpython upgrades easier.
+_optree_minimum_version = _TorchVersion("0.13.0")


NB: TorchVersion is a subclass of str while the rich comparison is semantic version comparison rather than alphabetic dictionary order.

[ghstack-poisoned]

ghstack-source-id: 2d246a3 Pull Request resolved: pytorch#151102

[ghstack-poisoned]

ghstack-source-id: b334675 Pull Request resolved: pytorch#151102

[ghstack-poisoned]

ghstack-source-id: 7bb2cd3 Pull Request resolved: pytorch#151102

zou3519 · 2025-04-30T15:05:48Z

torch/utils/_cxx_pytree.py

+# In-tree installation may have VCS-based versioning. Update the previous static version.
+python_pytree._optree_version = _TorchVersion(optree.__version__)  # type: ignore[attr-defined]


I mentioned this elsewhere but from the naming it sounds like _TorchVersion is for torch versions, not for third-party library versions. Should we do something about that?

it sounds like _TorchVersion is for torch versions, not for third-party library versions

No. TorchVersion is widely used in the codebase for version comparison, such as CUDA/ROCm version, and triton version.

pytorch/torch/__init__.py

Lines 2305 to 2309 in 3719997

cuda_version = None

if hasattr(torch, "version"):

from torch.torch_version import TorchVersion

cuda_version = TorchVersion(getattr(torch.version, "cuda", "0.0"))

pytorch/tools/dynamo/verify_dynamo.py

Lines 33 to 53 in 3719997

# based on torch/utils/cpp_extension.py

def get_cuda_version():

from torch.torch_version import TorchVersion

from torch.utils import cpp_extension

CUDA_HOME = cpp_extension._find_cuda_home()

if not CUDA_HOME:

raise VerifyDynamoError(cpp_extension.CUDA_NOT_FOUND_MESSAGE)

nvcc = os.path.join(CUDA_HOME, "bin", "nvcc")

cuda_version_str = (

subprocess.check_output([nvcc, "--version"])

.strip()

.decode(*cpp_extension.SUBPROCESS_DECODE_ARGS)

)

cuda_version = re.search(r"release (\d+[.]\d+)", cuda_version_str)

if cuda_version is None:

raise VerifyDynamoError("CUDA version not found in `nvcc --version` output")

cuda_str_version = cuda_version.group(1)

return TorchVersion(cuda_str_version)

pytorch/tools/dynamo/verify_dynamo.py

Lines 56 to 79 in 3719997

def get_rocm_version():

from torch.torch_version import TorchVersion

from torch.utils import cpp_extension

ROCM_HOME = cpp_extension._find_rocm_home()

if not ROCM_HOME:

raise VerifyDynamoError(

"ROCM was not found on the system, please set ROCM_HOME environment variable"

)

hipcc = os.path.join(ROCM_HOME, "bin", "hipcc")

hip_version_str = (

subprocess.check_output([hipcc, "--version"])

.strip()

.decode(*cpp_extension.SUBPROCESS_DECODE_ARGS)

)

hip_version = re.search(r"HIP version: (\d+[.]\d+)", hip_version_str)

if hip_version is None:

raise VerifyDynamoError("HIP version not found in `hipcc --version` output")

hip_str_version = hip_version.group(1)

return TorchVersion(hip_str_version)

pytorch/torch/_inductor/kernel/mm.py

Lines 61 to 68 in 3719997

try:

import triton

triton_version = TorchVersion(triton.__version__)

has_triton = True

except ImportError:

triton_version = TorchVersion("0.0.0")

has_triton = False

pytorch/torch/_inductor/cpp_builder.py

Lines 208 to 217 in 3719997

def _is_intel_compiler(cpp_compiler: str) -> bool:

def _check_minimal_version(compiler_version: TorchVersion) -> None:

"""

On Windows: early version icx has `-print-file-name` issue, and can't preload correctly for inductor.

"""

min_version = "2024.2.1" if _IS_WINDOWS else "0.0.0"

if compiler_version < TorchVersion(min_version):

raise RuntimeError(

f"Intel Compiler error: less than minimal version {min_version}."

)

Also, torch.torch_version.TorchVersion is an exported API:

pytorch/torch/torch_version.py

Line 8 in 3719997

__all__ = ["TorchVersion"]

Fair enough, thanks for pointing that out

zou3519

looks good, thank you

XuehaiPan · 2025-05-01T16:14:40Z

@pytorchbot merge

pytorchmergebot · 2025-05-01T16:17:29Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

ghstack-source-id: 7bb2cd3 Pull Request resolved: pytorch#151102

Update

920f993

[ghstack-poisoned]

pytorchbot added the open source label Apr 11, 2025

This was referenced Apr 11, 2025

[pytree] Add public pytree module torch.utils.pytree #137400

Open

[pytree] add another simplified pytree module torch.pytree #148180

Open

[pytree] simplify public API exposition with __module__ #148328

Open

XuehaiPan requested review from zou3519 and malfet April 11, 2025 10:17

XuehaiPan added better-engineering Relatively self-contained tasks for better engineering contributors topic: not user facing topic category labels Apr 11, 2025

Update

d01d285

[ghstack-poisoned]

XuehaiPan added 2 commits April 11, 2025 18:35

Update

903bee7

[ghstack-poisoned]

Update

379dedb

[ghstack-poisoned]

XuehaiPan added a commit to XuehaiPan/pytorch that referenced this pull request Apr 11, 2025

[BE] detect CXX pytree requirement with TorchVersion

f72eb9b

ghstack-source-id: 586d3ba Pull Request resolved: pytorch#151102

XuehaiPan mentioned this pull request Apr 14, 2025

Gracefully handle optree less than minimum version, part 2 #151257

Closed

Update

8066fae

[ghstack-poisoned]

XuehaiPan commented Apr 15, 2025

View reviewed changes

XuehaiPan added 2 commits April 15, 2025 22:10

Update

7b659d5

[ghstack-poisoned]

Update

15b76f0

[ghstack-poisoned]

Update

97a2162

[ghstack-poisoned]

XuehaiPan added a commit to XuehaiPan/pytorch that referenced this pull request Apr 15, 2025

[BE] detect CXX pytree requirement with TorchVersion

1016851

ghstack-source-id: 2d246a3 Pull Request resolved: pytorch#151102

Update

886bb24

[ghstack-poisoned]

XuehaiPan added a commit to XuehaiPan/pytorch that referenced this pull request Apr 23, 2025

[BE] detect CXX pytree requirement with TorchVersion

94a5442

ghstack-source-id: b334675 Pull Request resolved: pytorch#151102

Update

9f93511

[ghstack-poisoned]

XuehaiPan added a commit to XuehaiPan/pytorch that referenced this pull request Apr 26, 2025

[BE] detect CXX pytree requirement with TorchVersion

022914a

ghstack-source-id: 7bb2cd3 Pull Request resolved: pytorch#151102

zou3519 reviewed Apr 30, 2025

View reviewed changes

zou3519 approved these changes Apr 30, 2025

View reviewed changes

zou3519 requested a review from angelayi April 30, 2025 16:14

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label May 1, 2025

pytorchmergebot added the merging label May 1, 2025

XuehaiPan mentioned this pull request May 1, 2025

[pytree] make tree_* functions accept both Python and C++ PyTreeSpec #152624

Open

XuehaiPan added a commit to XuehaiPan/pytorch that referenced this pull request May 1, 2025

[BE] detect CXX pytree requirement with TorchVersion

0515574

ghstack-source-id: 7bb2cd3 Pull Request resolved: pytorch#151102

pytorchmergebot added the Merged label May 1, 2025

pytorchmergebot closed this in f1d636f May 1, 2025

pytorchmergebot removed the merging label May 1, 2025

github-actions bot deleted the gh/XuehaiPan/270/head branch June 14, 2025 02:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[BE] detect CXX pytree requirement with `TorchVersion` #151102

[BE] detect CXX pytree requirement with `TorchVersion` #151102

Uh oh!

XuehaiPan commented Apr 11, 2025 •

edited

Loading

Uh oh!

pytorch-bot bot commented Apr 11, 2025 •

edited

Loading

Uh oh!

zou3519 commented Apr 14, 2025

Uh oh!

XuehaiPan Apr 15, 2025

Uh oh!

zou3519 Apr 30, 2025 •

edited

Loading

Uh oh!

XuehaiPan Apr 30, 2025

Uh oh!

zou3519 Apr 30, 2025

Uh oh!

zou3519 left a comment

Uh oh!

XuehaiPan commented May 1, 2025

Uh oh!

pytorchmergebot commented May 1, 2025

Uh oh!

Uh oh!

		# In-tree installation may have VCS-based versioning. Update the previous static version.
		python_pytree._optree_version = _TorchVersion(optree.__version__) # type: ignore[attr-defined]

	cuda_version = None
	if hasattr(torch, "version"):
	from torch.torch_version import TorchVersion

	cuda_version = TorchVersion(getattr(torch.version, "cuda", "0.0"))

	# based on torch/utils/cpp_extension.py
	def get_cuda_version():
	from torch.torch_version import TorchVersion
	from torch.utils import cpp_extension

	CUDA_HOME = cpp_extension._find_cuda_home()
	if not CUDA_HOME:
	raise VerifyDynamoError(cpp_extension.CUDA_NOT_FOUND_MESSAGE)

	nvcc = os.path.join(CUDA_HOME, "bin", "nvcc")
	cuda_version_str = (
	subprocess.check_output([nvcc, "--version"])
	.strip()
	.decode(*cpp_extension.SUBPROCESS_DECODE_ARGS)
	)
	cuda_version = re.search(r"release (\d+[.]\d+)", cuda_version_str)
	if cuda_version is None:
	raise VerifyDynamoError("CUDA version not found in `nvcc --version` output")

	cuda_str_version = cuda_version.group(1)
	return TorchVersion(cuda_str_version)

	def get_rocm_version():
	from torch.torch_version import TorchVersion
	from torch.utils import cpp_extension

	ROCM_HOME = cpp_extension._find_rocm_home()
	if not ROCM_HOME:
	raise VerifyDynamoError(
	"ROCM was not found on the system, please set ROCM_HOME environment variable"
	)

	hipcc = os.path.join(ROCM_HOME, "bin", "hipcc")
	hip_version_str = (
	subprocess.check_output([hipcc, "--version"])
	.strip()
	.decode(*cpp_extension.SUBPROCESS_DECODE_ARGS)
	)
	hip_version = re.search(r"HIP version: (\d+[.]\d+)", hip_version_str)

	if hip_version is None:
	raise VerifyDynamoError("HIP version not found in `hipcc --version` output")

	hip_str_version = hip_version.group(1)

	return TorchVersion(hip_str_version)

	try:
	import triton

	triton_version = TorchVersion(triton.__version__)
	has_triton = True
	except ImportError:
	triton_version = TorchVersion("0.0.0")
	has_triton = False

	def _is_intel_compiler(cpp_compiler: str) -> bool:
	def _check_minimal_version(compiler_version: TorchVersion) -> None:
	"""
	On Windows: early version icx has `-print-file-name` issue, and can't preload correctly for inductor.
	"""
	min_version = "2024.2.1" if _IS_WINDOWS else "0.0.0"
	if compiler_version < TorchVersion(min_version):
	raise RuntimeError(
	f"Intel Compiler error: less than minimal version {min_version}."
	)

[BE] detect CXX pytree requirement with TorchVersion #151102

[BE] detect CXX pytree requirement with TorchVersion #151102

Uh oh!

Conversation

XuehaiPan commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/151102

✅ No Failures

Uh oh!

zou3519 commented Apr 14, 2025

Uh oh!

XuehaiPan Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

zou3519 Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

XuehaiPan Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

zou3519 Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

zou3519 left a comment

Choose a reason for hiding this comment

Uh oh!

XuehaiPan commented May 1, 2025

Uh oh!

pytorchmergebot commented May 1, 2025

Merge started

Uh oh!

Uh oh!

[BE] detect CXX pytree requirement with `TorchVersion` #151102

[BE] detect CXX pytree requirement with `TorchVersion` #151102

XuehaiPan commented Apr 11, 2025 •

edited

Loading

pytorch-bot bot commented Apr 11, 2025 •

edited

Loading

zou3519 Apr 30, 2025 •

edited

Loading