mila-iqia / babyai

BabyAI platform. A testbed for training agents to understand and execute language commands.
BSD 3-Clause "New" or "Revised" License
700 stars 146 forks source link

Added a deprecation notice #120

Closed BolunDai0216 closed 1 year ago

BolunDai0216 commented 1 year ago

Added a deprecation notice:

This code base is no longer maintained, and is not expected to be maintained again in the future. These environments been maintained inside of Minigrid (see https://github.com/Farama-Foundation/Minigrid/tree/master/minigrid/envs/babyai). This maintained version includes documentation, support for current versions of Python, numerous bug fixes, support for installation via pip, and numerous other large quality of life improvements. We encourage researchers to switch to this maintained version for all purposes other than comparing to results run on this version of the environments.

when importing the library.

jkterry1 commented 1 year ago

For a bit of context on this (I'm the CEO of Farama, the maintainers of Minigrid), we've had significant past issues with people not reading the readme files for libraries that point to us, so we've started adding warning messages instead

dyth commented 1 year ago

:wave: Seems reasonable, but I would not be comfortable approving this without hearing @maximecb's opinion first.

maximecb commented 1 year ago

Seems reasonable 👍

BolunDai0216 commented 1 year ago

Please fix the grammatical issue.

It is now:

This code base is no longer maintained and is not expected to be maintained again. These environments are now maintained within Minigrid (see https://github.com/Farama-Foundation/Minigrid/tree/master/minigrid/envs/babyai). The maintained version includes documentation, support for current versions of Python, numerous bug fixes, support for installation via pip, and many other quality-of-life improvements. We encourage researchers to switch to the maintained version for all purposes other than comparing with results that use this version of the environments.

Does the current version look good to you?

jkterry1 commented 1 year ago

Hey guys, is this able to be merged now?