Spaces:
Running
Running
rearrange readme
Browse files- .github/README.md +4 -2
.github/README.md
CHANGED
@@ -26,14 +26,16 @@ If you have pretrained MLIP models that you would like to contribute to the MLIP
|
|
26 |
2. Follow the template to code the I/O interface for your model [here](../mlip_arena/models/README.md).
|
27 |
3. Update model [registry](../mlip_arena/models/registry.yaml) with metadata
|
28 |
|
29 |
-
> [!NOTE]
|
|
|
30 |
|
31 |
#### External ASE Calculator (easy)
|
32 |
|
33 |
1. Implement new ASE Calculator class in [mlip_arena/models/external.py](../mlip_arena/models/externals.py).
|
34 |
2. Name your class with awesome model name and add the same name to [registry](../mlip_arena/models/registry.yaml) with metadata.
|
35 |
|
36 |
-
> [!CAUTION]
|
|
|
37 |
|
38 |
### Add new benchmark tasks
|
39 |
|
|
|
26 |
2. Follow the template to code the I/O interface for your model [here](../mlip_arena/models/README.md).
|
27 |
3. Update model [registry](../mlip_arena/models/registry.yaml) with metadata
|
28 |
|
29 |
+
> [!NOTE]
|
30 |
+
> CPU benchmarking will be performed automatically. Due to the limited amount GPU compute, if you would like to be considered for GPU benchmarking, please create a pull request to demonstrate the offline performance of your model (published paper or preprint). We will review and select the models to be benchmarked on GPU.
|
31 |
|
32 |
#### External ASE Calculator (easy)
|
33 |
|
34 |
1. Implement new ASE Calculator class in [mlip_arena/models/external.py](../mlip_arena/models/externals.py).
|
35 |
2. Name your class with awesome model name and add the same name to [registry](../mlip_arena/models/registry.yaml) with metadata.
|
36 |
|
37 |
+
> [!CAUTION]
|
38 |
+
> Remove unneccessary outputs under `results` class attributes to avoid error for MD simulations. Please refer to other class definition for example.
|
39 |
|
40 |
### Add new benchmark tasks
|
41 |
|