Skip to content

Commit

Permalink
Update README.md (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
yanghan234 authored Dec 3, 2024
1 parent 8e958bf commit f3acfbc
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
MatterSim is a deep learning atomistic model across elements, temperatures and pressures.

## Documentation

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

## Installation

### Prerequisite
* Python==3.9

Expand Down Expand Up @@ -70,6 +72,7 @@ python setup.py build_ext --inplace
```

## Usage

### A minimal test
```python
import torch
Expand Down Expand Up @@ -98,6 +101,7 @@ MatterSimCalculator(load_path="MatterSim-v1.0.0-5M.pth", device=device)


## Reference

We kindly request that users of MatterSim version 1.0.0 cite our preprint available on arXiv:
```
@article{yang2024mattersim,
Expand All @@ -116,6 +120,7 @@ We kindly request that users of MatterSim version 1.0.0 cite our preprint availa
> 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.
## Limitations

**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.

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

## Responsible AI Transparency Documentation

The responsible AI transparency documentation can be found [here](MODEL_CARD.md).


Expand Down

0 comments on commit f3acfbc

Please sign in to comment.