Skip to content

Commit adcd797

Browse files
authored
Merge pull request #364 from anyangml2nd/doc/update-readme
Doc: update readme and task name
2 parents 172d666 + 0d6c945 commit adcd797

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ The optional dependencies are required for the corresponding models.
3131

3232
## Usage
3333

34-
To reproduce the results locally or test a custom model, please refer to the `ASEModel.evaluate` method.
34+
To reproduce the results locally or test a custom model, please refer to the `ASEModel.evaluate` method. The test data can be found [here](https://aissquare.com/datasets/detail?pageType=datasets&name=LAMBench-DatasetCards&id=336).
3535

36-
- For direct prediction tasks, you can use the staticmethod `run_ase_dptest(calc: Calculator, test_data: Path) -> dict`. The test data can be found [here](https://www.aissquare.com/datasets/detail?pageType=datasets&name=LAMBench-TestData-v1&id=295).
36+
- For direct prediction tasks, you can use the staticmethod `run_ase_dptest(calc: Calculator, test_data: Path) -> dict`.
3737
- For calculator tasks, you can use the corresponding scripts provided in `lambench.tasks.calculator`.
38-
- The phonon test data can be found [here](https://www.aissquare.com/datasets/detail?pageType=datasets&name=LAMBench-Phonon-MDR&id=310).
3938
- An `ASEModel` object is needed for such tasks; you can create a dummy model as follows:
4039

4140
```python

lambench/metrics/results/metadata.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@
643643
"DISPLAY_NAME":"Generalizability Tests (Property Calculation)",
644644
"DESCRIPTION": "Evaluation metrics for domain specific property calculation tasks when utilizing the LAM as the force field.",
645645
"phonon_mdr": {
646-
"DISPLAY_NAME": "Phonon Properties",
646+
"DISPLAY_NAME": "Phonon MDR",
647647
"DESCRIPTION": "Evaluation metrics based on phonon calculations.",
648648
"mae_entropy": {
649649
"DISPLAY_NAME": "Entropy MAE (J/K/mol)",
@@ -667,7 +667,7 @@
667667
}
668668
},
669669
"torsionnet": {
670-
"DISPLAY_NAME": "Torsional Barrier",
670+
"DISPLAY_NAME": "TorsionNet500",
671671
"DESCRIPTION": "Evaluation of torsional barrier related metrics on the TorsionNet-500 dataset at the CCSD(T)/CBS level.",
672672
"MAE": {
673673
"DISPLAY_NAME": "MAE (kcal/mol)",
@@ -687,8 +687,8 @@
687687
}
688688
},
689689
"neb": {
690-
"DISPLAY_NAME": "NEB",
691-
"DESCRIPTION": "Evaluation of NEB related metrics on the OC20NEB-OOD dataset. The dataset contains 460 NEB trajectories over 3 types of reactions: desorption, dissociation, and transfer. For details, please refer to https://arxiv.org/abs/2405.02078. The energy barrier height is calculated with single point energy prediction on DFT relaxed structures using the LAM model without performing NEB optimization.",
690+
"DISPLAY_NAME": "OC20NEB-OOD",
691+
"DESCRIPTION": "Evaluation of energy barrier related metrics on the OC20NEB-OOD dataset. The dataset contains 460 NEB trajectories over 3 types of reactions: desorption, dissociation, and transfer. For details, please refer to https://arxiv.org/abs/2405.02078. The energy barrier height is calculated with single point energy prediction on DFT relaxed structures using the LAM model without performing NEB optimization.",
692692
"MAE_Ea": {
693693
"DISPLAY_NAME": "MAE_Ea (eV)",
694694
"DESCRIPTION": "The mean absolute error of the energy barrier prediction across all OOD trajectories."

0 commit comments

Comments
 (0)