Gym Notices

0.1.0 · active · verified Fri Apr 10

gym-notices is a Python library that provides important advisories and warnings for the original Gym (OpenAI Gym) reinforcement learning toolkit. These notices may be displayed automatically upon importing Gym on internet-connected systems, informing users about major reproducibility issues, outdated versions, or the library's maintenance status. It is currently at version 0.1.0 and releases are infrequent, primarily focused on issuing critical warnings.

Warnings

breaking The original OpenAI Gym library, which `gym-notices` monitors, is no longer actively maintained. All future development has moved to `Gymnasium`. `gym-notices` will often warn users about this and recommend migrating to `Gymnasium` (import `gymnasium as gym`).
Fix: Migrate your code from `gym` to `gymnasium` by installing `gymnasium` and changing `import gym` to `import gymnasium as gym`.
gotcha `gym-notices` operates passively and delivers warnings upon import. Users might incorrectly expect explicit API calls or functions to retrieve notices, but its design is to automatically inform users of critical issues in the background.
Fix: Understand that the library's primary function is passive notification. Ensure `gym_notices` is installed and imported alongside `gym` (or if `gym` depends on it) to receive advisories.
gotcha Warnings from `gym-notices` are fetched from an online source. Users in environments without internet connectivity will not receive the latest advisories about `gym`'s status or specific version issues.
Fix: Ensure internet connectivity when running code that imports `gym` or `gym_notices` to receive timely warnings. Regularly check the `Farama-Foundation/gym-notices` GitHub repository for the latest information if working offline.
deprecated Specific versions of `gym`, notably 0.24.0 and 0.24.1, were identified as having significant bugs. `gym-notices` was updated to specifically flag and warn against the use of these problematic `gym` versions.
Fix: Avoid using `gym` versions 0.24.0 and 0.24.1. Upgrade to a more stable version of `gym` or, preferably, migrate to `gymnasium` for continued support and bug fixes.

Install

pip install gym-notices Install stable version

Imports

gym_notices
```
import gym_notices
```
The library primarily functions by displaying notices automatically on import of either `gym_notices` or `gym` (if `gym_notices` is a dependency of `gym`), rather than exposing explicit classes or functions to call.

Quickstart

Simply importing `gym_notices` or `gym` (if `gym_notices` is a dependency of `gym`) triggers the notice system. Warnings are displayed automatically if relevant conditions (like using an unsupported Gym version or Gym's deprecation) are detected and an internet connection is available to fetch the latest advisories.

import gym_notices

# When specific conditions (e.g., outdated Gym version, internet connectivity)
# are met, warnings from gym-notices will be printed to stdout upon import.

view raw JSON →