Documentation corrections in OrdinalEcocDistanceLoss and StickBreakin…

…gLayer
ayrna · Dec 3, 2024 · cad32a1 · cad32a1
1 parent 855a2e5
commit cad32a1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/dlordinal/losses/ordinal_ecoc_distance_loss.py b/dlordinal/losses/ordinal_ecoc_distance_loss.py
@@ -7,7 +7,7 @@
 
 class OrdinalECOCDistanceLoss(torch.nn.Module):
     """Ordinal ECOC distance loss from :footcite:t:`barbero2023error` for use
-    with :class:`dlordinal.models.OBDECOCModel`. Computes the MSE loss
+    with :class:`dlordinal.wrappers.OBDECOCModel`. Computes the MSE loss
     between the output of the model (class threshold probabilities) and
     the ideal output vector for each class.
 

diff --git a/dlordinal/output_layers/stick_breaking_layer.py b/dlordinal/output_layers/stick_breaking_layer.py
@@ -8,7 +8,7 @@ class StickBreakingLayer(Module):
     Parameters
     ----------
     input_shape: int
-        Input shape
+        Input shape, which refers to the number of neurons in the last fully connected layer
     num_classes: int
         Number of classes
     """
@@ -25,8 +25,8 @@ def get_stick_logits(self, x: torch.Tensor):
         x : torch.Tensor
             Input tensor
 
-        Returns:
-        --------
+        Returns
+        -------
         logits : torch.Tensor
             Logits of the stick breaking layer
         """
@@ -49,8 +49,8 @@ def forward(self, x) -> torch.Tensor:
         x : torch.Tensor
             Input tensor
 
-        Returns:
-        --------
+        Returns
+        -------
         logits : torch.Tensor
             Logits of the stick breaking layer
         """