cyrusyc commited on
Commit
34e261b
·
1 Parent(s): 072f65e

readme update

Browse files
Files changed (2) hide show
  1. .github/README.md +35 -18
  2. pyproject.toml +1 -1
.github/README.md CHANGED
@@ -1,6 +1,6 @@
1
  <div align="center">
2
  <h1>MLIP Arena</h1>
3
- <img alt="Static Badge" src="https://img.shields.io/badge/ICLR-AI4Mat-blue?link=https%3A%2F%2Fopenreview.net%2Fforum%3Fid%3DysKfIavYQE">
4
  <a href="https://huggingface.co/spaces/atomind/mlip-arena"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Space-blue" alt="Hugging Face"></a>
5
  <a href="https://github.com/atomind-ai/mlip-arena/actions"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/atomind-ai/mlip-arena/test.yaml"></a>
6
  <a href="https://pypi.org/project/mlip-arena/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/mlip-arena"></a>
@@ -18,7 +18,7 @@ MLIP Arena leverages modern pythonic workflow orchestrator [Prefect](https://www
18
 
19
  ## Announcement
20
 
21
- - **[April 8, 2025]** [🎉 MLIP Arena accepted as an ICLR AI4Mat Spotlight! 🎉](https://openreview.net/forum?id=ysKfIavYQE#discussion) Huge thanks to all co-authors for their contributions!
22
 
23
 
24
  ## Installation
@@ -31,7 +31,8 @@ pip install mlip-arena
31
 
32
  ### From source
33
 
34
- > [!Caution] We recommand to start from clean virtual environment due to the compatibility issues between multiple popular MLIPs. We provide one script installation script using uv for minimal package conflicts and fast installation!
 
35
 
36
  **Linux**
37
 
@@ -68,7 +69,7 @@ bash scripts/install-macosx.sh
68
 
69
  ## Quickstart
70
 
71
- ### First example: Molecular dynamics
72
 
73
  Arena provides a unified interface to run all the compiled MLIPs. This can be achieved simply by looping through `MLIPEnum`:
74
 
@@ -102,21 +103,9 @@ for model in MLIPEnum:
102
  results.append(result)
103
  ```
104
 
105
- ### List of implemented tasks
106
 
107
- The implemented tasks are available under `mlip_arena.tasks.<module>.run` or `from mlip_arena.tasks import *` for convenient imports (currently doesn't work if [phonopy](https://phonopy.github.io/phonopy/install.html) is not installed).
108
-
109
- - [OPT](../mlip_arena/tasks/optimize.py#L56): Structure optimization
110
- - [EOS](../mlip_arena/tasks/eos.py#L42): Equation of state (energy-volume scan)
111
- - [MD](../mlip_arena/tasks/md.py#L200): Molecular dynamics with flexible dynamics (NVE, NVT, NPT) and temperature/pressure scheduling (annealing, shearing, *etc*)
112
- - [PHONON](../mlip_arena/tasks/phonon.py#L110): Phonon calculation driven by [phonopy](https://phonopy.github.io/phonopy/install.html)
113
- - [NEB](../mlip_arena/tasks/neb.py#L96): Nudged elastic band
114
- - [NEB_FROM_ENDPOINTS](../mlip_arena/tasks/neb.py#L164): Nudge elastic band with convenient image interpolation (linear or IDPP)
115
- - [ELASTICITY](../mlip_arena/tasks/elasticity.py#L78): Elastic tensor calculation
116
-
117
- ### 🚀 Parallelize Benchmark at Scale
118
-
119
- To run multiple benchmarks in parallel, add `.submit` before the task function and wrap all the tasks into a flow to concurrently dispatch the tasks to worker. (see Prefect Doc on [tasks](https://docs.prefect.io/v3/develop/write-tasks) and [flow](https://docs.prefect.io/v3/develop/write-flows) for details)
120
 
121
  ```python
122
  ...
@@ -138,6 +127,18 @@ def run_all_tasks:
138
 
139
  For a more practical example, please now refer to [MOF classification](../examples/mof/classification/classification.py).
140
 
 
 
 
 
 
 
 
 
 
 
 
 
141
  ## Contribute
142
 
143
  MLIP Arena is now in pre-alpha. If you're interested in joining the effort, please reach out to Yuan at [[email protected]](mailto:[email protected]).
@@ -197,3 +198,19 @@ The "ultimate" goal is to compile the copies of all the open data in a unified f
197
 
198
  - [ ] [MD17](http://www.sgdml.org/#datasets)
199
  - [ ] [MD22](http://www.sgdml.org/#datasets) -->
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  <div align="center">
2
  <h1>MLIP Arena</h1>
3
+ <a href="https://openreview.net/forum?id=ysKfIavYQE#discussion"><img alt="Static Badge" src="https://img.shields.io/badge/ICLR-AI4Mat-blue"></a>
4
  <a href="https://huggingface.co/spaces/atomind/mlip-arena"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Space-blue" alt="Hugging Face"></a>
5
  <a href="https://github.com/atomind-ai/mlip-arena/actions"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/atomind-ai/mlip-arena/test.yaml"></a>
6
  <a href="https://pypi.org/project/mlip-arena/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/mlip-arena"></a>
 
18
 
19
  ## Announcement
20
 
21
+ - **[April 8, 2025]** [🎉 **MLIP Arena accepted as an ICLR AI4Mat Spotlight!** 🎉](https://openreview.net/forum?id=ysKfIavYQE#discussion) Huge thanks to all co-authors for their contributions!
22
 
23
 
24
  ## Installation
 
31
 
32
  ### From source
33
 
34
+ > [!CAUTION]
35
+ > We recommand to start from clean virtual environment due to the compatibility issues between multiple popular MLIPs. We provide one script installation script using uv for minimal package conflicts and fast installation!
36
 
37
  **Linux**
38
 
 
69
 
70
  ## Quickstart
71
 
72
+ ### The first example: Molecular Dynamics
73
 
74
  Arena provides a unified interface to run all the compiled MLIPs. This can be achieved simply by looping through `MLIPEnum`:
75
 
 
103
  results.append(result)
104
  ```
105
 
106
+ ### 🚀 Parallelize Benchmarks at Scale
107
 
108
+ To run multiple benchmarks in parallel, add `.submit` before the task function and wrap all the tasks into a flow to dispatch the tasks to worker for concurrent execution. See Prefect Doc on [tasks](https://docs.prefect.io/v3/develop/write-tasks) and [flow](https://docs.prefect.io/v3/develop/write-flows) for more details.
 
 
 
 
 
 
 
 
 
 
 
 
109
 
110
  ```python
111
  ...
 
127
 
128
  For a more practical example, please now refer to [MOF classification](../examples/mof/classification/classification.py).
129
 
130
+ ### List of implemented tasks
131
+
132
+ The implemented tasks are available under `mlip_arena.tasks.<module>.run` or `from mlip_arena.tasks import *` for convenient imports (currently doesn't work if [phonopy](https://phonopy.github.io/phonopy/install.html) is not installed).
133
+
134
+ - [OPT](../mlip_arena/tasks/optimize.py#L56): Structure optimization
135
+ - [EOS](../mlip_arena/tasks/eos.py#L42): Equation of state (energy-volume scan)
136
+ - [MD](../mlip_arena/tasks/md.py#L200): Molecular dynamics with flexible dynamics (NVE, NVT, NPT) and temperature/pressure scheduling (annealing, shearing, *etc*)
137
+ - [PHONON](../mlip_arena/tasks/phonon.py#L110): Phonon calculation driven by [phonopy](https://phonopy.github.io/phonopy/install.html)
138
+ - [NEB](../mlip_arena/tasks/neb.py#L96): Nudged elastic band
139
+ - [NEB_FROM_ENDPOINTS](../mlip_arena/tasks/neb.py#L164): Nudge elastic band with convenient image interpolation (linear or IDPP)
140
+ - [ELASTICITY](../mlip_arena/tasks/elasticity.py#L78): Elastic tensor calculation
141
+
142
  ## Contribute
143
 
144
  MLIP Arena is now in pre-alpha. If you're interested in joining the effort, please reach out to Yuan at [[email protected]](mailto:[email protected]).
 
198
 
199
  - [ ] [MD17](http://www.sgdml.org/#datasets)
200
  - [ ] [MD22](http://www.sgdml.org/#datasets) -->
201
+
202
+
203
+ ## Citation
204
+
205
+ If you find the work useful, please consider citing the following:
206
+
207
+ ```bibtex
208
+ @inproceedings{
209
+ chiang2025mlip,
210
+ title={{MLIP} Arena: Advancing Fairness and Transparency in Machine Learning Interatomic Potentials through an Open and Accessible Benchmark Platform},
211
+ author={Yuan Chiang and Tobias Kreiman and Elizabeth Weaver and Ishan Amin and Matthew Kuner and Christine Zhang and Aaron Kaplan and Daryl Chrzan and Samuel M Blau and Aditi S. Krishnapriyan and Mark Asta},
212
+ booktitle={AI for Accelerated Materials Design - ICLR 2025},
213
+ year={2025},
214
+ url={https://openreview.net/forum?id=ysKfIavYQE}
215
+ }
216
+ ```
pyproject.toml CHANGED
@@ -4,7 +4,7 @@ build-backend="flit_core.buildapi"
4
 
5
  [project]
6
  name="mlip-arena"
7
- version="0.0.1a2"
8
  authors=[
9
  {name="Yuan Chiang", email="[email protected]"},
10
  ]
 
4
 
5
  [project]
6
  name="mlip-arena"
7
+ version="0.1.0"
8
  authors=[
9
  {name="Yuan Chiang", email="[email protected]"},
10
  ]