From 663c019ea06abc3240db0beadc66c3146e9d716e Mon Sep 17 00:00:00 2001 From: mariana-gferreira <94363644+mariana-gferreira@users.noreply.github.com> Date: Tue, 7 May 2024 10:21:48 +0100 Subject: [PATCH] Updated the Resources for Developers (#389) --- docs/_sidebar.md | 2 -- docs/resources_developers/README.md | 20 +++++++++++++++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 48152774..2dd668e0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -15,8 +15,6 @@ - [Upload models through Zenodo](/contribute_models/contribute_zenodo.md) * [Other contributions](/contribute_others/README.md) * [Resources for developers](/resources_developers/README.md) - - [Python BioImageIO core package](pythoncorepackage) - - [Java BioImageIO library](javacorepackage) * [Consumer Software](/consumer_software/README.md) - [Tutorials](/consumer_software/tutorials.md) - [Model Runner](/consumer_software/model_runner.md) diff --git a/docs/resources_developers/README.md b/docs/resources_developers/README.md index 15527032..8415064a 100644 --- a/docs/resources_developers/README.md +++ b/docs/resources_developers/README.md @@ -1 +1,19 @@ -# Resources for developers \ No newline at end of file +# Resources for developers + +## Python resources +### [Python BioImageIO core package](https://github.com/bioimage-io/core-bioimage-io-python) + +The `bioimageio.core` is the main package to interact with the BioImageIO contents (*e.g.*, models, datasets, applications). It contains utilities to load and use BioimageIO resources such as processing images with BioImageIO models. + +Detailed documentation on the package can be found on [GitHub](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html), along with [example notebooks](https://github.com/bioimage-io/core-bioimage-io-python/tree/main/example). + +### [Python BioImageIO spec package](https://github.com/bioimage-io/spec-bioimage-io) + +The `bioimageio.spec` package enables the interaction with the BioImageIO Resource Description File (RDF) specifications for models, datasets, applications, and notebooks. It is a dependency of the [`bioimageio.core`](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html). This package contains the utilities for model metadata information handling. + +Detailed documentation on the package can be found on [GitHub](https://bioimage-io.github.io/spec-bioimage-io/bioimageio/spec.html), along with [example notebooks](https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_use). + +## Java resources +### [Java BioImageIO library](https://github.com/bioimage-io/JDLL) + +Detailed instructions on how to use the Java Deep Learning library can be found in the [Wiki guide](https://github.com/bioimage-io/JDLL/wiki/0.-Home), which also includes a [Quickstart](https://github.com/bioimage-io/JDLL/wiki/II.-Quickstart-for-developers) guide for developers. \ No newline at end of file