Merge pull request #83 from ethz-asl/feature/report_resource_usage

Report resource usage

Author: victorreijgwart

.github/pull_request_template.md

@@ -1,50 +1,99 @@
 # Description
 
-Thank you for opening a PR. Please summarize the changes in 1 or 2 sentences.
+Thank you for opening a PR! Please summarize the changes in 1–2 sentences.
 
 ## Type of change
 
-Delete options that are not relevant.
-
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Breaking change (fix or feature that causes existing functionality to not work as expected)
+- [ ] Other (please describe):
+
+## Detailed Summary
+
+Provide the motivation, context, and links to any related issues, PRs, or documentation:
+
+- Motivation: Why is this change necessary?
+- Context: How does it fit into wavemap's functionality?
+- Related issues/PRs: Fixes # (issue) / Links to other PRs
+
+## API Changes
+
+List any changes to wavemap's APIs to help users update their code. Write "None" if there are no changes.
+
+### C++ API:
+
+*
+
+### Python API:
+
+*
 
-## Detailed summary
+### ROS1 Interface:
 
-Please describe the motivation, context and a link to related issues (if appropriate). List any dependencies that are required for this change.
+*
 
-Feel free to summarize the changes as a list of bullet points.
+## Review Notes
 
-Fixes # (issue)
+Is there anything specific the reviewers should focus on, or are there unresolved questions? Mention them here.
 
 # Testing
 
-If possible, verify that the changes produce the desired results by extending the unit tests. If you would like us to help you with this, feel free to open the pull request already and let us know.
+### Automated Tests
 
-If manual tests were performed to verify these changes, please describe them here and provide instructions to reproduce them. Please also list any relevant details for your test configuration below.
+Have you added or modified unit tests to verify these changes? If not, let us know if you'd like assistance.
 
-If the changes are performance related, this is a good place to list the metrics that were used and the improvements that have been achieved.
+### Manual Tests
 
-**System information (please complete if relevant):**
-- CPU: [e.g. Intel i9-9900K]
-- GPU: [e.g. Nvidia RTX 2080Ti]  # Only for visualization-related issues
-- RAM: [e.g. 32GB]
-- OS: [e.g. Ubuntu 20.04]
-- Installation: [e.g., Native (ROS with catkin); or Docker]
+If manual tests were performed to verify these changes, describe them here and include instructions to reproduce them.
+Describe test configurations where applicable.
 
-**Runtime information (please complete if relevant):**
-- Launch file: [e.g. Link to the launch file you used]
-- Config file: [e.g. Link to the config file you used]
-- Dataset name [e.g. Newer College Cloister sequence]  # For public datasets
-- Custom setup:                                        # For online use or personal datasets
-    - Depth sensor: [e.g. Livox MID360 LiDAR]
-    - Pose source: [e.g. Odometry from FastLIO2]
+**System information (optional):**
 
-# Checklist:
+- CPU: [e.g., Intel i9-9900K]
+- GPU: [e.g., Nvidia RTX 2080Ti]
+- RAM: [e.g., 32GB]
+- OS: [e.g., Ubuntu 20.04]
+- API: [e.g., C++, Python, ROS1]
+- Installation: [e.g., pre-built Docker, local CMake, Pip, catkin]
+
+**Runtime information (optional):**
+
+- Launch file: [e.g., Link or GitHub Gist]
+- Config file: [e.g., Link or GitHub Gist]
+- Dataset name (if public): [e.g., Newer College Cloister]
+- Custom setup (for private datasets, or live usage):
+    - Depth sensor: [e.g., Livox MID360 LiDAR]
+    - Pose source: [e.g., Odometry from FastLIO2]
+
+For performance or accuracy-related changes, include the above system and runtime information and describe:
+
+- **Performance (optional)**
+    - Measured operation: [e.g. serializing the map, performing 1M queries, processing dataset X]
+    - Metrics [e.g., CPU time, wall time, total RAM usage]
+- **Accuracy (optional)**
+    - Metrics: [e.g., AUC, accuracy, recall]
+- **Summary of changes**
+    - What metrics improved and by how much?
+    - Did any metrics worsen?
+
+### Benchmarks (To be completed by maintainers)
+
+We will rerun wavemap's benchmarks and report the results here to validate there are no general performance/accuracy regressions.
+
+# Checklist
+
+General
 
 - [ ] My code follows the style guidelines of this project
 - [ ] I have performed a self-review of my code
 - [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
+- [ ] I have added or updated tests as required
 - [ ] Any required changes in dependencies have been committed and pushed
+
+Documentation (where applicable)
+
+- [ ] I have updated the installation instructions (in docs/pages/installation)
+- [ ] I have updated the code's inline API documentation (e.g., docstrings)
+- [ ] I have updated the parameter documentation (in docs/pages/parameters)
+- [ ] I have updated/extended the tutorials (in docs/pages/tutorials)

examples/cpp/CHANGELOG.rst

@@ -2,6 +2,9 @@
 Changelog for package wavemap_examples_cpp
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+2.1.2 (2024-11-20)
+------------------
+
 2.1.1 (2024-10-24)
 ------------------
 

examples/cpp/CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.10)
-project(wavemap_examples_cpp VERSION 2.1.1 LANGUAGES CXX)
+project(wavemap_examples_cpp VERSION 2.1.2 LANGUAGES CXX)
 
 # Load the wavemap library
 # First, try to load it from sources

examples/python/CHANGELOG.rst

@@ -2,6 +2,9 @@
 Changelog for package wavemap_examples_python
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+2.1.2 (2024-11-20)
+------------------
+
 2.1.1 (2024-10-24)
 ------------------
 

examples/ros1/CHANGELOG.rst

@@ -2,6 +2,9 @@
 Changelog for package wavemap_examples_ros1
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+2.1.2 (2024-11-20)
+------------------
+
 2.1.1 (2024-10-24)
 ------------------
 * Address warnings from new cpplint version (v2.0)

examples/ros1/package.xml

@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='utf-8'?>
 <package format="2">
   <name>wavemap_examples_ros1</name>
-  <version>2.1.1</version>
+  <version>2.1.2</version>
   <description>Usages examples for wavemap's ROS1 interface.</description>
 
   <maintainer email="[email protected]">Victor Reijgwart</maintainer>

interfaces/ros1/wavemap/CHANGELOG.rst

@@ -2,6 +2,9 @@
 Changelog for package wavemap
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+2.1.2 (2024-11-20)
+------------------
+
 2.1.1 (2024-10-24)
 ------------------
 

interfaces/ros1/wavemap/package.xml

@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='utf-8'?>
 <package format="2">
   <name>wavemap</name>
-  <version>2.1.1</version>
+  <version>2.1.2</version>
   <description>Base library for wavemap.</description>
 
   <maintainer email="[email protected]">Victor Reijgwart</maintainer>

interfaces/ros1/wavemap_all/CHANGELOG.rst

@@ -2,6 +2,9 @@
 Changelog for package wavemap_all
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+2.1.2 (2024-11-20)
+------------------
+
 2.1.1 (2024-10-24)
 ------------------
 

interfaces/ros1/wavemap_all/package.xml

@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='utf-8'?>
 <package format="2">
   <name>wavemap_all</name>
-  <version>2.1.1</version>
+  <version>2.1.2</version>
   <description>Metapackage that builds all wavemap packages.</description>
 
   <maintainer email="[email protected]">Victor Reijgwart</maintainer>