Hugging Face's logo

LeRobot documentation

Environnements

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Environnements

Les environnements de simulation sont configurés via EnvConfig et construits par make_env. Chaque sous-classe déclare ses gym_kwargs et la manière de construire les environnements vectorisés.

Consultez Environments from the Hub pour utiliser des environnements publiés et Adding a New Benchmark pour en contribuer un.

EnvConfig

classe 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 )

Créez un environnement vectoriel local ou servi pour une tâche ; l’absence de task_id désigne la première tâche de la suite.

create_envs

< >

( n_envs: intuse_async_envs: bool = False )

Créez des environnements vectoriels locaux ou servis, sous la forme {suite: {task_id: env}}.

get_env_processors

< >

( )

Retourne (preprocessor, postprocessor) pour cet env. Par défaut : identité.

sim_config

< >

( )

Retourne sim_settings() avec les valeurs par défaut de la simulation, telles que les environnements locaux et le serveur d’environnement les exécutent.

sim_settings

< >

( )

Retourne les paramètres de simulation, comme dans la section sim d’un YAML de serveur ; les paramètres manquants utilisent les valeurs par défaut de simulation.

Par défaut, l’environnement Gymnasium est gym_id avec gym_kwargs et des actions delta ; à modifier le cas échéant.

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]]

Paramètres

  • cfg (EnvConfig | str) — La configuration d’environnement, ou un identifiant de dépôt du Hugging Face Hub (par ex. "username/repo") dont le fichier env.py construit les environnements.
  • n_envs (int, facultatif, par défaut 1) — Nombre d'environnements dans chaque environnement vectoriel.
  • use_async_envs (bool, facultatif, valeur par défaut False) — Exécute chaque environnement dans son propre processus de travail.
  • hub_cache_dir (str, facultatif) — Dossier dans lequel mettre en cache le fichier env.py téléchargé. Utilisé uniquement avec un identifiant de dépôt.
  • trust_remote_code (bool, facultatif, valeur par défaut False) — Consentement à exécuter le code d’un dépôt du Hub, requis pour un identifiant de dépôt ou une configuration EnvHub.

Retourne

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

Les environnements vectoriels, sous la forme {suite: {task_id: env}}. Un environnement à tâche unique possède une seule suite, avec l'identifiant de tâche 0.

Lève

ValueError ou RuntimeError ou ModuleNotFoundError

  • ValueError — Si n_envs est inférieur à 1.
  • RuntimeError — Si le code d’un dépôt du Hub s’exécuterait sans trust_remote_code.
  • ModuleNotFoundError — Si le simulateur, ou un package requis par le fichier env.py du dépôt, n’est pas installé.

Construire les environnements vectoriels d’une configuration ou de la fonction make_env d’un dépôt du Hub.

make_env_config

lerobot.envs.make_env_config

< >

( env_type: str**kwargs )

Update on GitHub

←Processeurs Configuration→