@@ -125,7 +125,7 @@ Here is an example of a very minimal new benchmark implementation:
125125
126126
127127 The data loading as a cached property is only recommended if the loaded data
128- is need in both the `run_model() ` and the `analyze() ` functions.
128+ is needed in both the `run_model() ` and the `analyze() ` functions.
129129
130130Note that the functions `_compute_energies_blackbox ` and `_analyze_blackbox ` are
131131placeholders for the actual implementations.
@@ -195,12 +195,8 @@ automatically picked up and displayed.
195195How to run the new benchmark
196196^^^^^^^^^^^^^^^^^^^^^^^^^^^^
197197
198- New benchmarks cannot just be added to the existing ones when executing
199- the CLI tools `mlipaudit ` and `mlipauditapp `.
200-
201- To add a new benchmark, we recommend to make a copy of our `src/mlipaudit/main.py ` and
202- `src/mlipaudit/app.py ` scripts and add your new benchmark in there to run all
203- existing benchmarks together with your new one. In the main script, the new benchmark
204- just needs to be added to the `BENCHMARKS ` constant. For the UI app, this is
205- required as well, however, you also need to add a call to the new UI page function to
206- the `main() ` function of `src/mlipaudit/app.py `.
198+ Note that as you need to modify some existing source code files of *mlipaudit *
199+ to include your new benchmarks, this cannot be achieved purely with the pip installed
200+ library, however, we recommend to clone or fork our repository and run this local
201+ version instead after adding your own benchmarks with minimal code changes, as explained
202+ above.
0 commit comments