Hugging Face's logo

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. ويعلن كل فرع فرعي عن gym_kwargs وكيفية بناء البيئات المتجهية.

راجع البيئات من المركز لاستخدام البيئات المنشورة، وراجع إضافة معيار جديد للمساهمة في إضافة معيار.

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 = True )

create_envs

< >

( n_envs: intuse_async_envs: bool = False )

إنشاء {suite: {task_id: VectorEnv}}.

الافتراضي: بيئة مهمة واحدة عبر gym.make(). تتجاوز معايير الأداء متعددة المهام هذا الافتراضي. AsyncVectorEnv هو الافتراضي عندما يكون n_envs > 1؛ يتم التحويل تلقائيًا إلى Sync عندما يكون n_envs=1.

get_env_processors

< >

( )

يعيد (المعالج المسبق، المعالج اللاحق) لهذا البيئة. الافتراضي: الهوية.

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) — إما كائن EnvConfig يصف البيئة التي سيتم بناؤها محليًا، أو معرّف مستودع على Hugging Face Hub (مثل "username/repo"). في الحالة الأخيرة، يجب أن يتضمن المستودع ملف Python (عادةً env.py).
  • n_envs (int, اختياري) — عدد البيئات المتوازية التي يجب إرجاعها. القيمة الافتراضية هي 1.
  • use_async_envs (bool, اختياري) — ما إذا كان يجب إرجاع AsyncVectorEnv أو SyncVectorEnv. القيمة الافتراضية هي False.
  • hub_cache_dir (str | None) — مسار تخزين مؤقت اختياري للملفات المحمّلة من الـ hub.
  • trust_remote_code (bool) — موافقة صريحة لتنفيذ الأكواد البعيدة من Hub. الافتراضي False — يجب تعيينه إلى True لاستيراد/تنفيذ env.py الخاص بـ hub.

يعيد

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

خريطة من اسم المجموعة إلى بيئات متجهية مفهرسة.

  • للمعايير متعددة المهام (مثل LIBERO): إدخال واحد لكل مجموعة، وبيئة متجهية واحدة لكل task_id.
  • لبيئات المهام المفردة: إدخال واحد في المجموعة (cfg.type) بقيمة task_id=0.

يرفع

ValueError أو ModuleNotFoundError

  • ValueError — إذا كان n_envs < 1
  • ModuleNotFoundError — إذا لم يتم تثبيت حزمة البيئة المطلوبة

ينشئ بيئة متجهية من نوع gym وفقاً للإعداد أو المرجع الخاص بـ Hub.

make_env_config

lerobot.envs.make_env_config

< >

( env_type: str**kwargs )

Update on GitHub

←المعالجات الإعداد→