diff --git a/docs/source/video_encoding_parameters.mdx b/docs/source/video_encoding_parameters.mdx index a32781243..6ac7d5e3e 100644 --- a/docs/source/video_encoding_parameters.mdx +++ b/docs/source/video_encoding_parameters.mdx @@ -57,7 +57,7 @@ All flags below are prefixed with `--dataset.camera_encoder.` on the CLI. | `vcodec` | `str` | `"libsvtav1"` | Video codec name. `"auto"` picks the first available hardware encoder from a fixed preference list, falling back to `libsvtav1`. | | `pix_fmt` | `str` | `"yuv420p"` | Output pixel format. Must be supported by the chosen codec in your FFmpeg build. | | `g` | `int` | `2` | GOP size — a keyframe every `g` frames. Emitted as FFmpeg option `g`. | -| `crf` | `int` | `30` | Abstract quality value, mapped per codec (see the [mapping](#mapping-videoencoderconfig--ffmpeg-options) below). Lower → higher quality / larger output where the mapping is monotone. | +| `crf` | `int` or `float` | `30` | Abstract quality value, mapped per codec (see the [mapping](#mapping-videoencoderconfig--ffmpeg-options) below). Lower → higher quality / larger output where the mapping is monotone. | | `preset` | `int` or `str` | `12` \* | Encoder speed preset; meaning depends on the codec.
\* When unset and `vcodec=libsvtav1`, LeRobot defaults to `12`. | | `fast_decode` | `int` | `0` | `libsvtav1`: `0–2`, passed via `svtav1-params`.
`h264` / `hevc` (software): if `>0`, sets `tune=fastdecode`.
Other codecs: usually unused. | | `video_backend` | `str` | `"pyav"` | Only `"pyav"` is currently implemented for video encoding. | diff --git a/src/lerobot/configs/video.py b/src/lerobot/configs/video.py index d6a87bce9..803397c9d 100644 --- a/src/lerobot/configs/video.py +++ b/src/lerobot/configs/video.py @@ -146,7 +146,7 @@ class VideoEncoderConfig: For ``"auto"``, the first hardware encoder in the preference list that is available is chosen; if none are available, ``libsvtav1`` is used. If the resolved codec (explicit or after auto-selection) is not available, raises ``ValueError``. - Stream-derived canonical codec names listed in :data:`VIDEO_CODEC_ALIASES` are + Stream-derived canonical codec names listed in :data:`VIDEO_CODECS_ALIASES` are rewritten to their corresponding encoder name (e.g. ``"av1"`` → ``"libsvtav1"``). """ self.vcodec = VIDEO_CODECS_ALIASES.get(self.vcodec, self.vcodec)