Skip to content

Commit f3acfbc

Browse files
authored
Update README.md (#45)
1 parent 8e958bf commit f3acfbc

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@
1717
MatterSim is a deep learning atomistic model across elements, temperatures and pressures.
1818

1919
## Documentation
20+
2021
This README provides a quick start guide. For more comprehensive information, please refer to the [MatterSim documentation](https://microsoft.github.io/mattersim/).
2122

2223
## Installation
24+
2325
### Prerequisite
2426
* Python==3.9
2527

@@ -70,6 +72,7 @@ python setup.py build_ext --inplace
7072
```
7173

7274
## Usage
75+
7376
### A minimal test
7477
```python
7578
import torch
@@ -98,6 +101,7 @@ MatterSimCalculator(load_path="MatterSim-v1.0.0-5M.pth", device=device)
98101

99102

100103
## Reference
104+
101105
We kindly request that users of MatterSim version 1.0.0 cite our preprint available on arXiv:
102106
```
103107
@article{yang2024mattersim,
@@ -116,6 +120,7 @@ We kindly request that users of MatterSim version 1.0.0 cite our preprint availa
116120
> We kindly ask users to **explicitly** specify the exact model version and checkpoint (e.g., **MatterSim-v1.0.0-1M**) when reporting results in academic papers or technical reports, rather than referring to the model generically as **MatterSim**. Precise versioning is crucial for ensuring reproducibility. For instance, the statement "_This study was conducted using MatterSim-v1.0.0-1M_" serves as a good example.
117121
118122
## Limitations
123+
119124
**MatterSim-v1** is designed specifically for atomistic simulations of bulk materials. Applications or interpretations beyond this scope should be approached with caution. For instance, when using the model for simulations involving surfaces, interfaces, or properties influenced by long-range interactions, the results may be qualitatively accurate but are not suitable for quantitative analysis. In such cases, we recommend fine-tuning the model to better align with the specific application.
120125

121126
## Trademarks
@@ -126,6 +131,7 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
126131
Any use of third-party trademarks or logos are subject to those third-party's policies.
127132

128133
## Responsible AI Transparency Documentation
134+
129135
The responsible AI transparency documentation can be found [here](MODEL_CARD.md).
130136

131137

0 commit comments

Comments
 (0)