docs(RTD): Add module descriptions

ekut-es · Dec 19, 2024 · 038023d · 038023d
1 parent 63e4eea
commit 038023d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/sources/api/lidar_aug.python.rst b/docs/sources/api/lidar_aug.python.rst
@@ -1,12 +1,17 @@
 lidar\_aug.python package
 =========================
 
+This package contains utility code, Python wrappers for point cloud transformations as well as a class to visualize point clouds.
+
 Submodules
 ----------
 
 lidar\_aug.python.augmentations module
 --------------------------------------
 
+This submodule contains Python wrappers for many transformations.
+These wrappers do a shape check and, in some instances, do some pre- / post-processing of inputs/outputs.
+
 .. automodule:: lidar_aug.python.augmentations
    :members:
    :undoc-members:
@@ -15,6 +20,8 @@ lidar\_aug.python.augmentations module
 lidar\_aug.python.utils module
 ------------------------------
 
+This submodule contains various utility functions.
+
 .. automodule:: lidar_aug.python.utils
    :members:
    :undoc-members:
@@ -23,6 +30,8 @@ lidar\_aug.python.utils module
 lidar\_aug.python.visualization module
 --------------------------------------
 
+This submodule contains functions to visualize point clouds.
+
 .. automodule:: lidar_aug.python.visualization
    :members:
    :undoc-members:

diff --git a/docs/sources/api/lidar_aug.rst b/docs/sources/api/lidar_aug.rst
@@ -15,6 +15,9 @@ Submodules
 lidar\_aug.transformations module
 ---------------------------------
 
+This module contains the transformation functions.
+These are bindings to the underlying C++ code without a Python wrapper around them.
+
 .. automodule:: lidar_aug.transformations
    :members:
    :undoc-members:
@@ -23,6 +26,8 @@ lidar\_aug.transformations module
 lidar\_aug.point_cloud module
 -----------------------------
 
+This module contains some utility functions.
+
 .. automodule:: lidar_aug.point_cloud
    :members:
    :undoc-members:
@@ -31,6 +36,9 @@ lidar\_aug.point_cloud module
 lidar\_aug.weather_simulations module
 -------------------------------------
 
+This module contains the weather simulations.
+These are bindings to the underlying C++ code without a Python wrapper around them.
+
 .. automodule:: lidar_aug.weather_simulations
    :members:
    :undoc-members:
@@ -39,6 +47,8 @@ lidar\_aug.weather_simulations module
 lidar\_aug.evaluation module
 ----------------------------
 
+This module contains code to evaluate predictions by calculating IOU metrics and average precision values.
+
 .. automodule:: lidar_aug.evaluation
    :members:
    :undoc-members: