NeuroBench / neurobench

Benchmark harness and baseline results for the NeuroBench algorithm track.
https://neurobench.readthedocs.io
Apache License 2.0
51 stars 12 forks source link

Finalize Documentation #92

Closed EssentiallyNoah closed 10 months ago

EssentiallyNoah commented 11 months ago

There's a lot of documentation polishing to do. A rough draft can be found in the documentation branch. A quick list of things that need to be done can be found under docs/readme.rst. Further edits to the documentation can be made here. This branch will be pulled into main on every major release.

jasonlyik commented 11 months ago

@AuroraMicheli is interested in helping out with this

jasonlyik commented 11 months ago

Check out branches:

korneelf1 commented 11 months ago

@AuroraMicheli, I see you have forked from the main branch. Be sure to fork from the dev branch as this is the branch where developments that will be pushed to the main (official release branch) are implemented.

AuroraMicheli commented 11 months ago

The docs/readme.rst file can be updated: at least the 1., 2., 3., 7., 10. points seem to be done at the moment.

thekatiedee commented 10 months ago

hey, it kinda looks like it's been covered already, but did you need any more documentation help? looking for ways to contribute. thanks!

EssentiallyNoah commented 10 months ago

@thekatiedee Thanks so much for being interested in contributing to the NeuroBench harness! We are currently only accepting contributions from the neuromorphic computing community but, when the harness is stable, we plan to open it up to contributions from the public.

EssentiallyNoah commented 10 months ago

Closing this to break out documentation changes into more granular tasks