Rename remaining_params to leftover_params

Author: TylerYep

torchinfo/__init__.py

@@ -10,4 +10,4 @@
     "RowSettings",
     "Verbosity",
 )
-__version__ = "1.6.6"
+__version__ = "1.7.0"

torchinfo/layer_info.py

@@ -289,23 +289,27 @@ def num_params_to_str(self, reached_max_depth: bool) -> str:
                 return (
                     param_count_str if self.trainable_params else f"({param_count_str})"
                 )
-            remaining_params = self.remaining_params()
-            if remaining_params > 0:
-                return f"{remaining_params:,}"
+            leftover_params = self.leftover_params()
+            if leftover_params > 0:
+                return f"{leftover_params:,}"
         return "--"
 
-    def remaining_params(self) -> int:
+    def leftover_params(self) -> int:
+        """
+        Leftover params are the number of params this current layer has that are not
+        included in the child num_param counts.
+        """
         return self.num_params - sum(
-            child.num_params if child.is_leaf_layer else child.remaining_params()
+            child.num_params if child.is_leaf_layer else child.leftover_params()
             for child in self.children
             if not child.is_recursive
         )
 
-    def remaining_trainable_params(self) -> int:
+    def leftover_trainable_params(self) -> int:
         return self.trainable_params - sum(
             child.trainable_params
             if child.is_leaf_layer
-            else child.remaining_trainable_params()
+            else child.leftover_trainable_params()
             for child in self.children
             if not child.is_recursive
         )

torchinfo/model_statistics.py

@@ -38,8 +38,8 @@ def __init__(
             else:
                 if layer_info.is_recursive:
                     continue
-                self.total_params += layer_info.remaining_params()
-                self.trainable_params += layer_info.remaining_trainable_params()
+                self.total_params += layer_info.leftover_params()
+                self.trainable_params += layer_info.leftover_trainable_params()
 
         self.formatting.set_layer_name_width(summary_list)
 
@@ -55,25 +55,19 @@ def __repr__(self) -> str:
             f"Non-trainable params: {self.total_params - self.trainable_params:,}\n"
         )
         if self.input_size:
+            unit, macs = self.to_readable(self.total_mult_adds)
+            input_size = self.to_megabytes(self.total_input)
+            output_bytes = self.to_megabytes(self.total_output_bytes)
+            param_bytes = self.to_megabytes(self.total_param_bytes)
+            total_bytes = self.to_megabytes(
+                self.total_input + self.total_output_bytes + self.total_param_bytes
+            )
             summary_str += (
-                "Total mult-adds ({}): {:0.2f}\n{}\n"  # pylint: disable=consider-using-f-string  # noqa: E501
-                "Input size (MB): {:0.2f}\n"
-                "Forward/backward pass size (MB): {:0.2f}\n"
-                "Params size (MB): {:0.2f}\n"
-                "Estimated Total Size (MB): {:0.2f}\n".format(
-                    *self.to_readable(self.total_mult_adds),
-                    divider,
-                    self.to_megabytes(self.total_input),
-                    self.to_megabytes(self.total_output_bytes),
-                    self.to_megabytes(self.total_param_bytes),
-                    (
-                        self.to_megabytes(
-                            self.total_input
-                            + self.total_output_bytes
-                            + self.total_param_bytes
-                        )
-                    ),
-                )
+                f"Total mult-adds ({unit}): {macs:0.2f}\n{divider}\n"
+                f"Input size (MB): {input_size:0.2f}\n"
+                f"Forward/backward pass size (MB): {output_bytes:0.2f}\n"
+                f"Params size (MB): {param_bytes:0.2f}\n"
+                f"Estimated Total Size (MB): {total_bytes:0.2f}\n"
             )
         summary_str += divider
         return summary_str