mirror of
https://github.com/huggingface/lerobot.git
synced 2026-08-08 17:39:44 +00:00
docs(cameras): write the API reference docstrings
Takes src/lerobot/cameras/ to 100% public docstring coverage, the first module of Wave 1 after Person A's robots/ pilot and infrastructure PR. Converts the three config classes that already had prose but used a bold **Attributes**: block (invisible to check_docstrings.py, not the standard's Args: pattern for config dataclasses) and documents the previously-bare CameraConfig, its three enums, ZMQCameraConfig, and the module's utility functions. Adds per-backend sections to docs/source/api/cameras.mdx and removes the module's ruff D-ignore. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -22,3 +22,52 @@ See the [Cameras guide](../cameras) for choosing and configuring a camera, and
|
||||
## make_cameras_from_configs
|
||||
|
||||
[[autodoc]] lerobot.cameras.make_cameras_from_configs
|
||||
|
||||
## ColorMode
|
||||
|
||||
[[autodoc]] lerobot.cameras.ColorMode
|
||||
|
||||
## Cv2Rotation
|
||||
|
||||
[[autodoc]] lerobot.cameras.Cv2Rotation
|
||||
|
||||
## Cv2Backends
|
||||
|
||||
[[autodoc]] lerobot.cameras.Cv2Backends
|
||||
|
||||
## OpenCVCamera
|
||||
|
||||
The default backend for USB webcams and video files, built on OpenCV.
|
||||
|
||||
[[autodoc]] lerobot.cameras.opencv.OpenCVCamera
|
||||
- all
|
||||
|
||||
[[autodoc]] lerobot.cameras.opencv.OpenCVCameraConfig
|
||||
|
||||
## RealSenseCamera
|
||||
|
||||
Intel RealSense cameras, with optional depth sensing.
|
||||
|
||||
[[autodoc]] lerobot.cameras.realsense.RealSenseCamera
|
||||
- all
|
||||
|
||||
[[autodoc]] lerobot.cameras.realsense.RealSenseCameraConfig
|
||||
|
||||
## Reachy2Camera
|
||||
|
||||
Cameras exposed by a Reachy 2 robot's own camera manager.
|
||||
|
||||
[[autodoc]] lerobot.cameras.reachy2_camera.Reachy2Camera
|
||||
- all
|
||||
|
||||
[[autodoc]] lerobot.cameras.reachy2_camera.Reachy2CameraConfig
|
||||
|
||||
## ZMQCamera
|
||||
|
||||
Reads frames published over a ZeroMQ socket by `ImageServer`, for cameras attached to a different machine
|
||||
than the one running the policy.
|
||||
|
||||
[[autodoc]] lerobot.cameras.zmq.ZMQCamera
|
||||
- all
|
||||
|
||||
[[autodoc]] lerobot.cameras.zmq.ZMQCameraConfig
|
||||
|
||||
Reference in New Issue
Block a user