Housekeeping: doc update, release, codecov, templates
- [x] Update the developer documentation to reflect new plugin design
- [x] Add BAND to the doc. (Formulating this more general for future services like KissKI or BioEngine)
- [x] Figure out what's going on with codecov, see #234.
- [x] Create an FAQ for the Documentation, to address common installation and performance issues, see #511
- [ ] Create issue (referencing FAQ) and PR templates (referencing the new Contributing section).
- [ ] Explain cache folder in doc, see #268
- [x] Add zenodo locations to the doc (after new versions of generalist models)
Add BAND to the doc. (Formulating this more general for future services like KissKI or BioEngine)
PR https://github.com/computational-cell-analytics/micro-sam/pull/250 might help with the first part of this (but not KissKI or BioEngine)
This is pointing the readme to docs/ instead of the actual directory doc/ FYI
Hi @claydugo ,
I am not quite sure what you mean by your commen. Where do we point to docs instead of doc?
Thanks!
In the README for the contributing and developer documentation links.
- [x] Adding PyTorch / CUDA Toolkit minimum version requirements (or tested ones) somewhere in the documentation (for finetuning and features requiring PyTorch) (?)
EDIT: Taken care of in FAQs.
Generating and uploading our micro-sam package to PyPI (heard some interests on this)
Edit: Hmm, now that I think about it, wouldn't be feasible because of vigra and nifty.
- Update
micro-samin BAND:- [ ] Update the logo
- [ ] Update the name: "usam" -> "µsam"
- [ ] Support the latest release (1.0.0 - as of 03.05.2024)