diff --git a/source/reference/dashboard.rst b/source/reference/dashboard.rst index ceefb4d..4450623 100644 --- a/source/reference/dashboard.rst +++ b/source/reference/dashboard.rst @@ -104,6 +104,8 @@ Once you choose the module, you will be presented with the module's information: .. image:: /_static/images/dashboard/module.png +.. todo: update image + To deploy click in ``Deploy > Inference API (dedicated)`` and you will be redirected to a configuration page. .. image:: /_static/images/dashboard/configure.png diff --git a/source/reference/modules.rst b/source/reference/modules.rst index 7b4aa7c..aa812ac 100644 --- a/source/reference/modules.rst +++ b/source/reference/modules.rst @@ -58,3 +58,21 @@ A typical pipeline is divided in two parts: * regenerate the provenance chain of that module, .. image:: /_static/images/ai4eosc/jenkins.png + + +Module popularity +----------------- + +In order to efficiently explore the catalog of modules, it is useful to know what are the most popular modules. + +Assessing the popularity of module is a difficult task because there are many proxy metrics of popularity, each one with it's own shortcomings: + +* **Github Stars**: while useful, many users do not take the time to star the modules they use. +* **DockerHub downloads**: downloads sometimes do not reflect real usage because they can be inflated by CI/CD automated builds. +* **Number of created persistent deployments**: they can be misleading sometimes, as someone can deploy a module a single time but use it a lot, while another person might download it and immediately remove it. +* **Number of created tryme deployments**: this metric is very informative but it privileges trained modules (eg. YOLO trained to detect fishes) over untrained ones (eg. YOLO with no trained weights). This is unfair because the trained module used the untrained module as a base reference, so the base module is indeed popular. +* **Number of Dashboard views**: this metric could prioritize fancy shinny modules over modules that are really used by users, + +To be able to easily compare across modules and mitigate the individual shortcomings, we weight these individual metrics into an overall **aggregated popularity score**. This aggragated score allows to sort the catalog modules by popularity. + +.. todo: add image \ No newline at end of file