CarolinePascal 8353f84f52 docs(configs): bring src/lerobot/configs/ to 100% docstring coverage ...

Documents every remaining public class/function across configs/: the
types.py feature/normalization enums and PolicyFeature, the
PreTrainedConfig and RewardModelConfig base classes (full Args: blocks,
abstract property/method contracts, from_pretrained overrides), the
TrainPipelineConfig and EvalPipelineConfig top-level pipeline configs,
default.py's DatasetConfig/WandBConfig/EvalConfig/PeftConfig/JobConfig,
dataset.py's DatasetRecordConfig, video.py's VideoEncoderConfig, the
accelerator.py ActivationCheckpointingMode enum, and parser.py's CLI
argument-parsing helpers.

Converts existing inline `#` field comments on config dataclasses to
machine-checked Args: blocks (matching each field against its actual
constructor signature), and corrects a couple of stale/misattributed
comments found along the way (EvalPipelineConfig's misplaced field
comment, PreTrainedConfig's phantom normalization_mapping field).

Expands docs/source/api/configs.mdx from 5 documented classes to the
module's full public surface. Adds lerobot.configs to
check_docstrings.py's MODULES_TO_CHECK ratchet and removes the
module's ruff D-ignore. Docstrings and docstring-format changes only;
no behavioral changes.

2026-08-07 11:57:10 +02:00

..

check_config_docstrings.py

docs: write the API reference docstrings

2026-08-06 21:01:34 +02:00

check_docstrings.py

docs(configs): bring src/lerobot/configs/ to 100% docstring coverage

2026-08-07 11:57:10 +02:00

check_doctest_list.py

docs: add API documentation infrastructure

2026-08-06 20:57:26 +02:00

documentation_tests.txt

docs: write the API reference docstrings

2026-08-06 21:01:34 +02:00