Minigrid

Bug Fixes and Documentation Updates
* Added Docstrings to the BabyAI environments by BolunDai0216 in https://github.com/Farama-Foundation/Minigrid/pull/302
* Fixed entry point typo for MiniGrid-SimpleCrossingS11N5-v0 by jbloomAus in https://github.com/Farama-Foundation/Minigrid/pull/306
* Fixed not changing view size bug in ViewSizeWrapper jbloomAus in https://github.com/Farama-Foundation/Minigrid/pull/305

**Full Changelog**: https://github.com/Farama-Foundation/minigrid/compare/v2.1.0...v2.1.1

What's Changed
* Added new [BabyAI](https://github.com/mila-iqia/babyai) level environments. saleml
* New documentation website at https://minigrid.farama.org/ SiddarGu mgoulao. jjshoots
* Update security permissions for GitHub workflows. 252 andrewtanJS
* Refactor `manual_control.py`. MathisFederico
* Fix issue with making all environments pickable 269. MathisFederico
* Include `max_steps` argument in all of the environments. Fix https://github.com/Farama-Foundation/Minigrid/issues/264. rodrigodelazcano
* Include agent's position in the `SymbolicObsWrapper` observation. Fix 278. rodrigodelazcano
Type Hinting
* Add type hint to core API. arjun-kg
* Improve type hint in `MinigridEnv` micimize
* Add `py.typed` marker to use minigrid's type annotations in external tooling such as mypy

New Publications
* [Composition Generalization in Grounded Language Learning via Induced Model Sparsity](https://aclanthology.org/2022.naacl-srw.19/). smspillaz

This release transitions the repository dependency from `gym` to `gymnasium`. `gymnasium` is a fork of OpenAI's Gym library by the maintainers, and is where future maintenance will occur going forward. [gymnasium.farama.org](https://gymnasium.farama.org/)
What's Changed
- Migration from `gym` to `gymnasium` v0.26. rodrigodelazcano
- Package name change from `gym_minigrid` to `minigrid`. rodrigodelazcano
- Change file structure for better comprehension. pseudo-rnd-thoughts . The new file structure looks as follows:
* Divide `minigrid.py` into sub-files for easier comprehension and keep them under `core` directory:
- `actions.py`: class structure with the actions encodings
- `constants.py`: constants in the environments such as object colors
- `grid.py`: the grid class
- `mission.py`: the mission space implementation
- `roomgrid.py`: class for environments with rooms
- `world_object`: object classes (Wall, Ball, Goal, Floor, ...)
* New `utils` directory for rendering files `rendering.py` and `window.py`
- Add automatic doc generation for website, available at [https://farama-foundation.github.io/MiniGrid/](https://farama-foundation.github.io/MiniGrid/). SiddarGu

Minor Changes
- Change file name `minigrid.py` to `minigrid_env.py`. Fixes issue 243 rodrigodelazcano

Deprecated package naming (`gym_minigrid` -> `minigrid`)
The PyPi package name for this repository will be changed in future releases and integration with [Gymnasium](https://github.com/Farama-Foundation/Gymnasium). The new name will be `minigrid` and installation will be done with `pip install minigrid` instead of `pip install gym_minigrid`.

This release adds a deprecation warning when importing or installing `gym_minigrid`.

Bug Fix
- Fix [232](https://github.com/Farama-Foundation/MiniGrid/issues/232). Removed `new_step_api=True` argument in `manual_control.py`. Latest 1.2.0 MiniGrid release is not backward compatible with gym releases previous to v0.26. Thus every minigrid environment has a hard constraint on using new step API and the option to set the argument `new_step_api=True` in the environments was removed. rodrigodelazcano

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](https://younis.dev/blog/render-api/) 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"](https://proceedings.mlr.press/v162/paischer22a.html) to README. pseudo-rnd-thoughts
* Fix import issue 215 rodrigodelazcano