[Feature Request] Source installation docs should pin supported PyTorch versions

Open Beginner friendly
#5,766 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python, pytorch
Domain
documentation, machine-learning

Research direction

Locate the source-installation documentation and the package metadata that declares PyTorch requirements. Review the current install flow and supported torch.compile versions, then update the documentation and dependency constraint so an unsupported PyTorch 2.13.x version is not silently selected; verify the final instructions and metadata agree.

Written by the indexing model from the issue text.

Description

Docs enhancement
Summary

The current “install from source” documentation does not clearly require a supported PyTorch version.

When installing from source with a normal pip install, pip may automatically install or upgrade PyTorch to 2.13.0 (as of 2026/7/11). However, DeePMD-kit currently only supports torch.compile with PyTorch 2.11.x or 2.12.x, which later causes runtime errors such as:

RuntimeError: deepmd `torch.compile` support requires PyTorch 2.11.x or 2.12.x; found torch 2.13.0+cu126.

Please update the source installation documentation to either:

  • explicitly pin a supported version, for example torch==2.11.0 or torch>=2.11,<2.13; or
  • add a prominent warning that users must install a supported PyTorch version before installing DeePMD-kit from source.

It would also be helpful if the package metadata imposed the same upper bound, so pip cannot silently install an incompatible PyTorch version.

Detailed Description

As above

Further Information, Files, and Links

No response

Dominant language
Python
Stars
2k
Forks
651
Avg merge
6d 1h
Merged PRs (30d)
18

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from deepmodeling/deepmd-kit

All issues in deepmodeling/deepmd-kit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.