cbg-ethz / bmi

Mutual information estimators and benchmark
https://cbg-ethz.github.io/bmi/
MIT License
26 stars 4 forks source link

standard benchmark proposal #150

Closed grfrederic closed 4 months ago

grfrederic commented 4 months ago

This PR standardizes running benchmarks. In particular, it changes the workflow structure and improves the documentation.

a-marx commented 4 months ago

Looks great! A few suggestions and pointers. I assume that some of them are on the Todo list anyways.

Notes to README.me:

The config workflow file is easy to understand; thats good :)

What is currently missing is the "How to add your estimator" part. But from what is there, it is clear how to evaluate the implemented estimators.