Issue
The README provides a brief introduction to the new data format named Capture, but the usage example provided at the end seems to be incomplete. Specifically, the code snippet ends abruptly with session = capture.sessions[session_, which can lead to confusion for new users trying to understand how to utilize the Capture object.
Suggested Improvements
-
Complete the Usage Example: Provide a complete example that demonstrates how to access the session object after retrieving it from capture.sessions. This will help users better understand how to work with the Capture object.
For instance:
from scantools.capture import Capture
capture = Capture.load('data/CAB/')
print(capture.sessions.keys())
session_key = list(capture.sessions.keys())[0] # Get the first session key
session = capture.sessions[session_key] # Access the first session
print(session)
-
Add Basic Documentation: Consider adding a short description of what the session object contains and how it can be used in the context of localization and mapping.
These improvements will enhance the clarity of the documentation and provide better guidance for users exploring the LaMAR Benchmark.
Issue
The README provides a brief introduction to the new data format named Capture, but the usage example provided at the end seems to be incomplete. Specifically, the code snippet ends abruptly with
session = capture.sessions[session_, which can lead to confusion for new users trying to understand how to utilize the Capture object.Suggested Improvements
Complete the Usage Example: Provide a complete example that demonstrates how to access the
sessionobject after retrieving it fromcapture.sessions. This will help users better understand how to work with theCaptureobject.For instance:
Add Basic Documentation: Consider adding a short description of what the
sessionobject contains and how it can be used in the context of localization and mapping.These improvements will enhance the clarity of the documentation and provide better guidance for users exploring the LaMAR Benchmark.