Added documentation material (#350)

* Added documentation for BMZ * Added FAQs and Contact Us * Added current list of CP * Add dynamic community partner rendering. * Hide code and run * Updated FAQs page --------- Co-authored-by: Wei Ouyang <[email protected]>
bioimage-io · Oct 11, 2023 · e96728f · e96728f
1 parent 63fbe82
commit e96728f
Show file tree

Hide file tree

Showing 6 changed files with 217 additions and 6 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -14,3 +14,14 @@ The model zoo is open for contributions from the community partners and external
 Wei Ouyang, Fynn Beuttenmueller, Estibaliz Gómez-de-Mariscal, Constantin Pape, Tom Burke, Carlos Garcia-López-de-Haro, Craig Russell, Lucía Moya-Sans, Cristina de-la-Torre-Gutiérrez, Deborah Schmidt, Dominik Kutra, Maksim Novikov, Martin Weigert, Uwe Schmidt, Peter Bankhead, Guillaume Jacquemet, Daniel Sage, Ricardo Henriques, Arrate Muñoz-Barrutia, Emma Lundberg, Florian Jug, Anna Kreshuk, **BioImage Model Zoo: A Community-Driven Resource for Accessible Deep Learning in BioImage Analysis**, bioRxiv 2022.06.07.495102, doi: [https://doi.org/10.1101/2022.06.07.495102](https://doi.org/10.1101/2022.06.07.495102)
 
 <img src="./bioimage-io-paper-figure-1.png" align="center" width="1000"/>
+
+# Glossary
+In the ever-evolving field of bioimage analysis, understanding the terminology is essential. Explore our glossary to familiarize yourself with key terms and concepts used throughout the BioImage Model Zoo project.
+
+| Term                                  | Definition                                                                                                                                                           |
+| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Community Partner**                 | Usually, a community partner is an organization, a company, a research group, or a software team (of one or more) that can consume and/or produce resources of the BioImage Model Zoo. Additionally, most partners continuously and openly contribute resources of their own. The founders community partners represent open source consumer software of [BioImage.IO](http://BioImage.IO/) (e.g. [ilastik](https://www.ilastik.org), [Fiji](https://imagej.net/software/fiji/), [deepImageJ](https://deepimagej.github.io), [ZeroCostDL4Mic](https://github.com/HenriquesLab/ZeroCostDL4Mic), [StarDist](https://github.com/stardist/stardist)). A Community Partner can either be a team behind a software which produces or consumes trained models compatible with the [BioImage.IO](http://bioimage.io/) spec or an organization, group, company or team (of one or more) who contributed and will keep contributing more models to BioImage Model Zoo. |
+| **Consumer**                          | Refers to an individual or user who engages with the project by utilizing the pre-existing models available on [BioImage.IO](http://bioimage.io/). Their primary role involves downloading these models and incorporating them into their workflow using compatible software or any specific manner that suits their needs. For example, a Life Scientist can be considered a consumer by accessing the[BioImage.io](http://bioimage.io/), selecting a Deep Learning model relevant to their research, and integrating it into their preferred software, such as deepImageJ or other compatible platforms. As a consumer, their focus lies in leveraging the existing models to enhance their bioimage analysis tasks, thereby benefiting from the diverse range of models provided by the BioImage Model Zoo. |
+| **Contributor**                       | A contributor can either be an individual person or a group, entity, or software. As an individual contributor, your primary objective is to actively contribute to the project by uploading models to BioImage Model Zoo. By doing so, you expand the range of available models, enriching the repository and fostering the growth of the bioimage analysis community. As a contributor, you play a crucial role in sharing your expertise and innovative models with the broader community, contributing to advancements in bioimage analysis. Similarly, a software contributor refers to a software application or system that actively participates in the project by uploading models to [BioImage.IO](http://bioimage.io/). These software contributors enhance the available models by providing new and diverse solutions, further expanding the capabilities of the BioImage Model Zoo. Whether you contribute as an individual or a software entity, your active involvement in uploading models to [BioImage.IO](http://bioimage.io/) is instrumental in supporting the project's objectives. By sharing your models, you contribute to the collective knowledge and empower researchers in the bioimage analysis field. |
+| **Consumer Software**                 | A consumer software refers to any software application or tool that utilizes the models from the BioImage Model Zoo repository. Consumer software is designed to interact with and make use of the pretrained AI models available in the BioImage Model Zoo. A consumer software is any software application or tool that utilize pretrained AI models for bioimage analysis tasks, either through integration, execution, or interaction with the models available in the BioImage Model Zoo. |
+| **Model Resource Description File Specifications (RDF YAML)** | The Model Resource Description File (RDF) specifications refer to a set of guidelines that define the structure and content of a YAML file used to describe the AI models with pretrained weights in a standardized format. The model RDF serves as a metadata file that provides essential information about the model, its properties, and its intended use. The RDF file contains both mandatory and optional fields that capture relevant details about the model, such as its architecture, input/output formats, preprocessing steps, and performance metrics. By following the Model RDF specifications, developers and researchers can create consistent and interoperable descriptions of their AI models, allowing seamless integration and sharing within the [BioImage.IO](http://bioimage.io/) ecosystem. |
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -26,6 +26,7 @@
   - [How to join](/community_partners/how_to_join.md)
   - [User Analytics](/community_partners/user_analytics.md)
   - [BioImage.IO Partner Collection](/community_partners/partner_collection.md)
+* [FAQs](/faqs/README.md)
 * [Terms of Service](/terms_of_service.md)
 * [Code of Conduct](/CODE_OF_CONDUCT.md)
 * [Governance](/bioimageio_steering.md)

diff --git a/docs/community_partners/README.md b/docs/community_partners/README.md
@@ -1,5 +1,3 @@
-
-
 # Join as a community partner
 
 BioImage.IO is a community-driven open source initiative, providing access to trained deep learning models and related resources contributed by the community members. To help us better disseminate and maintain the resources, we introduced the concepts of **community partner**. 
@@ -38,3 +36,156 @@ See more information here: https://github.com/bioimage-io/collection-bioimage-io
 Community partners can use our user analytics service to report resource downloads and access to statistics.
 
 See [User Analytics](/community_partners/user_analytics.md) for more details.
+
+## Meet our Community Partners
+Below is a list of our esteemed Community Partners who actively engage with the BioImage Model Zoo project, contributing their expertise, resources, and support to enhance the bioimage analysis community.
+
+<!-- ImJoyPlugin: {"type": "window", "hide_code_block": true, "startup_mode": "run"} -->
+```html
+<config lang="json">
+{
+  "name": "BioImageIO Community Partners",
+  "type": "window",
+  "tags": [],
+  "ui": "",
+  "version": "0.1.0",
+  "cover": "",
+  "description": "Create a table for the bioimage.io community partners",
+  "icon": "extension",
+  "inputs": null,
+  "outputs": null,
+  "api_version": "0.1.8",
+  "env": "",
+  "permissions": [],
+  "requirements": ["https://cdnjs.cloudflare.com/ajax/libs/react/17.0.2/umd/react.production.min.js", "https://cdnjs.cloudflare.com/ajax/libs/react-dom/17.0.2/umd/react-dom.production.min.js", "https://cdnjs.cloudflare.com/ajax/libs/babel-standalone/6.26.0/babel.min.js", "https://cdn.tailwindcss.com"],
+  "dependencies": [],
+  "defaults": {"w": 20, "h": 10}
+}
+</config>
+
+<attachment name="react-src">
+// Main React App Component
+const App = () => {
+  const [partners, setPartners] = React.useState([]);
+
+  // Fetch JSON data from the URL
+  React.useEffect(() => {
+    fetch('https://raw.githubusercontent.com/bioimage-io/collection-bioimage-io/gh-pages/collection.json')
+      .then(response => response.json())
+      .then(data => {
+        if (data.config && data.config.partners) {
+          setPartners(data.config.partners);
+        } else {
+          setPartners([]);
+        }
+      })
+      .catch(err => console.error(err));
+  }, []);
+
+  return (
+    <div className="flex flex-col justify-center items-center min-h-screen bg-gray-100 text-gray-800 w-full">
+      <div className="p-8 bg-white shadow-md rounded-lg w-full h-full">
+        <h1 className="text-2xl font-bold mb-4">Community Partners</h1>
+        <table className="min-w-full bg-white w-full h-full">
+          <thead className="bg-gray-800 text-white">
+            <tr>
+              <th className="py-2">Community Partner</th>
+              <th className="py-2">Documentation</th>
+              <th className="py-2">Contact</th>
+            </tr>
+          </thead>
+          <tbody className="text-gray-700">
+            {partners.map((partner, index) => (
+              <tr key={index}>
+                <td className="py-2 px-4">{partner.name || 'N/A'}</td>
+                <td className="py-2 px-4">{partner.docs || 'N/A'}</td>
+                <td className="py-2 px-4">
+                  {partner.contact ? (
+                    partner.contact.map((contact, i) => (
+                      <div key={i}>
+                        <div>Name: {contact.name || 'N/A'}</div>
+                        <div>Github: {contact.github || 'N/A'}</div>
+                        <div>Email: {contact.email || 'N/A'}</div>
+                      </div>
+                    ))
+                  ) : (
+                    'N/A'
+                  )}
+                </td>
+              </tr>
+            ))}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  );
+};
+
+// Render the App component
+ReactDOM.render(<App />, document.getElementById('root'));
+
+</attachment>
+<script lang="javascript">
+async function loadBabelScript(content) {
+  return new Promise((resolve, reject) => {
+      const script = document.createElement('script');
+      script.type = 'text/babel';
+      script.setAttribute('data-presets', 'react');
+      script.textContent = content;
+      script.onerror = function() {
+        reject(new Error('Failed to load the Babel script.'));
+      };
+      document.head.appendChild(script);
+      setTimeout(()=>{
+        try{
+            Babel.transformScriptTags();
+            resolve('Babel script has been loaded!');
+         } catch (error) {
+          reject(error);
+        }
+      }, 0);
+  });
+}
+    
+class ImJoyPlugin {
+  async setup() {
+    await api.log('initialized')
+  }
+
+  async loadJsxScript(script){
+      await loadBabelScript(script);
+  }
+
+  async run(ctx) {
+    if(ctx.data && ctx.data.jsx_script)
+      await loadBabelScript(ctx.data.jsx_script);
+    else
+      await loadBabelScript(await api.getAttachment('react-src'));
+  }
+}
+
+api.export(new ImJoyPlugin())
+</script>
+
+<window lang="html">
+<div id="root"></div>
+</window>
+
+<style lang="css">
+</style>
+```
+
+
+| Tool Name      | WebPage                                   | Main Contact Person        | Institution                                 | Documentation                  |
+| -------------- | ----------------------------------------- | --------------------------- | ------------------------------------------- | ------------------------------ |
+| ZeroCostDL4Mic | [GitHub](https://github.com/HenriquesLab/ZeroCostDL4Mic) | Ricardo Henriques and Guillaume Jacquemet | [UTU](https://www.utu.fi/en) and [Abo Akademi](https://www.abo.fi)      | [Wiki](https://github.com/HenriquesLab/ZeroCostDL4Mic/wiki) |
+| DeepImageJ     | [Website](https://deepimagej.github.io)   | Arrate Muñoz Barrutia      | [UC3M](https://www.uc3m.es/home) and [EPFL](https://www.epfl.ch/en/) | [Wiki](https://github.com/deepimagej/deepimagej-plugin/wiki) |
+| ImJoy          | [Website](https://imjoy.io/#/)            | Wei Ouyang                 | [KTH](https://www.kth.se/en)              | [Docs](https://imjoy.io/docs/#/) |
+| Ilastik        | [Website](https://www.ilastik.org)       | Anna Kreshuk               | [EMBL](https://www.embl.org)             | [Docs](https://www.ilastik.org/documentation/index.html) |
+| icy            | [Website](https://icy.bioimageanalysis.org) | Jean-Christophe Olivo Marin | [IP](https://www.pasteur.fr/en)           | -                              |
+| Fiji           | [Website](https://fiji.sc)                | Florian Jug                | -                                           | [Docs](https://imagej.net/software/fiji/) |
+| HPA            | [Model Zoo](https://modelzoo.cellprofiling.org/#/) | Frederic Ballllosera Navarro           | [KTH](https://www.kth.se/en) and [Stanford](https://stanford.edu)             | -                              |
+| QuPath         | [Website](https://qupath.github.io)       | Pete Bankhead              | [UoE](https://www.ed.ac.uk)              | [Docs](https://qupath.readthedocs.io/en/stable/) |
+| StarDist       | [Website](https://stardist.net)           | Uwe Schmidt and Martin Weigert | -                                    | [GitHub](https://github.com/stardist/stardist) |
+
+
diff --git a/docs/faqs/README.md b/docs/faqs/README.md
@@ -0,0 +1,48 @@
+# FAQs
+
+Have questions about how to participate, contribute, or engage with the BioImage Model Zoo? Check out our Frequently Asked Questions (FAQs) for detailed answers and insights into making the most of your experience with our project.
+
+### How can I participate in the BioImage Model Zoo?
+
+To participate, you can take on the role of a **Community Partner** or engage as a **Consumer** or **Contributor** of models from the BioImage Model Zoo.
+
+- **Consumer**: As a Consumer, your role involves utilizing the existing models available on bioimage.io by downloading and incorporating them into your workflow using connected software or in any specific manner. For instance, a Life Scientist can be a Consumer by using a Deep Learning model downloaded from bioimage.io and integrating it into any compatible software (deepImageJ, Ilastik, ImJoy, ZeroCostDL4Mic, ...).
+
+- **Contributor**: If your primary objective is to contribute models to bioimage.io, then you are a Contributor. As such, you play a crucial role in expanding the range of available models and supporting the bioimage analysis community.
+
+### What is a Community Partner? Who can be a Community Partner?
+
+Usually, a **Community Partner** is an organization, a company, a research group, or a software team (of one or more) that can consume and/or produce models from/for the BioImage.IO Model Zoo.
+
+The first community partners represent open source consumer software of BioImage.IO (e.g. ilastik, Fiji, deepImageJ, ZeroCostDL4Mic, StarDist).
+
+A Community Partner can either be a team behind a software which produces or consumes trained models compatible with the BioImage.IO specifications or an organization, group, company, or team (of one or more) who contributes models to BioImage.IO.
+
+
+### How can I upload a model to the BioImage Model Zoo?
+
+To contribute a model to the BioImage Model Zoo, please refer to the [Contribute Models section](https://bioimage.io/docs/#/contribute_models/README). This section provides detailed instructions on how to upload a model, including the necessary steps and required files for your contribution.
+
+### How can I report issues or provide feedback regarding models on BioImage.IO?
+
+If you encounter a bug or wish to share feedback, please use our [GitHub issues page](https://github.com/bioimage-io/bioimage.io/issues). We appreciate your input and kindly request that you ensure your feedback is not duplicated. Your contributions help improve the BioImage Model Zoo for the entire community.
+
+### What is AI4Life?
+
+AI4Life is a project whose goal is to provide sustainable, intuitive, and highest quality research services and infrastructures that will enable all life scientists to exploit machine learning to improve the utility and interpretability of image data, the key to future biomedical research.
+
+### How is AI4Life related to the BioImage Model Zoo?
+
+AI4Life is a project closely aligned with the BioImage Model Zoo. It plays a significant role in supporting and enhancing the BioImage Model Zoo's mission and initiatives.
+
+### Can I use models from the BioImage Model Zoo for commercial purposes?
+Yes, you are welcome to use the models from the BioImage Model Zoo for commercial purposes. However, we kindly request that you provide appropriate credits when using these models as a gesture of acknowledgment for the contributions of the model creators and the BioImage Model Zoo community.
+
+
+# Contact us
+
+If you can't find what you're looking for, there are several ways to communicate with us or get assistance. Here are some options:
+
+- You can ask a question or post in the [Image.sc Forum](https://forum.image.sc) using the tag 'bioimageio'. This way, not only our team but also others facing similar issues can benefit from your post.
+
+- Alternatively, you can contact us through our [contact form](https://oeway.typeform.com/to/K3j2tJt7), and someone will be available to assist with your questions.
diff --git a/public/static/img/feedback-icon.png b/public/static/img/feedback-icon.png
diff --git a/site.config.json b/site.config.json
@@ -26,10 +26,10 @@
       "logo": "/static/img/imagesc-logo.png", 
       "url": "https://forum.image.sc/tag/bioimageio"
     },
-    { "label": "Bug Report",
-      "tooltip": "Send a bug report on Github",
-      "logo": "/static/img/bug-icon.png", 
-      "url": "https://github.com/bioimage-io/bioimage.io/issues"
+    { "label": "Feedback Form",
+      "tooltip": "Give us some feedback through this Google Form",
+      "logo": "/static/img/feedback-icon.png", 
+      "url": "https://docs.google.com/forms/d/e/1FAIpQLSfhRaldWH-CSJvSxHzxpG1_HGnNzQ-evpMcaJMo1HaSuLaCMA/viewform?usp=sf_link"
     },
     { "label": "Source Code",
       "tooltip": "Github Repository",