deploy: d19370d

microsoft · Jan 15, 2025 · 6fc6464 · 6fc6464
1 parent 86b9f5f
commit 6fc6464
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/_sources/user_guide/finetune.rst b/_sources/user_guide/finetune.rst
@@ -83,4 +83,16 @@ You can replace the data path with your own data path.
 
 .. code-block:: bash
 
-    torchrun --nproc_per_node=1 src/mattersim/training/finetune_mattersim.py --load_model_path mattersim-v1.0.0-1m --train_data_path xyz_files/train.xyz --valid_data_path xyz_files/valid.xyz --batch_size 16 --lr 2e-4 --step_size 20 --epochs 200 --save_path ./finetune_result --save_checkpoint --ckpt_interval 20 --include_stresses --include_forces
+    torchrun --nproc_per_node=1 src/mattersim/training/finetune_mattersim.py \
+                                --load_model_path mattersim-v1.0.0-1m \
+                                --train_data_path xyz_files/train.xyz \
+                                --valid_data_path xyz_files/valid.xyz \
+                                --batch_size 16 \
+                                --lr 2e-4 \
+                                --step_size 20 \ 
+                                --epochs 200 \ 
+                                --save_path ./finetune_result \ 
+                                --save_checkpoint \ 
+                                --ckpt_interval 20 \ 
+                                --include_stresses \ 
+                                --include_forces
diff --git a/user_guide/finetune.html b/user_guide/finetune.html
@@ -381,7 +381,19 @@ <h2>Finetune Parameters<a class="headerlink" href="#finetune-parameters" title="
 <section id="finetune-example">
 <h2>Finetune Example<a class="headerlink" href="#finetune-example" title="Link to this heading">#</a></h2>
 <p>You can replace the data path with your own data path.</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">1</span><span class="w"> </span>src/mattersim/training/finetune_mattersim.py<span class="w"> </span>--load_model_path<span class="w"> </span>mattersim-v1.0.0-1m<span class="w"> </span>--train_data_path<span class="w"> </span>xyz_files/train.xyz<span class="w"> </span>--valid_data_path<span class="w"> </span>xyz_files/valid.xyz<span class="w"> </span>--batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span>--lr<span class="w"> </span>2e-4<span class="w"> </span>--step_size<span class="w"> </span><span class="m">20</span><span class="w"> </span>--epochs<span class="w"> </span><span class="m">200</span><span class="w"> </span>--save_path<span class="w"> </span>./finetune_result<span class="w"> </span>--save_checkpoint<span class="w"> </span>--ckpt_interval<span class="w"> </span><span class="m">20</span><span class="w"> </span>--include_stresses<span class="w"> </span>--include_forces
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">1</span><span class="w"> </span>src/mattersim/training/finetune_mattersim.py<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--load_model_path<span class="w"> </span>mattersim-v1.0.0-1m<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--train_data_path<span class="w"> </span>xyz_files/train.xyz<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--valid_data_path<span class="w"> </span>xyz_files/valid.xyz<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--lr<span class="w"> </span>2e-4<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--step_size<span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--epochs<span class="w"> </span><span class="m">200</span><span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--save_path<span class="w"> </span>./finetune_result<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--save_checkpoint<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--ckpt_interval<span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--include_stresses<span class="w"> </span><span class="se">\</span>
+<span class="w">                            </span>--include_forces
 </pre></div>
 </div>
 </section>