Skip to content

Commit 6d9de9b

Browse files
committed
add documentation to getting-started
1 parent de6e5b6 commit 6d9de9b

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

doc/getting-started.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ If enbled in json/yaml input file DeePMD-kit will create log files which can be
140140
used to analyze training procedure with Tensorboard. For a short tutorial
141141
please read this [document](tensorboard.md).
142142

143-
## Freeze a model
143+
##reeze a model
144144

145145
The trained neural network is extracted from a checkpoint and dumped into a database. This process is called "freezing" a model. The idea and part of our code are from [Morgan](https://blog.metaflow.fr/tensorflow-how-to-freeze-a-model-and-serve-it-with-a-python-api-d4f3596b3adc). To freeze a model, typically one does
146146
```bash
@@ -306,6 +306,8 @@ The model compression method requires that the version of DeePMD-kit used in ori
306306
307307
## Model inference
308308
309+
Note that the model for inference is required to be compatible with the DeePMD-kit package. See [Model compatibility](troubleshooting/model-compatability.md) for details.
310+
309311
### Python interface
310312
One may use the python interface of DeePMD-kit for model inference, an example is given as follows
311313
```python
@@ -360,6 +362,8 @@ and then run the program:
360362
361363
## Run MD
362364
365+
Note that the model for MD simulations is required to be compatible with the DeePMD-kit package. See [Model compatibility](troubleshooting/model-compatability.md) for details.
366+
363367
### Run MD with LAMMPS
364368
Include deepmd in the pair_style
365369

0 commit comments

Comments
 (0)