As new metrics get included (e.g., ActivationSparsityPerLayer #252), we should streamline the metrics documentation.
Currently, each included metric has a page written about it (https://github.com/NeuroBench/neurobench/tree/dev/docs/metrics),
but this is separate from the metric class docs (https://github.com/NeuroBench/neurobench/blob/dev/docs/neurobench.benchmarks.rst).
Also, because they are all on different pages, it makes it less easy to read.
To reorganize, we can probably either move all details from the separate pages into the class headers, deleting the separate pages, or we could otherwise combine all of the separate pages into one 'metrics information' page which can be easily parsed.
As new metrics get included (e.g., ActivationSparsityPerLayer #252), we should streamline the metrics documentation.
Currently, each included metric has a page written about it (https://github.com/NeuroBench/neurobench/tree/dev/docs/metrics),
but this is separate from the metric class docs (https://github.com/NeuroBench/neurobench/blob/dev/docs/neurobench.benchmarks.rst).
Also, because they are all on different pages, it makes it less easy to read.
To reorganize, we can probably either move all details from the separate pages into the class headers, deleting the separate pages, or we could otherwise combine all of the separate pages into one 'metrics information' page which can be easily parsed.