Skip to main content

TorchNEP logo
TorchNEP

Train NEP machine-learned interatomic potentials in PyTorch — the models run directly in GPUMD.

PyPI Python Tests Documentation License: GPL v3 Downloads

Documentation · Quick start · Examples · Citation

TorchNEP is a from-scratch implementation of NEP4, the neuroevolution potential architecture.

  • GPUMD-compatible — nep.txt files load directly into GPUMD for molecular dynamics
  • Two-stage training — a force-focused stage, then an energy-focused stage
  • Multi-GPU and multi-node — data-parallel training with near-linear scaling
  • Fast on NVIDIA and AMD — torch.compile with automatic backend selection, tuned on CUDA and ROCm
  • Memory-friendly — the dataset stays in host memory; GPU memory scales with the batch, not the dataset
  • Fine-tuning, ZBL, plots — start from any nep.txt, add short-range repulsion, plot every run
  • Active learning — choose the MD frames worth computing with DFT, with one model (MaxVol extrapolation grade)

Training speed and scaling

Installation

Install the PyTorch build for your hardware first, then:

pip install torchnep -U

Optional extras: torchnep[ase] (ASE calculator), torchnep[plot] (figures), torchnep[all].

Quick start

from torchnep import train_nep

train_nep("nep.in", "train.xyz", output_dir="output", valid_ratio=0.1)

The best model is written to output/nep_best.txt. The documentation covers nep.in, the training data format, multi-GPU training, restart and fine-tuning, prediction, the ASE calculator, plotting and active learning.

Building the documentation

The site is built from docs/ with MkDocs Material. In a clone of the repository:

pip install "mkdocs>=1.6,<2" mkdocs-material "mkdocstrings[python]"
mkdocs serve    # preview at http://127.0.0.1:8000/torchnep/, reloaded on every edit
mkdocs build    # static site in site/

The API reference is read from the source files, so TorchNEP itself does not need to be installed. MkDocs stays below 2.0, which the Material theme does not support.

Citation

@misc{wu2026torchne,
      title={TorchNEP: Ultra-Efficient and Accurate Training of Neuroevolution Potentials},
      author={Yong-Chao Wu and Xiaoya Chang and Tero Mäkinen and Amin Esfandiarpour and Jian-Li Shao and Tapio Ala-Nissila and Zheyong Fan and Mikko Alava},
      year={2026},
      eprint={2606.19557},
      archivePrefix={arXiv},
      primaryClass={physics.comp-ph},
      url={https://arxiv.org/abs/2606.19557},
}

Metadata

Release files for torchnep 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for torchnep 1.0.6
File Size Uploaded
torchnep-1.0.6.tar.gz 196.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for torchnep 1.0.6
File Interpreter ABI Platform
torchnep-1.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 402.9 kB

Release files / torchnep-1.0.6.tar.gz

Download URL torchnep-1.0.6.tar.gz
Size 196.8 kB
Tags Source
SHA-256 checksum
How to use checksums
08ac8237b5f1bf67a6a30b4a4281e541b448d7e6d68a811c63c83db29b217e20
BLAKE2b-256 checksum
How to use checksums
e3ccc19c7baa99b94d34e028a42b7507ec9ad5b3fab74848a7e22895193e0345
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log

Release files / torchnep-1.0.6-py3-none-any.whl

Download URL torchnep-1.0.6-py3-none-any.whl
Size 206.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
37cb2b2f8c6ee1d1d5cce672477e87e82e6919deac5682cb1724e1c688b67443
BLAKE2b-256 checksum
How to use checksums
f8ad8c74285d9d5e24856c6e1999be6641bf3bcdf8852a48f86661bae336e140
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page