docs(warning): adding warning regarding encoding parameters modification

This commit is contained in:
CarolinePascal
2026-05-13 16:08:51 +02:00
parent d1917a4871
commit f0830972f0
2 changed files with 8 additions and 1 deletions
@@ -43,6 +43,13 @@ lerobot-record \
## Tuning parameters ## Tuning parameters
<Tip warning={true}>
The defaults are tuned to balance **compression ratio**, **visual quality**, and **decoding/seek speed** for typical robotics datasets. Changing them can affect both recording (CPU load, frame drops) and training (decoding throughput, image quality).
Only override these parameters if you have a specific reason to, and measure the impact on your pipeline before relying on the new settings.
</Tip>
All flags below are prefixed with `--dataset.camera_encoder.` on the CLI. All flags below are prefixed with `--dataset.camera_encoder.` on the CLI.
| Parameter | Type | Default | Description | | Parameter | Type | Default | Description |
+1 -1
View File
@@ -81,7 +81,7 @@ def merge_video_feature_info_for_aggregate(all_metadata: list[LeRobotDatasetMeta
if fallback_keys: if fallback_keys:
logging.warning( logging.warning(
f"Merging heterogeneous or incomplete video encoder metadata for feature {vk}. " f"Merging heterogeneous or incomplete video encoder metadata for feature {vk}. "
f"Setting these keys to null (video.extra_options -> {fallback_keys}).", f"Setting these keys to null: {fallback_keys}.",
) )
merged_info[vk]["info"] = {**base_video_info, **merged_encoder_info} merged_info[vk]["info"] = {**base_video_info, **merged_encoder_info}