micro-sam icon indicating copy to clipboard operation
micro-sam copied to clipboard

Housekeeping: doc update, release, codecov, templates

Open constantinpape opened this issue 2 years ago • 7 comments

  • [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)

constantinpape avatar Oct 26 '23 06:10 constantinpape

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)

GenevieveBuckley avatar Oct 26 '23 23:10 GenevieveBuckley

This is pointing the readme to docs/ instead of the actual directory doc/ FYI

claydugo avatar Nov 03 '23 19:11 claydugo

Hi @claydugo , I am not quite sure what you mean by your commen. Where do we point to docs instead of doc? Thanks!

constantinpape avatar Nov 08 '23 08:11 constantinpape

In the README for the contributing and developer documentation links.

claydugo avatar Nov 08 '23 14:11 claydugo

  • [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.

anwai98 avatar Jan 10 '24 14:01 anwai98

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.

anwai98 avatar Feb 07 '24 14:02 anwai98

  • Update micro-sam in BAND:
    • [ ] Update the logo
    • [ ] Update the name: "usam" -> "µsam"
    • [ ] Support the latest release (1.0.0 - as of 03.05.2024)

anwai98 avatar May 03 '24 11:05 anwai98