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

Add Missing Community Partner Documentation in Guide #437

Open
7 tasks
cfusterbarcelo opened this issue Dec 2, 2024 · 3 comments
Open
7 tasks

Add Missing Community Partner Documentation in Guide #437

cfusterbarcelo opened this issue Dec 2, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@cfusterbarcelo
Copy link
Collaborator

cfusterbarcelo commented Dec 2, 2024

Description:

The guide on using BioImage Model Zoo models in different software currently lacks documentation for several community partners. Each partner should add a short section explaining how to use their software with the BioImage Model Zoo.

Each section should include the following:

  1. A brief introduction explaining the software's compatibility with BioImage Model Zoo models (e.g., supported frameworks like PyTorch, TensorFlow, etc.).
  2. Installation instructions on how to set up the software to work with BioImage Model Zoo models.
  3. Usage instructions on how to load and run a model downloaded from the BioImage Model Zoo.
  4. Links to detailed documentation for further reference.

Here is a template in Markdown that contributors can use to create their section:

### [Software Name]
*Note: Specify compatible frameworks (e.g., PyTorch, TensorFlow) if applicable.*

1. **Install the software and necessary plugins/extensions**:
   - Include specific plugins/extensions required to run BioImage Model Zoo models.
   - Provide brief steps for installation.

2. **Download and set up a model from the BioImage Model Zoo**:
   - Include instructions on how to download models from the zoo.
   - Provide steps for importing the model into the software.

3. **Run the model**:
   - Mention any example datasets or testing workflows, if applicable.
   - Include basic steps for running the model.

4. **Learn more**:
   - Provide links to detailed tutorials or documentation.

Action Items:

Please point to whoever should be in charge of this.

This effort will make the guide more comprehensive and improve accessibility for users! Thank you for your contribution!

@cfusterbarcelo cfusterbarcelo added the documentation Improvements or additions to documentation label Dec 2, 2024
@danifranco
Copy link

danifranco commented Dec 4, 2024

Hello,

We have a dedicated section in our doc with all the explanations on how to use BMZ models in BiaPy. To not replicate the information maybe we can link in BioImage Model Zoo to this documentation?

@cfusterbarcelo
Copy link
Collaborator Author

Hi @danifranco,
That would be very helfpful. Please provide a short description of BiaPy stating that you can consume and produce models and link it to the dedicated documentation.
Thank you very much!

@danifranco
Copy link

Here is a description:

BiaPy

Note: BiaPy empowers users to train custom models or fine-tune existing ones for bioimaging tasks and upload them to the BioImage Model Zoo. BiaPy supports models exported with PyTorch.

BiaPy adapts to users of all expertise levels, offering multiple ways to run and interact with models:

  • Graphical User Interface (GUI): Ideal for beginners.
  • No-Coding Jupyter Notebooks: Simplified workflows for those without programming knowledge.
  • Docker Containers: Ensure reproducibility and isolation.
  • Command Line Interface (CLI): Perfect for advanced users.

How you interact with BioImage Model Zoo models also depends on your chosen method. Get started with the resources below:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants