LeRobot documentation

Окружения

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.7.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Окружения

Среды симуляции настраиваются через EnvConfig и создаются с помощью make_env или make_task_env для одной задачи. Конфигурация содержит только параметры; её метод sim_settings() преобразует их в именованные аргументы для интеграции с конкретным симулятором.

См. Simulation, чтобы узнать, как используются среды, EnvHub — для использования и публикации сред на Hub, а также Adding a Benchmark — для добавления собственного бенчмарка.

HubEnvConfig

класс lerobot.envs.HubEnvConfig

< >

( task: str | None = Nonefps: int = 30features: dict[str, PolicyFeature] = <factory>features_map: dict[str, str] = <factory>max_parallel_tasks: int = 1disable_env_checker: bool = Trueserver: EnvClientConfig | None = Nonehub_path: str | None = Nonetrust_remote_code: bool = Falsemake_env_kwargs: dict[str, Any] = <factory>use_native_batch: bool = False )

Окружение из файла env.py в репозитории EnvHub; для его запуска требуется trust_remote_code.

EnvConfig

класс lerobot.envs.EnvConfig

< >

( task: str | None = Nonefps: int = 30features: dict[str, PolicyFeature] = <factory>features_map: dict[str, str] = <factory>max_parallel_tasks: int = 1disable_env_checker: bool = Trueserver: EnvClientConfig | None = None )

Параметры среды. make_env создаёт среду на основе её sim_settings().

create_env

< >

( *args: Any**kwargs: Any )

Удалено: создание окружения для одной задачи с помощью lerobot.envs.make_task_env(config, task_group, task_id, ...).

create_envs

< >

( *args: Any**kwargs: Any )

Удалено: создание окружений с помощью lerobot.envs.make_env(config, n_envs, use_async_envs).

get_env_processors

< >

( )

Возвращает (preprocessor, postprocessor) для этой среды. По умолчанию: identity.

sim_config

< >

( )

Возвращает sim_settings() с параметрами по умолчанию симуляции, как это делают локальные окружения и сервер окружений.

sim_settings

< >

( )

Возвращает настройки симуляции, как в разделе sim YAML-файла сервера; отсутствующие значения заменяются значениями по умолчанию для симуляции.

По умолчанию используется среда Gymnasium gym_id с gym_kwargs и дельта-действиями; при необходимости переопределите эти параметры.

make_env

lerobot.envs.make_env

< >

( cfg: EnvConfign_envs: int = 1use_async_envs: bool = False ) → dict[str, dict[int, gym.vector.VectorEnv]]

Параметры

  • cfg (EnvConfig) — Конфигурация окружения. Репозиторий EnvHub — это HubEnvConfig(hub_path="user/repo", trust_remote_code=True).
  • n_envs (int, необязательный, по умолчанию 1) — Количество сред в каждом векторном окружении.
  • use_async_envs (bool, необязательный, по умолчанию False) — Запускать каждую среду в собственном рабочем процессе.

Возвращает

dict[str, dict[int, gym.vector.VectorEnv]]

Векторные среды, в формате {suite: {task_id: env}}. Однозадачная среда имеет один набор с идентификатором задачи 0.

Исключения

ValueError или RuntimeError или ModuleNotFoundError

  • ValueError — если n_envs меньше 1.
  • RuntimeError — если код репозитория EnvHub может выполняться без trust_remote_code в его конфигурации.
  • ModuleNotFoundError — если симулятор или пакет, необходимый для env.py репозитория, не установлен.

Создайте векторные среды для конфигурации.

make_task_env

lerobot.envs.make_task_env

< >

( cfg: EnvConfigtask_group: str | None = Nonetask_id: int | None = Nonen_envs: int = 1use_async_envs: bool = False )

Создайте локальную или обслуживаемую векторную среду для одной задачи; отсутствие task_id означает первую задачу набора.

make_env_config

lerobot.envs.make_env_config

< >

( env_type: str**kwargs )

Update on GitHub