Skip to content

Commit

Permalink
Fixes entry_point and kwargs in isaaclab_tasks README (#1485)
Browse files Browse the repository at this point in the history
# Description

The entry_point `RLTaskEnv` doesn't exist

It should be `ManagerBasedRLEnv`

## Type of change

- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

Co-authored-by: Kelly Guo <[email protected]>
  • Loading branch information
fan-ziqi and kellyguo11 authored Dec 4, 2024
1 parent 62d3bc0 commit efc1a0b
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions source/extensions/omni.isaac.lab_tasks/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,26 @@ The environments are then registered in the `omni/isaac/lab_tasks/locomotion/vel
```python
gym.register(
id="Isaac-Velocity-Rough-Anymal-C-v0",
entry_point="omni.isaac.lab.envs:RLTaskEnv",
entry_point="omni.isaac.lab.envs:ManagerBasedRLEnv",
disable_env_checker=True,
kwargs={"env_cfg_entry_point": f"{__name__}.rough_env_cfg:AnymalCRoughEnvCfg"},
kwargs={
"env_cfg_entry_point": f"{__name__}.rough_env_cfg:AnymalCRoughEnvCfg",
"rl_games_cfg_entry_point": f"{agents.__name__}:rl_games_rough_ppo_cfg.yaml",
"rsl_rl_cfg_entry_point": f"{agents.__name__}.rsl_rl_ppo_cfg:AnymalCRoughPPORunnerCfg",
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_rough_ppo_cfg.yaml",
},
)

gym.register(
id="Isaac-Velocity-Flat-Anymal-C-v0",
entry_point="omni.isaac.lab.envs:RLTaskEnv",
entry_point="omni.isaac.lab.envs:ManagerBasedRLEnv",
disable_env_checker=True,
kwargs={"env_cfg_entry_point": f"{__name__}.flat_env_cfg:AnymalCFlatEnvCfg"},
kwargs={
"env_cfg_entry_point": f"{__name__}.flat_env_cfg:AnymalCFlatEnvCfg",
"rsl_rl_cfg_entry_point": f"{agents.__name__}.rsl_rl_ppo_cfg:AnymalCFlatPPORunnerCfg",
"rl_games_cfg_entry_point": f"{agents.__name__}:rl_games_flat_ppo_cfg.yaml",
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_flat_ppo_cfg.yaml",
},
)
```

Expand Down

0 comments on commit efc1a0b

Please sign in to comment.