Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BioImage Model Zoo Documentation #441

Merged
merged 16 commits into from
Feb 3, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updates on tools and resources
cfusterbarcelo committed Jan 23, 2025
commit 22cb473374e79441e869251c0328846fd4574891
47 changes: 27 additions & 20 deletions docs/tools_and_resources/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
# Tools and Resources
In this part of the documentation different tools and resources and its documentation can be found.
In this part of the documentation different tools and resources related to the BioImage Model can be found with their documentation.

* **[DL4MicEverywhere](tools_and_resources/dl4miceverywhere.md)**: DL4MicEverywhere is a platform that offers researchers an easy-to-use gateway to cutting-edge deep learning techniques for bioimage analysis. It features interactive Jupyter notebooks with user-friendly graphical interfaces that require no coding skills. The platform utilizes Docker containers to ensure portability and reproducibility, guaranteeing smooth operation across various computing environments.
* **[BioImage.IO Chatbot](tools_and_resources/bioimageiochatbot.md)**: The BioImage.IO Chatbot is a versatile conversational agent designed to assist users in accessing information related to bioimage analysis. It leverages the power of Large Language Models (LLMs) and integrates user-specific data to provide contextually accurate and personalized responses. Whether you're a researcher, developer, or scientist, the chatbot is here to make your bioimage analysis journey smoother and more informative.
* **[Python BioImage.IO Core Package](tools_and_resources/bioimageio-core-package.md)**: Learn how to leverage the Python BioImage.IO Core Package, an essential toolkit for integrating and using bioimaging models and datasets in Python environments.
* **[Java Deep Learning Library](tools_and_resources/jdll.md)**: Explore the capabilities of the Java Deep Learning Library (JDLL), a comprehensive Java-based library designed for building and deploying deep learning models in bioimaging.
* **[BioEngine](tools_and_resources/bioengine.md)**: Initially designed to support the BioImage Model Zoo (https://bioimage.io) for effortless model testing, BioEngine empowers both experts and newcomers in the field of bioimage analysis. This cloud-based infrastructure brings AI to the next level by offering a user-friendly, plug-and-play cloud solution that not only simplifies model testing but also pioneers next-generation bioimage analysis capabilities.
## Developer Resources
### Python BioImage.IO Core Package
`bioimageio.core` is a python package that implements prediction with bioimageio models including standardized pre- and postprocessing operations. These models are described by---and can be loaded with---the bioimageio.spec package.
In addition bioimageio.core provides functionality to convert model weight formats.

## DL4MicEverywhere
TBD
You can find the documentation about the bioimageio.core [here](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html).
And the GitHub repository [here](https://github.com/bioimage-io/core-bioimage-io-python/).

## BioImage.IO Chatbot
TBD
### Java Deep Learning Library
The Java Deep Learning Library (JDLL) provides a Java library for running Deep Learning (DL) models agnostically, enabling communication between Java software and various DL frameworks (engines). It also allows the use of multiple DL frameworks in the same session, manages the different DL frameworks and brings the models from the Bioimage.io repository to Java.

## Python BioImage.IO Core Package
TBD
Documentation can be foun [here](https://github.com/bioimage-io/JDLL).

## Java Deep Learning Library
TBD

## BioEngine
### Building BioEngine Apps
### BioEngine
A resource that interacts with the BioImage Model Zoo intended for infraestructure developers.
#### Building BioEngine Apps
We use BioEngine, a tailored version of [ImJoy](https://imjoy.io) to run models applications. Therefore, you can basically run ImJoy plugins with the BioEngine specific api.

Depending on different types of application, for web application, please refer to [here](https://github.com/imjoy-team/imjoy-core#use-your-web-application-inside-imjoy) for integrating the `imjoy-rpc` with your web app. Once done you can simply set `source` in the [`Resource Description File`](/bioimageio_rdf_spec) to your web app url.
@@ -66,18 +62,29 @@ To test with the BioEngine, you can go to https://bioimage.io, on the menu locat

TIP: if your imjoy plugin is designed for not only work with bioimage.io but also other purposes, you can use an `if` statement to check `ctx.config.type == 'bioengine'`.

### Make a standalone web app compatible with ImJoy/BioEngine
#### Make a standalone web app compatible with ImJoy/BioEngine

Making an ImJoy plugin is not the only way to support the BioEngine, if you have already a web application or website, you can easily load a `imjoy-rpc` js file to your website and expose api for ImJoy/BioEngine.

See [here](https://github.com/imjoy-team/ImJoy-core#use-your-web-application-inside-imjoy) for more details.

For example, [Kaibu](https://kaibu.org) is a standlone web app that compatible with the BioEngine. Because it [loads the imjoy-rpc library](https://github.com/imjoy-team/kaibu/blob/efd355eff95da9aa0f7eb97103585b753063c05d/public/index.html#L45) and [exposed api functions for ImJoy](https://github.com/imjoy-team/kaibu/blob/master/src/imjoyAPI.js).

### How to submit BioEngine Apps to the website?
#### How to submit BioEngine Apps to the website?
If you are one of our [community partners](https://github.com/bioimage-io/bioimage.io/blob/master/docs/join-partners.md), you can add the app url to your model repository. Otherwise, please submit your BioEngine Apps to BioImage.IO by posting the url [here](https://github.com/bioimage-io/bioimage-io-models/issues/26).

## User Resources

### DL4MicEverywhere
DL4MicEverywhere is a platform that lets users train and implement their models in different computational environments. These environments include Google Colab, personal computational resources such as a desktop or laptop, and HPC systems. This platform provides environments compatible with some BioImage Model Zoo models to be used in different scenarios. It extends ZeroCostDL4Mic capabilities by allowing the execution of notebooks either locally on personal devices like laptops or remotely on diverse computing platofmrs.

The documentation can be found in [the GitHub Repository](https://github.com/HenriquesLab/DL4MicEverywhere).

### BioImage.IO Chatbot
The BioImage.IO Chatbot can be accessed [here](https://bioimage.io/chat/). The BioImage.IO Chatbot is a versatile conversational agent designed to assist users in accessing information related to computational bioimaging. It leverages the power of Large Language Models (LLMs) and integrates user-specific data to provide contextually accurate and personalized responses. Whether you're a researcher, developer, or scientist, the chatbot is here to make your bioimaging journey smoother and more informative.

The documentation can be found [here](https://github.com/bioimage-io/bioimageio-chatbot).

## BioImage.IO Colab
### BioImage.IO Colab
[BioImageIO Colab](https://github.com/bioimage-io/bioimageio-colab) is a working-in-progress project that supports collaborative data annotation in the browser using the BioEngine and [Kaibu](https://kaibu.org). It allows the safe dissemination of images embedded in an image annotation tool (Kaibu) and stores the corresponding annotations in a source directory. This functionality is enabled by the connection to the BioEngine server. Users can test demos for crowd-sourced annotation and model fine-tuning using pre-configured Jupyter notebooks in Google Colab. BioImageIO Colab is based on two main components: Kaibu, a web-browser annotation tool, and the BioEngine server, facilitating a seamless and interactive collaborative annotation experience.