Release notes for v1.2.0

The changes in this release allow for compatibility with the latest Gym release v0.26. For more information on the API changes in Gym v0.26 see the release notes in https://github.com/openai/gym/releases.

Previous Gym versions such as v0.22, v0.23, v0.24, and v0.25 are no longer compatible.

The aim of this version is primarily bug fixing, if you find that this does not work, please make an issue or put a message on the Gym discord server in the gym-minigrid channel (https://discord.gg/nHg2JRN489).

If you are interested in working on gym-minigrid then message PseudoRnd or Rodridelaz on discord.

Major Changes

• Support of new step API. The Env.step function returns 5 values instead of 4 previously (observations, reward, termination, truncation, info). . @saleml
• Support of new reset API. The Env.reset function returns two values (obs and info). @rodrigodelazcano
• Support of new rendering API. More information about the rendering API can be found in this blog post @rodrigodelazcano
• Add new test files for window.py, benchmark.py and manual_control.py under test_scripts.py.@saleml

Minor Changes

• Add docstrings to environments @vairodp
• Add paper "History Compression via Language Models in Reinforcement Learning" to README. @pseudo-rnd-thoughts
• Fix import issue #215 @rodrigodelazcano

This release is compatible with Gym versions, v0.22, v0.23, v0.24 and v0.25. Incompatible Gym version with v0.21 due to Env.reset(seed)

The aim of this version is primarily bug fixing, if you find that this does not work, please make an issue or put a message on the Gym discord server in the gym-minigrid channel (https://discord.gg/nHg2JRN489).

If you are interested in working on gym-minigrid then message me on discord, PseudoRnd

Changes

• Removes compatibility with python 3.6 due to python foundation no longer supporting it @rodrigodelazcano
• Moved benchmark.py and manual_control.py to gym_minigrid folder @rodrigodelazcano
• Added MissionSpace that is similar to the Gym Text space to specify the space for all environments @rodrigodelazcano
• Fixed benchmark.py and manual_control.py to work @rodrigodelazcano
• Updated the metadata keys of environment “render.mode” to “render_mode” and “render.fps” to “render_fps” @saleml #194
• Fixed the wrappers that updated the environment observation space rather than the wrapper observation space @saleml #194
• Added wrapper DictObservationSpaceWrapper for changing the mission text to an embedding array. @saleml #194
• Added support for setting a custom max_steps value in door key environment @zeionara #193
• Removed all cases of from XYZ import * and from .XYZ import ABC in favor of absolute imports. This could cause issues for users that use from gym_minigrid import * @pseudo-rnd-thoughts #201
• Rename environments and files for consistency and removed unnecessary environment classes in favor of kwargs in gym.make @pseudo-rnd-thoughts #202
  • BlockedUnlockPickup -> BlockedUnlockPickupEnv
  • KeyCorridor -> KeyCorridorEnv
  • LockedRoom -> LockedRoomEnv and Room -> LockedRoom (this is as multiroom also contains a Room to prevent conflict changed both of their names)
  • Room -> MultiRoom in multiroom.py
  • playground_v0.py -> playground and PlaygroundV0 -> PlaygroundEnv
  • Unlock -> UnlockEnv
  • UnlockPickup -> UnlockPickupEnv
• Added minimal type checking with pyright @rodrigodelazcano
• Register environments with entrypoint @rodrigodelazcano

# Old
import gym_minigrid
import gym
env = gym.make('MiniGrid-PutNear-6x6-N2-v0')
# or
import gym
env = gym.make('gym_minigrid:MiniGrid-PutNear-6x6-N2-v0')
    
# New
import gym
env = gym.make('MiniGrid-PutNear-6x6-N2-v0')

• Fixed FlatObsWrapper to contain “,” and increase the numCharCodes=28 @saleml #207