Clarify inverse matching docs and apply formatting

Signed-off-by: sewon jeon <irocks0922@gmail.com>

Author: eclipse0922

monai/apps/detection/transforms/dictionary.py

@@ -125,10 +125,8 @@ def __init__(self, box_keys: KeysCollection, box_ref_image_keys: str, allow_miss
         super().__init__(box_keys, allow_missing_keys)
         box_ref_image_keys_tuple = ensure_tuple(box_ref_image_keys)
         if len(box_ref_image_keys_tuple) > 1:
-            raise ValueError(
-                "Please provide a single key for box_ref_image_keys.\
-                All boxes of box_keys are attached to box_ref_image_keys."
-            )
+            raise ValueError("Please provide a single key for box_ref_image_keys.\
+                All boxes of box_keys are attached to box_ref_image_keys.")
         self.box_ref_image_keys = box_ref_image_keys
 
     def __call__(self, data: Mapping[Hashable, NdarrayOrTensor]) -> dict[Hashable, NdarrayOrTensor]:
@@ -289,10 +287,8 @@ def __init__(
         super().__init__(box_keys, allow_missing_keys)
         box_ref_image_keys_tuple = ensure_tuple(box_ref_image_keys)
         if len(box_ref_image_keys_tuple) > 1:
-            raise ValueError(
-                "Please provide a single key for box_ref_image_keys.\
-                All boxes of box_keys are attached to box_ref_image_keys."
-            )
+            raise ValueError("Please provide a single key for box_ref_image_keys.\
+                All boxes of box_keys are attached to box_ref_image_keys.")
         self.box_ref_image_keys = box_ref_image_keys
         self.image_meta_key = image_meta_key or f"{box_ref_image_keys}_{image_meta_key_postfix}"
         self.converter_to_image_coordinate = AffineBox()
@@ -310,10 +306,8 @@ def extract_affine(self, data: Mapping[Hashable, torch.Tensor]) -> tuple[Ndarray
         else:
             raise ValueError(f"{meta_key} is not found. Please check whether it is the correct the image meta key.")
         if "affine" not in meta_dict:
-            raise ValueError(
-                f"'affine' is not found in {meta_key}. \
-                Please check whether it is the correct the image meta key."
-            )
+            raise ValueError(f"'affine' is not found in {meta_key}. \
+                Please check whether it is the correct the image meta key.")
         affine: NdarrayOrTensor = meta_dict["affine"]
 
         if self.affine_lps_to_ras:  # RAS affine
@@ -815,16 +809,12 @@ def __init__(
     ) -> None:
         box_keys_tuple = ensure_tuple(box_keys)
         if len(box_keys_tuple) != 1:
-            raise ValueError(
-                "Please provide a single key for box_keys.\
-                All label_keys are attached to this box_keys."
-            )
+            raise ValueError("Please provide a single key for box_keys.\
+                All label_keys are attached to this box_keys.")
         box_ref_image_keys_tuple = ensure_tuple(box_ref_image_keys)
         if len(box_ref_image_keys_tuple) != 1:
-            raise ValueError(
-                "Please provide a single key for box_ref_image_keys.\
-                All box_keys and label_keys are attached to this box_ref_image_keys."
-            )
+            raise ValueError("Please provide a single key for box_ref_image_keys.\
+                All box_keys and label_keys are attached to this box_ref_image_keys.")
         self.label_keys = ensure_tuple(label_keys)
         super().__init__(box_keys_tuple, allow_missing_keys)
 
@@ -1091,10 +1081,8 @@ def __init__(
 
         box_keys_tuple = ensure_tuple(box_keys)
         if len(box_keys_tuple) != 1:
-            raise ValueError(
-                "Please provide a single key for box_keys.\
-                All label_keys are attached to this box_keys."
-            )
+            raise ValueError("Please provide a single key for box_keys.\
+                All label_keys are attached to this box_keys.")
         self.box_keys = box_keys_tuple[0]
         self.label_keys = ensure_tuple(label_keys)
 

monai/apps/detection/utils/anchor_utils.py

@@ -124,10 +124,8 @@ def __init__(
             aspect_ratios = (aspect_ratios,) * len(self.sizes)
 
         if len(self.sizes) != len(aspect_ratios):
-            raise ValueError(
-                "len(sizes) and len(aspect_ratios) should be equal. \
-                It represents the number of feature maps."
-            )
+            raise ValueError("len(sizes) and len(aspect_ratios) should be equal. \
+                It represents the number of feature maps.")
 
         spatial_dims = len(ensure_tuple(aspect_ratios[0][0])) + 1
         spatial_dims = look_up_option(spatial_dims, [2, 3])
@@ -172,16 +170,12 @@ def generate_anchors(
         scales_t = torch.as_tensor(scales, dtype=dtype, device=device)  # sized (N,)
         aspect_ratios_t = torch.as_tensor(aspect_ratios, dtype=dtype, device=device)  # sized (M,) or (M,2)
         if (self.spatial_dims >= 3) and (len(aspect_ratios_t.shape) != 2):
-            raise ValueError(
-                f"In {self.spatial_dims}-D image, aspect_ratios for each level should be \
-                {len(aspect_ratios_t.shape) - 1}-D. But got aspect_ratios with shape {aspect_ratios_t.shape}."
-            )
+            raise ValueError(f"In {self.spatial_dims}-D image, aspect_ratios for each level should be \
+                {len(aspect_ratios_t.shape) - 1}-D. But got aspect_ratios with shape {aspect_ratios_t.shape}.")
 
         if (self.spatial_dims >= 3) and (aspect_ratios_t.shape[1] != self.spatial_dims - 1):
-            raise ValueError(
-                f"In {self.spatial_dims}-D image, aspect_ratios for each level should has \
-                shape (_,{self.spatial_dims - 1}). But got aspect_ratios with shape {aspect_ratios_t.shape}."
-            )
+            raise ValueError(f"In {self.spatial_dims}-D image, aspect_ratios for each level should has \
+                shape (_,{self.spatial_dims - 1}). But got aspect_ratios with shape {aspect_ratios_t.shape}.")
 
         # if 2d, w:h = 1:aspect_ratios
         if self.spatial_dims == 2:

monai/apps/reconstruction/transforms/array.py

@@ -61,10 +61,8 @@ def __init__(
                 real/imaginary parts.
         """
         if len(center_fractions) != len(accelerations):
-            raise ValueError(
-                "Number of center fractions \
-                should match number of accelerations"
-            )
+            raise ValueError("Number of center fractions \
+                should match number of accelerations")
 
         self.center_fractions = center_fractions
         self.accelerations = accelerations

monai/bundle/utils.py

@@ -124,10 +124,8 @@
         "run_name": None,
         # may fill it at runtime
         "save_execute_config": True,
-        "is_not_rank0": (
-            "$torch.distributed.is_available() \
-                and torch.distributed.is_initialized() and torch.distributed.get_rank() > 0"
-        ),
+        "is_not_rank0": ("$torch.distributed.is_available() \
+                and torch.distributed.is_initialized() and torch.distributed.get_rank() > 0"),
         # MLFlowHandler config for the trainer
         "trainer": {
             "_target_": "MLFlowHandler",

monai/losses/dice.py

@@ -203,11 +203,9 @@ def forward(self, input: torch.Tensor, target: torch.Tensor) -> torch.Tensor:
                 self.class_weight = torch.as_tensor([self.class_weight] * num_of_classes)
             else:
                 if self.class_weight.shape[0] != num_of_classes:
-                    raise ValueError(
-                        """the length of the `weight` sequence should be the same as the number of classes.
+                    raise ValueError("""the length of the `weight` sequence should be the same as the number of classes.
                         If `include_background=False`, the weight should not include
-                        the background category class 0."""
-                    )
+                        the background category class 0.""")
             if self.class_weight.min() < 0:
                 raise ValueError("the value/values of the `weight` should be no less than 0.")
             # apply class_weight to loss

monai/losses/focal_loss.py

@@ -183,11 +183,9 @@ def forward(self, input: torch.Tensor, target: torch.Tensor) -> torch.Tensor:
                 self.class_weight = torch.as_tensor([self.class_weight] * num_of_classes)
             else:
                 if self.class_weight.shape[0] != num_of_classes:
-                    raise ValueError(
-                        """the length of the `weight` sequence should be the same as the number of classes.
+                    raise ValueError("""the length of the `weight` sequence should be the same as the number of classes.
                         If `include_background=False`, the weight should not include
-                        the background category class 0."""
-                    )
+                        the background category class 0.""")
             if self.class_weight.min() < 0:
                 raise ValueError("the value/values of the `weight` should be no less than 0.")
             # apply class_weight to loss

monai/transforms/inverse.py

@@ -302,7 +302,12 @@ def track_transform_meta(
         return out_obj
 
     def check_transforms_match(self, transform: Mapping) -> None:
-        """Check transforms are of same instance."""
+        """Check whether a traced transform entry matches this transform.
+
+        When multiprocessing uses ``spawn``, transform instances are recreated,
+        so matching can fall back to the transform class name instead of the
+        original instance ID.
+        """
         if self._transforms_match(transform):
             return
 
@@ -317,7 +322,13 @@ def check_transforms_match(self, transform: Mapping) -> None:
         )
 
     def _transforms_match(self, transform: Mapping) -> bool:
-        """Return whether a traced transform entry matches this transform instance."""
+        """Return whether a traced transform entry matches this transform.
+
+        Matching succeeds when the traced ID matches this instance, when the ID
+        check is explicitly disabled with ``TraceKeys.NONE``, or when
+        multiprocessing uses ``spawn`` and the traced class name matches this
+        transform class.
+        """
         xform_id = transform.get(TraceKeys.ID, "")
         if xform_id == id(self):
             return True

versioneer.py

@@ -429,9 +429,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
     return stdout, process.returncode
 
 
-LONG_VERSION_PY[
-    "git"
-] = r'''
+LONG_VERSION_PY["git"] = r'''
 # This file helps to compute a version number in source trees obtained from
 # git-archive tarball (such as those provided by githubs download-from-tag
 # feature). Distribution tarballs (built by setup.py sdist) and build