[doc] Update api.rst

doc/api.rst

@@ -42,9 +42,12 @@ CNN and other models implemented.
    mednet.models.pasa
    mednet.models.alexnet
    mednet.models.densenet
-   mednet.models.normalizer
    mednet.models.logistic_regression
+   mednet.models.loss_weights
    mednet.models.mlp
+   mednet.models.normalizer
+   mednet.models.separate
+   mednet.models.transforms
    mednet.models.typing
 
 
@@ -58,11 +61,12 @@ Functions to actuate on the data.
 .. autosummary::
    :toctree: api/engine
 
-   mednet.engine.device
    mednet.engine.callbacks
-   mednet.engine.trainer
-   mednet.engine.predictor
+   mednet.engine.device
    mednet.engine.evaluator
+   mednet.engine.loggers
+   mednet.engine.predictor
+   mednet.engine.trainer
 
 
 .. _mednet.api.saliency:
@@ -75,9 +79,11 @@ Engines to generate and analyze saliency mapping techniques.
 .. autosummary::
    :toctree: api/saliency
 
-   mednet.engine.saliency.generator
    mednet.engine.saliency.completeness
+   mednet.engine.saliency.evaluator
+   mednet.engine.saliency.generator
    mednet.engine.saliency.interpretability
+   mednet.engine.saliency.viewer
 
 
 .. _mednet.api.utils:

doc/catalog.json

@@ -14,6 +14,15 @@
       "environment": "lightning"
     }
   },
+  "tensorboardx": {
+    "versions": {
+      "stable": "https://tensorboardx.readthedocs.io/en/stable/",
+      "latest": "https://tensorboardx.readthedocs.io/en/latest/"
+    },
+    "sources": {
+      "readthedocs": "tensorboardx"
+    }
+  },
   "tabulate": {
     "versions": {
       "latest": "https://tabulate.readthedocs.io/en/latest/",

doc/conf.py

@@ -123,6 +123,7 @@ auto_intersphinx_packages = [
     "torch",
     "torchvision",
     "lightning",
+    "tensorboardx",
     ("clapper", "latest"),
     ("python", "3"),
 ]

src/mednet/engine/saliency/viewer.py

@@ -214,7 +214,7 @@ def run(
         If set, imprint ground truth labels over the original image and
         saliency maps.
     threshold : float
-        The pixel values above ``threshold``% of max value are kept in the
+        The pixel values above ``threshold`` % of max value are kept in the
         original saliency map.  Everything else is set to zero.  The value
         proposed on [SCORECAM-2020]_ is 0.2.  Use this value if unsure.
     """