Skip to content

Commit a9829f7

Browse files
authored
docs: update README (#82)
1 parent 9201525 commit a9829f7

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ to install both of these additional packages.
4343

4444
The detailed code documentation that also contains descriptions for each benchmark and
4545
tutorials on how to use MLIPAudit as an applied user,
46-
can be found [here](https://instadeep.com/).
46+
can be found [here](https://instadeepai.github.io/mlipaudit/).
4747

4848
## 🚀 Usage
4949

@@ -87,7 +87,8 @@ single score that rates a model's performance on a benchmark on a scale of 0 to
8787

8888
For a tutorial on how to run models that are not native to the
8989
[mlip](https://github.com/instadeepai/mlip) library, see
90-
[this](https://instadeep.com/) section of our documentation.
90+
[this](https://instadeepai.github.io/mlipaudit/tutorials/cli/index.html#providing-external-models)
91+
section of our documentation.
9192

9293
### The graphical user interface
9394

@@ -116,13 +117,16 @@ example, the aforementioned `model.zip` file name would not work, but instead
116117

117118
Benchmarks can also be run on external models, provided either via the ASE calculator
118119
interface or the `ForceField` API for the [mlip](https://github.com/instadeepai/mlip)
119-
library. For more details, see our documentation [here](https://instadeep.com/).
120+
library. For more details, see our documentation
121+
[here](https://instadeepai.github.io/mlipaudit/tutorials/cli/index.html#providing-external-models).
120122

121123
### Library
122124

123-
As described in more detail in the [code documentation](https://instadeep.com/), the
125+
As described in more detail in the
126+
[code documentation](https://instadeepai.github.io/mlipaudit/), the
124127
benchmark classes can also be easily imported into your own Python code base.
125-
Especially, check out the [API reference](https://instadeep.com/) of our
128+
Especially, check out the
129+
[API reference](https://instadeepai.github.io/mlipaudit/api_reference/) of our
126130
documentation for details on the available functions.
127131

128132
You can use these functions to build your own benchmarking script and GUI pages for our
@@ -182,7 +186,8 @@ You can then open the `index.html` file in your browser to view the documentatio
182186

183187
## 🙏 Acknowledgments
184188

185-
We would like to acknowledge beta testers for this library.
189+
We would like to acknowledge beta testers for this library: Marco Carobene,
190+
Massimo Bortone, Jack Sawdon, Olivier Peltre and Alex Laterre.
186191

187192
## 📚 Citing our work
188193

0 commit comments

Comments
 (0)