Farama-Foundation / Minigrid

Simple and easily configurable grid world environments for reinforcement learning
https://minigrid.farama.org/
Other
2.09k stars 604 forks source link

[Bug Report] Unlock Pickup env is actually just Unlock #399

Closed Howuhh closed 11 months ago

Howuhh commented 1 year ago

The documentation for Unlock Pickup environment seems to have the wrong description or registration. The description says that the agent needs to open a door and pick up an object. However, only MiniGrid-Unlock-v0 is available, in which the agent only needs to open the door and there are no items to pick up.

Easy to verify:

python -m minigrid.manual_control --env-id=MiniGrid-Unlock-v0

P.S. Actually, it is available here, so documentation should be fixed only.

Checklist

pseudo-rnd-thoughts commented 1 year ago

Looking at the documentation, the creation row in the table is correct with gymnasium.make("MiniGrid-UnlockPickup-v0") However, the registered configuration is wrong - https://minigrid.farama.org/environments/minigrid/UnlockPickupEnv/#registered-configurations

Is this what you think is wrong?

Howuhh commented 1 year ago

@pseudo-rnd-thoughts Yup, as least it is confusing..

pseudo-rnd-thoughts commented 1 year ago

Ok, could you make a PR to fix the documentation

BolunDai0216 commented 11 months ago

Closed due to inactivity, feel free to reopen this issue if the problem persists.