Skip to content

Commit fe5cf24

Browse files
committed
update doc for save potential
1 parent 6af3f77 commit fe5cf24

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/nep/input_parameters/save_potential.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ This keyword sets the number of of generations between writing a ``nep.txt`` che
99
If ``<format>`` is set to ``0`` the output file name is formatted as ``nep_gen[generation].txt``.
1010
If ``<format>`` is set to ``1`` the output file name is formatted as ``nep_y[year]_m[month]_d[day]_h[hour]_m[minute]_s[second]_generation[generation].txt``.
1111
These model files can be used to monitor the training progress of your model.
12+
Additionally, if ``<save_restart>`` is set to ``1`` the :ref:`nep.restart file <nep_restart>` is also written, following the naming format set by ``<format>``.
1213
Note that the :ref:`nep.restart file <nep_restart>` is the file that is required to continue training.
1314

1415
The syntax is::
1516

16-
save_potential <number_of_generations_between_save_potential> <format>
17+
save_potential <number_of_generations_between_save_potential> <format> <save_restart>
1718

1819
The default number of generations between saved model files is :math:`N=10^5` and the output file names use the extended format.

0 commit comments

Comments
 (0)