docs: fix missing function descriptions in docstrings

C-Achard · Jun 11, 2026 · Jun 1, 2026 · Jun 1, 2026 · Jun 1, 2026 · Jun 1, 2026
commit 30a2e3668bf67a2d2c5bb6a7a70af68bad6b46f2
diff --git a/deeplabcut/compat.py b/deeplabcut/compat.py
@@ -26,7 +26,8 @@
 
 
 def get_project_engine(cfg: dict) -> Engine:
-    """
+    """Get the project engine.
+
     Args:
         cfg: the project configuration file
 
@@ -40,7 +41,8 @@ def get_project_engine(cfg: dict) -> Engine:
 
 
 def get_available_aug_methods(engine: Engine) -> tuple[str, ...]:
-    """
+    """Get the available aug methods.
+
     Args:
         engine: the engine for which augmentation methods should be returned
 

diff --git a/deeplabcut/core/config.py b/deeplabcut/core/config.py
@@ -19,7 +19,8 @@
 
 
 def read_config_as_dict(config_path: str | Path) -> dict:
-    """
+    """Read config as dict.
+
     Args:
         config_path: the path to the configuration file to load
 

diff --git a/deeplabcut/generate_training_dataset/metadata.py b/deeplabcut/generate_training_dataset/metadata.py
@@ -394,7 +394,8 @@ def get_shuffle_engine(
     shuffle: int,
     modelprefix: str = "",
 ) -> Engine:
-    """
+    """Get the shuffle engine.
+
     Args:
         cfg: the config for the DeepLabCut project
         trainingsetindex: the training set index used

diff --git a/deeplabcut/generate_training_dataset/trainingsetmanipulation.py b/deeplabcut/generate_training_dataset/trainingsetmanipulation.py
@@ -1338,7 +1338,8 @@ def get_existing_shuffle_indices(
     train_fraction: float | None = None,
     engine: Engine | None = None,
 ) -> list[int]:
-    """
+    """Get the existing shuffle indices.
+
     Args:
         cfg: The content of a project configuration file, or the path to the project
             configuration file.

diff --git a/deeplabcut/modelzoo/utils.py b/deeplabcut/modelzoo/utils.py
@@ -65,7 +65,8 @@ def get_super_animal_scorer(
     detector_snapshot_path: Path | str | None,
     torchvision_detector_name: str | None = None,
 ) -> str:
-    """
+    """Get the super animal scorer.
+
     Args:
         super_animal: The SuperAnimal dataset on which the models were trained
         model_snapshot_path: The path for the SuperAnimal pose model snapshot

diff --git a/deeplabcut/pose_estimation_pytorch/apis/evaluation.py b/deeplabcut/pose_estimation_pytorch/apis/evaluation.py
@@ -110,7 +110,8 @@ def evaluate(
     pcutoff: float | list[float] = 0.6,
     force_multi_animal: bool = False,
 ) -> tuple[dict[str, float], dict[str, dict[str, np.ndarray]]]:
-    """
+    """Evaluate.
+
     Args:
         pose_runner: The runner for pose estimation
         loader: The loader containing the data to evaluate
@@ -815,7 +816,8 @@ def evaluate_network(
 
 
 def image_to_dlc_df_index(image: str) -> tuple[str, ...]:
-    """
+    """Image to dlc df index.
+
     Args:
         image: the path of the image to map to a DLC index
 

diff --git a/deeplabcut/pose_estimation_pytorch/apis/export.py b/deeplabcut/pose_estimation_pytorch/apis/export.py
@@ -140,7 +140,8 @@ def export_model(
 
 
 def get_export_folder_name(loader: dlc3_data.DLCLoader) -> str:
-    """
+    """Get the export folder name.
+
     Args:
         loader: The loader for the shuffle for which we want to export models.
 
@@ -158,7 +159,8 @@ def get_export_filename(
     snapshot: Snapshot,
     detector_snapshot: Snapshot | None = None,
 ) -> str:
-    """
+    """Get the export filename.
+
     Args:
         loader: The loader for the shuffle for which we want to export models.
         snapshot: The pose model snapshot to export.

diff --git a/deeplabcut/pose_estimation_pytorch/apis/utils.py b/deeplabcut/pose_estimation_pytorch/apis/utils.py
@@ -128,7 +128,8 @@ def parse_snapshot_index_for_analysis(
 def return_train_network_path(
     config: str, shuffle: int = 1, trainingsetindex: int = 0, modelprefix: str = ""
 ) -> tuple[Path, Path, Path]:
-    """
+    """Return the train network path.
+
     Args:
         config: Full path of the config.yaml file as a string.
         shuffle: The shuffle index to select for training
@@ -160,7 +161,8 @@ def get_model_snapshots(
     task: Task,
     snapshot_filter: list[str] | None = None,
 ) -> list[Snapshot]:
-    """
+    """Get the model snapshots.
+
     Args:
         index: Passing an index returns the snapshot with that index (where snapshots
             based on their number of training epochs, and the last snapshot is the
@@ -216,7 +218,8 @@ def get_model_snapshots(
 
 
 def get_scorer_uid(snapshot: Snapshot, detector_snapshot: Snapshot | None) -> str:
-    """
+    """Get the scorer uid.
+
     Args:
         snapshot: the snapshot for which to get the scorer UID
         detector_snapshot: if a top-down model is used with a detector, the detector

diff --git a/deeplabcut/pose_estimation_pytorch/config/make_pose_config.py b/deeplabcut/pose_estimation_pytorch/config/make_pose_config.py
@@ -202,7 +202,8 @@ def make_pytorch_pose_config(
 
 
 def _add_ctd_conditions(model_cfg: dict, ctd_conditions: int | str | Path | tuple[int, str] | tuple[int, int]):
-    """
+    """Add ctd conditions.
+
     Args:
         model_cfg: dict, contents of pytorch_config.yaml
         ctd_conditions: Only for using conditional-top-down (CTD) models. It defines

diff --git a/deeplabcut/pose_estimation_pytorch/config/utils.py b/deeplabcut/pose_estimation_pytorch/config/utils.py
@@ -201,7 +201,8 @@ def load_base_config(config_folder_path: Path) -> dict:
 
 
 def load_backbones(configs_dir: Path) -> list[str]:
-    """
+    """Load backbones.
+
     Args:
         configs_dir: the Path to the folder containing the "configs" for PyTorch
             DeepLabCut
@@ -215,7 +216,8 @@ def load_backbones(configs_dir: Path) -> list[str]:
 
 
 def load_detectors(configs_dir: Path) -> list[str]:
-    """
+    """Load detectors.
+
     Args:
         configs_dir: the Path to the folder containing the "configs" for PyTorch
             DeepLabCut

diff --git a/deeplabcut/pose_estimation_pytorch/data/utils.py b/deeplabcut/pose_estimation_pytorch/data/utils.py
@@ -278,7 +278,8 @@ def _extract_keypoints_and_bboxes(
     num_joints: int,
     num_unique_bodyparts: int,
 ) -> tuple[np.ndarray, np.ndarray, np.ndarray, dict[str, np.ndarray]]:
-    """
+    """Extract keypoints and bboxes.
+
     Args:
         anns: COCO-style annotations
         image_shape: the (h, w, c) shape of the image for which to get annotations

diff --git a/deeplabcut/pose_estimation_pytorch/models/heads/dekr.py b/deeplabcut/pose_estimation_pytorch/models/heads/dekr.py
@@ -225,13 +225,14 @@ def __init__(
         final_conv_kernel: int,
         block: type(BaseBlock) = AdaptBlock,
     ) -> None:
-        """Args:
-        channels: tuple containing the number of input, offset, and output channels.
-        num_offset_per_kpt: number of offset values per keypoint.
-        num_blocks: number of blocks in the head.
-        dilation_rate: dilation rate for convolutional layers.
-        final_conv_kernel: kernel size for the final convolution.
-        block: type of block to use in the head. Defaults to AdaptBlock.
+        """
+        Args:
+            channels: tuple containing the number of input, offset, and output channels.
+            num_offset_per_kpt: number of offset values per keypoint.
+            num_blocks: number of blocks in the head.
+            dilation_rate: dilation rate for convolutional layers.
+            final_conv_kernel: kernel size for the final convolution.
+            block: type of block to use in the head. Defaults to AdaptBlock.
         """
         super().__init__()
         self.inp_channels = channels[0]

diff --git a/deeplabcut/pose_estimation_pytorch/post_processing/identity.py b/deeplabcut/pose_estimation_pytorch/post_processing/identity.py
@@ -17,7 +17,8 @@
 
 
 def assign_identity(predictions: np.ndarray, identity_scores: np.ndarray) -> np.ndarray:
-    """
+    """Assign identity.
+
     Args:
         predictions: Pose predictions for an image, with shape (num_individuals,
             num_bodyparts, 3)

diff --git a/deeplabcut/pose_estimation_pytorch/runners/schedulers.py b/deeplabcut/pose_estimation_pytorch/runners/schedulers.py
@@ -103,7 +103,8 @@ def load_scheduler_state(
     scheduler: torch.optim.lr_scheduler.LRScheduler,
     state_dict: dict,
 ) -> None:
-    """
+    """Load scheduler state.
+
     Args:
         scheduler: The scheduler for which to load the state dict.
         state_dict: The state dict to load

diff --git a/deeplabcut/utils/auxiliaryfunctions.py b/deeplabcut/utils/auxiliaryfunctions.py
@@ -295,7 +295,8 @@ def edit_config(configname, edits, output_name=""):
 
 
 def get_bodyparts(cfg: dict) -> list[str]:
-    """
+    """Get the bodyparts.
+
     Args:
         cfg: a project configuration file
 
@@ -313,7 +314,8 @@ def get_bodyparts(cfg: dict) -> list[str]:
 
 
 def get_unique_bodyparts(cfg: dict) -> list[str]:
-    """
+    """Get the unique bodyparts.
+
     Args:
         cfg: a project configuration file
 
@@ -537,7 +539,8 @@ def get_model_folder(
     modelprefix: str = "",
     engine: Engine = Engine.TF,
 ) -> Path:
-    """
+    """Get the model folder.
+
     Args:
         trainFraction: the training fraction (as defined in the project configuration)
             for which to get the model folder
@@ -567,7 +570,8 @@ def get_evaluation_folder(
     engine: Engine | None = None,
     modelprefix: str = "",
 ) -> Path:
-    """
+    """Get the evaluation folder.
+
     Args:
         trainFraction: the training fraction (as defined in the project configuration)
             for which to get the evaluation folder

diff --git a/deeplabcut/utils/visualization.py b/deeplabcut/utils/visualization.py
@@ -36,7 +36,8 @@
 
 
 def get_cmap(n: int, name: str = "hsv") -> Colormap:
-    """
+    """Get the cmap.
+
     Args:
         n: number of distinct colors
         name: name of matplotlib colormap
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,7 +19,8 @@ @@
     def read_config_as_dict(config_path: str | Path) -> dict:
-        """
+        """Read config as dict.
         Args:
             config_path: the path to the configuration file to load
@@ Expand Down @@