Add docstring

eigenvivek · Nov 30, 2023 · a92796e · a92796e
1 parent 51ceafe
commit a92796e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/diffpose/calibration.py b/diffpose/calibration.py
@@ -17,6 +17,8 @@
 
 @beartype
 class RigidTransform(Transform3d):
+    """Wrapper of pytorch3d.transforms.Transform3d with extra functionalities."""
+
     @jaxtyped
     def __init__(
         self,
@@ -27,7 +29,6 @@ def __init__(
         device=None,
         dtype=torch.float32,
     ):
-        """Wrapper of pytorch3d.transforms.Transform3d with extra functionalities."""
         if device is None and (R.device == t.device):
             device = R.device
 

diff --git a/notebooks/api/02_calibration.ipynb b/notebooks/api/02_calibration.ipynb
@@ -104,6 +104,8 @@
     "\n",
     "@beartype\n",
     "class RigidTransform(Transform3d):\n",
+    "    \"\"\"Wrapper of pytorch3d.transforms.Transform3d with extra functionalities.\"\"\"\n",
+    "\n",
     "    @jaxtyped\n",
     "    def __init__(\n",
     "        self,\n",
@@ -114,7 +116,6 @@
     "        device=None,\n",
     "        dtype=torch.float32,\n",
     "    ):\n",
-    "        \"\"\"Wrapper of pytorch3d.transforms.Transform3d with extra functionalities.\"\"\"\n",
     "        if device is None and (R.device == t.device):\n",
     "            device = R.device\n",
     "\n",