Parameter details
本节介绍了所有模型中可由用户定义的参数,可以分为必要参数和高级参数两类。必要参数需要用户指定,高级参数采用了默认值,用户可以在 json 文件中根据需求手动修改。在下面的参数中,"相对路径(relative path)" 表示相对于当前工作目录的路径,而 "绝对路径(absolute path)" 表示从根目录开始的文件或目录的完整路径。
必要参数
对于任何模型,以下参数需要用户输入。
model_type
该参数用于指定用于训练的模型类型。您可以使用LINEAR
模型、NN
模型、DP
模型或 NEP
模型。
atom_type
该参数用于设置训练体系的元素类型。用户可以按照任意顺序指定元素的原子序数。例如,对于单元素系统如铜,可以设置为 [29],而对于多元素系统如 CH4,则可以设置为 [1, 6]。您也可以使用元素类型的名称,例如["Cu"] 或者 ["H", "C"]。
max_neigh_num
最大邻居数,其默认值为100
。然而,对于某些系统来说,这个值可能不足以容纳所有的邻居,导致特征生成失败。在这种情况下,将会弹出以下警告信息:
Error! maxNeighborNum too small
在该情况下,请调大该值。
raw_files
该参数用于指定训练任务的分子动力学轨迹文件所在的路径。您可以使用相对路径或绝对路径。
- 对于 DP 和 NEP 模型,支持的文件格式有 PWmat, VASP, CP2K (对应
format
参数为pwmat/movement
,vasp/outcar
,cp2k/md
) - 对于 LINEAR 和 NN 模型,仅支持
pwmat/movement
格式
format
该与 raw_files
配合使用,参数用于指定原始轨迹文件的格式,默认值为 pwmat/movement
。 PWmat, VASP, CP2K 对应 format
参数分别为 pwmat/movement
, vasp/outcar
, cp2k/md
。
datasets_path
该参数用于 DP 和 NEP 模型,用于指定 pwmlff/npy
格式的数据所在路径。对于 DP 和 NEP 模型,如果指定了raw_files
,在训练或者测试中会把raw_files
中的轨迹自动转换为pwmlff/npy
格式。转换工具为 PWDATA
。
train_movement_file
该参数在PWMLFF-2025.5之前的版本
中,用于 LINEAR 和 NN 模型做训练,提供 movement 文件路径。当前版本(2024.5)已经修改为raw_files
,并且兼容该参数,即您可以使用train_movement_file
或者 raw_files
皆可。
test_movement_file
该参数在PWMLFF-2025.5之前的版本
中,用于 LINEAR 和 NN 模型做测试,提供 movement 文件路径。当前版本(2024.5)已经修改为raw_files
,并且兼容该参数,即您可以使用test_movement_file
或者 raw_files
皆可。
model_load_file
该参数用于指定用于测试
任务的模型所在的路径。
高级参数
用户只需要设置必要参数即可完成模型的训练、测试和相关分子动力学过程。相应的高级参数,如模型超参数和优化器超参数,将被设置为默认值。这些高级参数也可以在 json 文件中进行设置。