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

Conversation

cfusterbarcelo
Copy link
Collaborator

@cfusterbarcelo cfusterbarcelo commented Jan 21, 2025

This PR updates multiple sections of the BioImage Model Zoo documentation following recent discussions and feedback from the community. The changes aim to improve clarity, provide more detailed instructions, and ensure that the documentation reflects the latest specifications and tools available.

Summary of changes

  • Updated documentation on creating and uploading models. I have changed and added the documentation on uploading and creating the models, even adding a notebook on how to create a model description from scratch.
  • Added a placeholder to add documentation on how to use the GUI to create models as requested by @Tomaz-Vieira.
  • Finished the guide for Tools and Resources
  • Added the "Best Practices for Model usage"
  • Added new documentation on how to use BMZ models in each Community Partner

@cfusterbarcelo cfusterbarcelo requested a review from FynnBe January 21, 2025 16:13
@cfusterbarcelo cfusterbarcelo self-assigned this Jan 21, 2025
Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for bioimage ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0bde04b
🔍 Latest deploy log https://app.netlify.com/sites/bioimage/deploys/67a08303337efb0008717dde
😎 Deploy Preview https://deploy-preview-441--bioimage.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
docs/guides/developers-guide.md Show resolved Hide resolved
docs/guides/developers-guide.md Outdated Show resolved Hide resolved
@cfusterbarcelo cfusterbarcelo merged commit 700792a into bioimage-io:main Feb 3, 2025
6 checks passed
@cfusterbarcelo cfusterbarcelo added the documentation Improvements or additions to documentation label Feb 3, 2025
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

Successfully merging this pull request may close these issues.

2 participants