Skip to content

Commit 48979ca

Browse files
authored
Update README with model engine change and cache info
Clarified the model engine switch and provided cache clearing instructions.
1 parent b04a145 commit 48979ca

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,13 @@ pip install shiftml
5555
### Known installation issues
5656
The following installation issues are known:
5757
- Old Intel-based Macs are not supported, because torch does not support them anymore (building torch binaries).
58+
- We have switched recently the model engine from "metatensor.atomistic" to "metatomic". This is only a namespace issue and does not affect the models.
59+
**If you receive a "Not a metatomic model" error message** you probably had an earlier ShiftML release installed and the old versions model files remain in cache.
60+
In order to **clear the cache once**, please load the model once and overwrite the cache:
61+
62+
```python
63+
calculator = ShiftML("ShiftML3", force_download=True)
64+
```
5865

5966
## The code that makes it work
6067

0 commit comments

Comments
 (0)