bioimage-io / JDLL

The Java library to run Deep Learning models
https://github.com/bioimage-io/JDLL/wiki
Apache License 2.0
27 stars 6 forks source link

update developer guidelines for the library #12

Closed esgomezm closed 1 year ago

esgomezm commented 1 year ago

Hi @carlosuc3m @Stephane-D @constantinpape @oeway @lmoyasans @ivan-ea @tinevez

As discussed in previous meetings, it would be nice to have some minimal information about how to use this library. Just so others can integrate it as a backend. So, nothing really fancy but that is enough to start playing with it. How do you feel about it? could there be a way in which we could help collaboratively?

I have created an entry in the BioImage Model Zoo documentation [Resources for developers/Java BioImageIO library] that will display the readme file of this repository as soon as the repo becomes public.

@fjug @arrmunoz @dasv74 @constantinpape

carlosuc3m commented 1 year ago

Hello, I just uploaded the read me: https://github.com/bioimage-io/model-runner-java/blob/finish-first-iteration/README.md

Keep in mind that the librarry is still subjected to changes and until there is a stable version there might be some lag between the code updates and read.me updates.

Also if anyone has any sugestion, please comment on this issue or directly create a pull request. Regards Carlos