LeRobot documentation

Окружения

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Окружения

Среды симуляции настраиваются через EnvConfig и создаются с помощью make_env. Каждый подкласс объявляет свои gym_kwargs и способ построения векторизованных сред.

См. Окружения из Hub для использования опубликованных окружений и Добавление нового бенчмарка для внесения своего.

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 )

create_env

< >

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

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

create_envs

< >

( n_envs: intuse_async_envs: bool = False )

Создавайте локальные или обслуживаемые векторные среды в формате {suite: {task_id: env}}.

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: EnvConfig | strn_envs: int = 1use_async_envs: bool = Falsehub_cache_dir: str | None = Nonetrust_remote_code: bool = False ) → dict[str, dict[int, gym.vector.VectorEnv]]

Параметры

  • cfg (EnvConfig | str) — Конфигурация окружения или ID репозитория Hugging Face Hub (например, "username/repo"), в котором env.py создает окружения.
  • n_envs (int, необязательный, по умолчанию 1) — Количество сред в каждом векторном окружении.
  • use_async_envs (bool, необязательный, по умолчанию False) — Запускать каждую среду в собственном рабочем процессе.
  • hub_cache_dir (str, необязательный) — Папка для кэширования загруженного файла env.py. Используется только при указании идентификатора репозитория.
  • trust_remote_code (bool, необязательный, по умолчанию False) — Согласие на выполнение кода из репозитория Hub, необходимое для использования идентификатора репозитория или конфигурации EnvHub.

Возвращает

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

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

Исключения

ValueError или RuntimeError или ModuleNotFoundError

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

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

make_env_config

lerobot.envs.make_env_config

< >

( env_type: str**kwargs )

Update on GitHub