Use dp pretrained to download built-in models

4.26. Use dp pretrained to download built-in models#

The dp pretrained command provides a simple way to download built-in pre-trained models and store them in a local cache.

4.26.1. Command syntax#

dp pretrained download <MODEL> [--cache-dir <PATH>]

  • <MODEL>: the built-in model name.

  • --cache-dir <PATH>: optional cache directory. If omitted, DeePMD-kit uses the default cache path.

4.26.2. Available built-in models#

You can run dp pretrained download -h to see the currently supported model list in your installed version.

Examples in this release include:

  • DPA-3.2-5M

  • DPA-3.1-3M

  • DPA3-Omol-Large

4.26.3. Examples#

# Download to default cache directory
dp pretrained download DPA-3.2-5M

# Download to a custom cache directory
dp pretrained download DPA-3.2-5M --cache-dir ./models

The command prints the local path of the downloaded model file on success.

4.26.4. Use downloaded models in DeepPot#

Using DeepPot, you do not have to run dp pretrained download first.

Pass the built-in model name directly:

from deepmd.infer import DeepPot

pot = DeepPot("DPA-3.2-5M")

If the model file is not already present in the local cache, DeePMD-kit will download and cache it automatically when resolving the model name.

Built-in model names are user-facing selectors; backend details are handled internally.