LeRobot documentation
設定
設定
LeRobotの設定はdraccusによって解析されるプレーンなdataclassであり、すべてのフィールドがCLIから設定できます。TrainPipelineConfigはlerobot-trainのトップレベルオブジェクトです。
多態的な設定（ポリシー、ロボット、環境）はdraccus.ChoiceRegistryを使用します。サブクラスは@register_subclass("name")で自身を登録し、その後、コマンドラインでその名前によって選択可能になります。
TrainPipelineConfig
class lerobot.configs.train.TrainPipelineConfig
< source >( dataset: DatasetConfigenv: lerobot.envs.configs.EnvConfig | None = Nonepolicy: lerobot.configs.policies.PreTrainedConfig | None = Nonereward_model: lerobot.configs.rewards.RewardModelConfig | None = Noneoutput_dir: pathlib.Path | None = Nonejob_name: str | None = Noneresume: bool = Falseseed: int | None = 1000cudnn_deterministic: bool = Falsetf32: bool | None = Truenum_workers: int = 4batch_size: int = 8prefetch_factor: int = 4persistent_workers: bool = Truedataloader_multiprocessing_context: str | None = 'spawn'steps: int = 100000env_eval_freq: int = 20000log_freq: int = 200eval_steps: int = 0max_eval_samples: int = 0tolerance_s: float = 0.0001save_checkpoint: bool = Truesave_freq: int = 20000checkpoint_format: CheckpointFormat = <CheckpointFormat.SAFETENSORS: 'safetensors'>use_policy_training_preset: bool = Trueoptimizer: lerobot.optim.optimizers.OptimizerConfig | None = Nonescheduler: lerobot.optim.schedulers.LRSchedulerConfig | None = Noneparallelism: ParallelismConfig = <factory>accelerator: AcceleratorConfig = <factory>eval: EvalConfig = <factory>ema: lerobot.optim.ema.EMAConfig | None = Nonetrackio: TrackioConfig = <factory>peft: lerobot.configs.default.PeftConfig | None = Nonejob: JobConfig = <factory>save_checkpoint_to_hub: bool = Falsesample_weighting: lerobot.utils.sample_weighting.SampleWeightingConfig | None = Nonerename_map: dict = <factory> )
PreTrainedConfig
class lerobot.configs.PreTrainedConfig
< source >( n_obs_steps: int = 1input_features: dict[str, lerobot.configs.types.PolicyFeature] | None = <factory>output_features: dict[str, lerobot.configs.types.PolicyFeature] | None = <factory>device: str | None = Nonedtype: torch.dtype | None = Noneuse_amp: bool = Falseuse_peft: bool = Falsepush_to_hub: bool = Truerepo_id: str | None = Noneprivate: bool | None = Nonetags: list[str] | None = Nonelicense: str | None = Nonepretrained_path: pathlib.Path | None = Nonepretrained_revision: str | None = None )
パラメータ
- n_obs_steps — ポリシーに渡す環境ステップ分の観測の数（現在のステップと、それより前の追加のステップを含む）。
- input_features — ポリシーの入力データに関する PolicyFeature を定義する辞書です。キーは入力データの名称を表し、値は FeatureType と shape 属性で構成される PolicyFeature です。
- output_features — ポリシーの出力データの PolicyFeature を定義する辞書です。キーは出力データの名称を表し、値は FeatureType と shape 属性で構成される PolicyFeature です。
- normalization_mapping — FeatureType の str 値（例: “STATE”、“VISUAL”）から、対応する NormalizationMode（例: NormalizationMode.MIN_MAX）へのマッピングを行う辞書
ポリシーモデル用のベース設定クラス。
DatasetConfig
クラス lerobot.configs.DatasetConfig
< source >( repo_id: strrepo_type: str = 'dataset'root: str | None = Noneepisodes: list[int] | None = Noneexclude_episodes: list[int] | None = Noneimage_transforms: ImageTransformsConfig = <factory>revision: str | None = Noneuse_imagenet_stats: bool = Truevideo_backend: str = <factory>return_uint8: bool = Falsedepth_output_unit: str = 'mm'streaming: bool = Falsestreaming_episode_pool_size: int | None = Nonestreaming_sampling_strategy: StreamingSamplingStrategy = <StreamingSamplingStrategy.REMAINING: 'remaining'>streaming_prefetch_episodes: int = 8streaming_byte_budget_gb: float = 8.0streaming_decode_threads: int = 2streaming_decoded_queue_size: int = 8streaming_native_http_connections: int | None = Nonestreaming_native_http_subranges: int = 1streaming_sidecar_lock_timeout_s: float = 1800video_decoder_cache_size: int | None = Noneeval_split: float = 0.0 )
EvalConfig
クラス lerobot.configs.EvalConfig
< source >( n_episodes: int = 50batch_size: int = 0use_async_envs: bool = Truerecording: bool = Falserecording_repo_id: str | None = Nonerecording_private: bool = False )
TrackioConfig
class lerobot.configs.TrackioConfig
< source >( enable: bool = Falsedisable_artifact: bool = Trueproject: str = 'lerobot'space_id: str | None = Noneprivate: bool | None = Nonerun_name: str | None = Noneresume: str | None = Nonecapture_console: bool = True )
Trackio(https://huggingface.co/docs/trackio)によるトレーニング実行のトラッキング。
ランは~/.cache/huggingface/trackio以下のローカルの SQLite データベースに保存され、trackio show --project <project>で表示できます。代わりに Hugging Face Space にランを同期する場合は、space_idを設定してください。