LeRobot documentation
環境
環境
シミュレーション環境はEnvConfigによって設定され、make_envによって構築されます。各サブクラスは、そのgym_kwargsとベクトル化環境の構築方法を宣言します。
公開されている環境の使用についてはハブからの環境を、ベンチマークの貢献については新しいベンチマークの追加を参照してください。
EnvConfig
クラス lerobot.envs.EnvConfig
< source >( 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
< source >( task_group: str | None = Nonetask_id: int | None = Nonen_envs: int = 1use_async_envs: bool = False )
1つのタスクに対して、ローカルまたはサーブされたベクトル環境を1つ作成します。task_idを指定しない場合、スイートの最初のタスクが対象となります。
{suite: {task_id: env}} の形式で、ローカルまたはサーブされたベクトル環境を作成します。
この環境の (preprocessor, postprocessor) を返します。デフォルト: identity。
sim_settings()を、シミュレーションのデフォルト値として返します。ローカル環境および環境サーバーが実行するのと同じです。
sim セクションのサーバー YAML と同様に、シミュレーション設定を返します。欠落している項目にはシミュレーションのデフォルト値が使用されます。
デフォルトでは、gym_kwargs とデルタアクションを備えた Gymnasium 環境 gym_id が使用されます。それ以外の場合は、上書きしてください。
make_env
lerobot.envs.make_env
< source >( 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) — 環境設定、またはenv.pyによって環境を構築する Hugging Face Hub リポジトリ ID（例:"username/repo"）。 - n_envs (
int、任意、デフォルトは1) — 各ベクトル環境内の環境数。 - use_async_envs (
bool、省略可能、デフォルトはFalse) — 各環境を独自のワーカープロセスで実行します。 - hub_cache_dir (
str, オプション) — ダウンロードしたenv.pyをキャッシュするフォルダ。リポジトリIDを使用する場合にのみ使用されます。 - trust_remote_code (
bool、任意、デフォルトはFalse) — Hub リポジトリのコードの実行に同意します。リポジトリ ID または EnvHub 設定を使用する際に必要です。
戻り値
dict[str, dict[int, gym.vector.VectorEnv]]
ベクトル環境は、{suite: {task_id: env}} の形式です。単一タスクの環境は1つのスイートを持ち、タスク ID は 0 です。
例外
ValueError または RuntimeError または ModuleNotFoundError
ValueError—n_envsが1未満の場合。RuntimeError— Hub リポジトリのコードがtrust_remote_codeなしで実行される場合。ModuleNotFoundError— シミュレーター、またはリポジトリのenv.pyに必要なパッケージがインストールされていない場合。
設定または Hub リポジトリのmake_envのベクトル環境を構築します。