From 8d8e319955229683853011d45f682ab43974d582 Mon Sep 17 00:00:00 2001 From: cfusterbarcelo Date: Wed, 12 Jun 2024 12:47:19 +0200 Subject: [PATCH] Adding model name format to developers guide --- docs/guides/README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/guides/README.md b/docs/guides/README.md index dfc86d6c..67b2a66a 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -165,9 +165,23 @@ You've successfully uploaded your model to the BioImage Model Zoo community on Z #### Model Documentation ##### Model naming -Models are expected to be used by life-scientists, thus, it is expected that the naming is human readable but also informative enough regarding the final application and the biological tissue being analysed. Example: - - **Name:** `Neuron Segmentation in EM (Membrane Prediction)`, `B. Sutilist bacteria segmentation - Widefield microscopy - 2D UNet` +The model name should follow this format: +> Living Matter - Microscopy Modality (optional) - Task - Network Architecture + +- **Living Matter**: Specify the biological data the network was trained on, such as Mitochondria, HeLa Cells, etc. +- **Microscopy Modality**: This field is optional and should be abbreviated if included. Examples include EM for Electron Microscopy, LS for LightSheet Microscopy, Conf. for Confocal, etc. +- **Task**: Describe the primary task the network is performing, such as Instance Segmentation, Restoration, Denoising, etc. +- **Network Architecture**: Indicate the network architecture, such as StarDist 2D, UNet 3D, etc. + +**Examples:** +- **HeLa Cells - Conf. - Instance Segmentation - UNet 2D** +- **Mitochondria - EM - Denoising - DenoiseNet** +- **C. elegans - LS - Restoration - StarDist 3D** +- **Mouse Brain - EM - Segmentation - DeepLabV3** + +These guidelines will help ensure that the models are easily identifiable and provide essential information at a glance. + +If additional details are necessary, it is recommended to include them in the model's description. ##### Model Tags