mirror of
https://github.com/huggingface/lerobot.git
synced 2026-05-22 03:59:42 +00:00
chore(doctrings): updating docstrings
This commit is contained in:
@@ -116,11 +116,12 @@ class VideoEncoderConfig:
|
|||||||
check_video_encoder_config_pyav(self)
|
check_video_encoder_config_pyav(self)
|
||||||
|
|
||||||
def resolve_vcodec(self) -> None:
|
def resolve_vcodec(self) -> None:
|
||||||
"""Validate vcodec and resolve 'auto' to best available HW encoder, fallback to libsvtav1.
|
"""Check ``vcodec`` and, when it is ``"auto"``, pick a concrete encoder.
|
||||||
|
|
||||||
Any explicitly-requested codec that isn't in the local FFmpeg build is
|
For ``"auto"``, the first hardware encoder in the preference list that FFmpeg
|
||||||
also silently rewritten to ``libsvtav1`` so encoding never hard-fails on
|
exposes is chosen; if none are available, ``libsvtav1`` is used. If the
|
||||||
a host missing the requested encoder.
|
resolved codec (explicit or after auto-selection) is not present in the
|
||||||
|
local FFmpeg build, raises ``ValueError``.
|
||||||
"""
|
"""
|
||||||
if self.vcodec not in VALID_VIDEO_CODECS:
|
if self.vcodec not in VALID_VIDEO_CODECS:
|
||||||
raise ValueError(f"Invalid vcodec '{self.vcodec}'. Must be one of: {sorted(VALID_VIDEO_CODECS)}")
|
raise ValueError(f"Invalid vcodec '{self.vcodec}'. Must be one of: {sorted(VALID_VIDEO_CODECS)}")
|
||||||
@@ -131,7 +132,7 @@ class VideoEncoderConfig:
|
|||||||
logger.info(f"Auto-selected video codec: {encoder}")
|
logger.info(f"Auto-selected video codec: {encoder}")
|
||||||
self.vcodec = encoder
|
self.vcodec = encoder
|
||||||
return
|
return
|
||||||
logger.info("No hardware encoder available, falling back to software encoder 'libsvtav1'")
|
logger.warning("No hardware encoder available, falling back to software encoder 'libsvtav1'")
|
||||||
self.vcodec = "libsvtav1"
|
self.vcodec = "libsvtav1"
|
||||||
|
|
||||||
if self.detect_available_encoders(self.vcodec):
|
if self.detect_available_encoders(self.vcodec):
|
||||||
|
|||||||
Reference in New Issue
Block a user