Skip to content

Latest commit

 

History

History
330 lines (220 loc) · 13.1 KB

CHANGELOG.md

File metadata and controls

330 lines (220 loc) · 13.1 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.8.1 - 2023-02-17

Added

  • Added type stubs for the native ALE Python module generated via pybind11. You'll now get type hints in your IDE.

Fixed

  • Fixed render_mode attribute on legacy Gym environment (@younik)
  • Fixed a bug which could parse invalid ROM names containing numbers, e.g., TicTacToe3D or Pitfall2
  • Changed the ROM identifier of VideoChess & VideoCube to match VideoCheckers & VideoPinball. Specifically, the environment ID changed from Videochess -> VideoChess and Videocube -> VideoCube. Most ROMs had the ID correctly as video_chess.bin and video_cube.bin but for those who didn't you can simply run ale-import-roms which will automatically correct this for you.
  • Reverted back to manylinux2014 (glibc 2.17) to better support older operating systems.

0.8.0 - 2022-09-05

Added

  • Added compliance with the Gym v26 API. This includes multiple breaking changes to the Gym API. See the Gym Release for additional information.
  • Reworked the ROM plugin API resulting in reduced startup time when importing ale_py.roms.
  • Added a truncation API to the ALE interface to query whether an episode was truncated or terminated (ale.game_over(with_truncation=true/false) and ale.game_truncated())
  • Added proper Gym truncation on max episode frames. This no longer relies on the TimeLimit wrapper with the new truncation API in Gym v26.
  • Added a setting for truncating on loss-of-life.
  • Added a setting for clamping rewards.
  • Added const keywords to attributes in ale::ALEInterface (#457) (@AlessioZanga).
  • Added explicit exports via __all__ in ale-py so linting tools can better detect exports.
  • Added builds for Python 3.11.

Fixed

  • Moved the Gym environment entrypoint from gym.envs.atari:AtariEnv to ale_py.env.gym:AtariEnv. This resolves many issues with the namespace package but does break backwards compatability for some Gym code that relied on the entry point being prefixed with gym.envs.atari.

0.7.5 - 2022-04-18

Added

  • Added validation for Gym's frameskip values.
  • Made ROM loading more robust with module-level __getattr__ and __dir__.
  • Added py.typed to the Python module's root directory to support type checkers.
  • Bumped SDL to v2.0.16.

Fixed

  • Fixed Gym render mode metadata. (@vwxyzjn)
  • Fixed Gym warnings about seeding.hash_seed and random.randint.
  • Fixed build infrastructure issues from the migration to setuptools>=0.61.

Removed

  • Removed Gym's .render(mode='human'). Gym now uses the render_mode keyword argument in the environment constructor.

0.7.4 - 2022-02-16

Added

  • Proper C++ namespacing for the ALE and Stella (@tuero)
  • vcpkg manifest. You can now install dependencies via cmake.
  • Support for the new Gym (0.22) reset API, i.e., the seed and return_info keyword arguments.
  • Moved cibuildwheel config from Github Actions to pyproject.toml.

Fixed

  • Fixed a bug with the terminal signal in ChopperCommand #434
  • Fixed warnings with importlib-metadata on Python < 3.9.
  • Reverted the Gym v5 defaults to align with the post-DQN literature. That is, moving from a frameskip of 5 -> 4, and full action set -> minimal action set.

0.7.3 — 2021-11-02

Added

  • Environment variable ALE_PY_ROM_DIR which if specified will search for ROMs in ${ALE_PY_ROM_DIR}/*.bin. (@joshgreaves)

0.7.2 — 2021-10-07

Added

  • Package Tetris by Colin Hughes. This ROM is made publicly available by the author. This is useful for other open-source packages to be able to unit test agaisnt the ALE. (@tfboyd)
  • Python 3.10 prebuilt wheels

Fixed

  • Fixed an issue with isSupportedROM on Windows which was causing incorrect ROM hashes.

Removed

  • Python 3.6 prebuilt wheels

0.7.1 — 2021-09-28

Added

  • Added ale-import-roms --import-from-pkg {pkg}
  • Use gym.envs.atari as a namespace package to maintain backwards compatability with the AtariEnv entry point.
  • The ALE now uses Gym's environment plugin system in gym>=0.21 (openai/gym#2383, openai/gym#2409, openai/gym#2411). Users no longer are required to import ale_py to use a -v5 environment.

Changed

  • Silence unsupported ROMs warning behind ImportError. To view these errors you should now supply the environment variable PYTHONWARNINGS=default::ImportWarning:ale_py.roms.
  • Reworked ROM error messages to provide more helpful suggestions.
  • General metadata changes to the Python package.

Fixed

  • Add missing std:: name qualifier when enabling SDL (@anadrome)
  • Fixed mandatory kwarg for gym.envs.atari:AtariEnv.clone_state.

0.7.0 — 2021-09-14

Added

  • Native support for OpenAI Gym
  • Native Python interface using pybind11 which results in a speedup for Python workloads as well as proper support for objects like ALEState
  • Python ROM management, e.g., ale-import-roms
  • PyPi Python wheels published as ale-py + we distribute SDL2 for out of the box visualization + audio support
  • isSupportedROM(path) to check if a ROM file is supported by the ALE
  • Added new games: Atlantis2, Backgammon, BasicMath, Blackjack, Casino, Crossbow, DarkChambers, Earthworld, Entombed, ET, FlagCapture, Hangman, HauntedHouse, HumanCannonball, Klax, MarioBros, MiniatureGolf, Othello, Pacman, Pitfall2, SpaceWar, Superman, Surround, TicTacToe3D, VideoCheckers, VideoChess, VideoCube, WordZapper (thanks @tkoppe)
  • Added (additional) mode/difficulty settings for: Lost Luggage, Turmoil, Tron Dead Discs, Pong, Mr. Do, King Kong, Frogger, Adventure (thanks @tkoppe)
  • Added cloneState(include_rng) which will eventually replace cloneSystemState (behind the scenes cloneSystemState is equivalent to cloneState(include_rng=True)).
  • Added setRAM which can be useful for modifying the environment, e.g., learning a causal model over RAM transitions, altering game dynamics, etc.

Changed

  • Rewrote SDL support using SDL2 primitives
  • SDL2 now renders every frame independent of frameskip
  • SDL2 renders at the proper ROM framerate (added benefit of audio sync support)
  • Rewrote entire CMake infrastructure which now supports vcpkg natively
  • C++ minimum version is now C++17
  • Changed all relative imports to absolute imports
  • Switched from Travis CI to Github Actions
  • Allow for paddle controller's min/max setting to be configurable
  • More robust version handling between C++ & Python distributions
  • Updated Markdown documentation to replace TeX manual

Fixed

  • Fixed bankswitching type for UA cartridges
  • Fixed a SwapPort bug in Surround
  • Fixed multiple bugs in handling invalid ROM files (thanks @tkoeppe)
  • Fixed initialization of TIA static data to make it thread safe (thanks @tkoeppe)
  • Fixed RNG initialization, this was one of the last barriers to making the ALE fully deterministic, we are now fully deterministic

Removed

  • Removed FIFO interface
  • Removed RL-GLUE support
  • Removed ALE CLI interface
  • Removed Java interface
  • Removed ALEInterface::load(), ALEInterface::save(). If you require this stack functionality it's easy to implement on your own using ALEInterface::cloneState(include_rng)
  • Removed os-dependent filesystem code in favour of C++17 std::fs
  • Removed human control mode
  • Removed old makefile build system in favour of CMake
  • Removed bspf
  • Removed unused controller types: Driving, Booster, Keyboard
  • Removed AtariVox
  • Removed Stella types (e.g., Array) in favour of STL types
  • Remove Stella debugger
  • Remove Stella CheatManager
  • Lots of code cleanups conforming to best practices (thanks @tkoeppe)

0.6.1 — 2019-11-20

Changed

  • Speedup of up to 30% by optimizing variable types (@qstanczyk)

Fixed

  • Fixed switch fall-through with Gravitar lives detection (@lespeholt)

0.6.0 — 2015-06-23

Added

  • Support for modes and difficulties in Atari games (@mcmachado)
  • Frame maxpooling as a post-processing option (@skylian)
  • Added support for: Turmoil, Koolaid, Tron Deadly Discs, Mr. Do, Donkey Kong, Keystone Kapers, Frogger, Sir Lancelot, Laser Gates, Lost Luggage,
  • Added MD5 list of supported ROMs

Changed

  • Disabled color averaging by default
  • Replaced TinyMT with C++11 random

Fixed

  • Fixed old color averaging scheme (PR #181)
  • Fixed minimal action set in Pong
  • Fixed termination issues in Q*Bert

0.5.2 — 2015-10-04

Added

  • Routines for ALEState serialization (@Jragonmiris).

Changed

  • Enforce flags existence (@mcmachado).

Fixed

  • Fix RNG issues introduced in 0.5.0.
  • Additional bug fixes.

0.5.1 — 2015-07-07

Added

  • Added RNG serialization capability.

Changed

  • Refactored Python getScreenRGB to return unpacked RGB values (@spragunr).
  • Sets the default value of the color_averaging flag to be true. It was true by default in previous versions but was changed in 0.5.0. Reverted for backward compatibility.

Fixed

  • Bug fixes from ALE 0.5.0.

0.5.0 — 2015-06-22

Added

  • Added action_repeat_stochasticity.
  • Added sound playback, visualization.
  • Added screen/sound recording ability.
  • CMake now available.
  • Incorporated Benjamin Goodrich's Python interface.
  • Added examples for shared library, Python, fifo, RL-Glue interfaces.
  • Incorporated Java agent into main repository.

Changed

  • Better ALEInterface.
  • Many other changes.

Fixed

  • Some game fixes.

Removed

  • Removed internal controller, now superseded by shared library interface.
  • Removed the following command-line flags: 'output_file', 'system_reset_steps', 'use_environment_distribution', 'backward_compatible_save', internal agent flags
  • The flag 'use_starting_actions' was removed and internally its value is always 'true'.
  • The flag 'disable_color_averaging' was renamed to 'color_averaging' and FALSE is its default value.

0.4.4 — 2014-04-28

Fixed

  • Fixed a memory issue in ALEScreen.

0.4.3 — 2014-04-26

Fixed

  • Fixed issues with frame numbers not being correctly updated.
  • Fixed a bug where total reward was not properly reported under frame skipping.
  • Fixed a bug with ALEState's m_frame_number.

0.4.2 — 2013-06-12

Changed

  • Modified StellaEnvironment save/load interface to provide additional flexibility.

Fixed

  • Series of bug fixes from Matthew Hausknecht and community.

0.4.1 — 2013-05-24

Added

  • Added frame skipping support directly in StellaEnvironment.

Changed

  • Reverted default number of episodes to 10.

Fixed

  • Fixed RL-Glue syntax from OBSERVATION to OBSERVATIONS. Thanks to Angus MacIsaac for picking this bug up.

0.4.0 — 2013-04-22

Added

  • RL-Glue support
  • Shared library interface
  • Simpler direct environment interfacing
  • Improved environment handling
  • Improved environment customization
  • Better documentation

0.3.0 — 2012-07-22

  • Initial ALE release.