Skip to content

Commit 946eb07

Browse files
committed
update mlip names
1 parent c48bc7c commit 946eb07

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ Most recipes support different input formats, such as data file paths, `SMILES`
6464
6565
### Energy-Volume Curve
6666
67-
Compute an energy-volume curve using the `mp-1143` structure from the Materials Project and MLIPs such as `mace-mp`, `sevennet`, and `orb_v2`:
67+
Compute an energy-volume curve using the `mp-1143` structure from the Materials Project and MLIPs such as `mace-mpa-0`, `sevennet`, and `orb-v2`:
6868
6969
```bash
70-
mlipx recipes ev --models mace_mp,sevennet,orb_v2 --material-ids=mp-1143 --repro
70+
mlipx recipes ev --models mace-mpa-0,sevennet,orb-v2 --material-ids=mp-1143 --repro
7171
mlipx compare --glob "*EnergyVolumeCurve"
7272
```
7373
@@ -89,7 +89,7 @@ Below is an example of the resulting comparison:
8989
Compare the performance of different models in optimizing multiple molecular structures from `SMILES` representations:
9090

9191
```bash
92-
mlipx recipes relax --models mace_mp,sevennet,orb_v2 --smiles "CCO,C1=CC2=C(C=C1O)C(=CN2)CCN" --repro
92+
mlipx recipes relax --models mace-mpa-0,sevennet,orb-v2 --smiles "CCO,C1=CC2=C(C=C1O)C(=CN2)CCN" --repro
9393
mlipx compare --glob "*0_StructureOptimization"
9494
mlipx compare --glob "*1_StructureOptimization"
9595
```
@@ -102,7 +102,7 @@ mlipx compare --glob "*1_StructureOptimization"
102102
Run and compare nudged elastic band (NEB) calculations for a given start and end structure:
103103

104104
```bash
105-
mlipx recipes neb --models mace_mp,sevennet,orb_v2 --datapath ../data/neb_end_p.xyz --repro
105+
mlipx recipes neb --models mace-mpa-0,sevennet,orb-v2 --datapath ../data/neb_end_p.xyz --repro
106106
mlipx compare --glob "*NEBs"
107107
```
108108

docs/source/concept/metrics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ With the ``mlipx compare`` command, you can directly compare results from the sa
1111

1212
.. code-block:: bash
1313
14-
mlipx compare mace_mp_0_StructureOptimization orb_v2_0_StructureOptimization
14+
mlipx compare mace-mpa-0_StructureOptimization orb-v2_0_StructureOptimization
1515
1616
This allows you to study the performance of different models for a single task in great detail.
1717
Every Node in ``mlipx`` defines its own comparison method for this.

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Create a ``mlipx`` :ref:`recipe <recipes>` to compute :ref:`ev` for the `mp-1143
2424

2525
.. code-block:: console
2626
27-
(.venv) $ mlipx recipes ev --models mace_mp,sevennet,orb_v2 --material-ids=mp-1143 --repro
27+
(.venv) $ mlipx recipes ev --models mace-mpa-0,sevennet,orb-v2 --material-ids=mp-1143 --repro
2828
(.venv) $ mlipx compare --glob "*EnergyVolumeCurve"
2929
3030
and use the integration with :ref:`ZnDraw <zndraw>` to visualize the resulting trajectories and compare the energies interactively.

docs/source/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ visualize the trajectory together with the maximum force error in :ref:`ZnDraw <
1717

1818
.. code:: console
1919
20-
(.venv) $ mlipx recipes metrics --models mace_mp,sevennet,orb_v2 --datapath ../data DODH_adsorption_dft.xyz --repro
20+
(.venv) $ mlipx recipes metrics --models mace-mpa-0,sevennet,orb-v2 --datapath ../data DODH_adsorption_dft.xyz --repro
2121
(.venv) $ mlipx compare --glob "*CompareCalculatorResults"
2222
2323
.. toctree::

docs/source/quickstart/cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Create a file named ``models.py`` in the current directory with the following co
6666
},
6767
)
6868
69-
MODELS = {"mace_mp": mace_mp}
69+
MODELS = {"mace-mp": mace_mp}
7070
7171
.. note::
7272

@@ -109,7 +109,7 @@ To evaluate ``data.xyz`` with multiple models, you can also run
109109

110110
.. code-block:: console
111111
112-
(.venv) $ mlipx recipes metrics --datapath data.xyz --models mace_mp,sevennet,orb_v2,chgnet --repro
112+
(.venv) $ mlipx recipes metrics --datapath data.xyz --models mace_mp,sevennet,orb-v2,chgnet --repro
113113
114114
.. note::
115115

0 commit comments

Comments
 (0)