Skip to content

Commit

Permalink
mention AQE in docs (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
yanghan234 authored Dec 6, 2024
1 parent 171838d commit 92af875
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,21 @@ uv pip install -e .
python setup.py build_ext --inplace
```

## Pre-trained Models

We currently offer two pre-trained **MatterSim-v1** models based on the **M3GNet** architecture in the [pretrained_models](./pretrained_models/) folder:

1. **MatterSim-v1.0.0-1M**: A mini version of the model that is faster to run.
2. **MatterSim-v1.0.0-5M**: A larger version of the model that is more accurate.

These models have been trained using the data generated through the workflows
introduced in the [MatterSim manuscript](https://arxiv.org/abs/2405.04967), which provides an in-depth
explanation of the methodologies underlying the MatterSim model.

More advanced and fully-supported pretrained versions of MatterSim,
and additional materials capabilities are available in
**[Azure Quantum Elements](https://quantum.microsoft.com/en-us/solutions/azure-quantum-elements)**.

## Usage

> [!TIP]
Expand Down
4 changes: 4 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ These models have been trained using the data generated through the workflows
introduced in the `MatterSim <https://arxiv.org/abs/2405.04967>`_ manuscript, which provides an in-depth
explanation of the methodologies underlying the MatterSim model.

More advanced and fully-supported pretrained versions of MatterSim,
and additional materials capabilities are available in
`Azure Quantum Elements <https://quantum.microsoft.com/en-us/solutions/azure-quantum-elements>`_.

Bibliography
------------

Expand Down

0 comments on commit 92af875

Please sign in to comment.