gymnasium 1.0 support

.github/workflows/pre-commit.yml

@@ -16,6 +16,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
       - run: pip install pre-commit
       - run: pre-commit --version
       - run: pre-commit install

README.md

@@ -63,8 +63,11 @@ The following code performs a deterministic action on the
 ```python
 import time
 import gymnasium
+import miniwob
 from miniwob.action import ActionTypes
 
+gymnasium.register_envs(miniwob)
+
 env = gymnasium.make('miniwob/click-test-2-v1', render_mode='human')
 
 # Wrap the code in try-finally to ensure proper cleanup.

docs/_scripts/gen_env_list.py

@@ -4,9 +4,11 @@
 import gymnasium as gym
 import pandas as pd
 
+import miniwob
 from utils import extract_description_from_docstring, get_all_registered_miniwob_envs
 
 
+gym.register_envs(miniwob)
 gym.logger.set_level(gym.logger.DISABLED)
 
 ENV_TYPES = [

docs/_scripts/gen_mds.py

@@ -4,11 +4,13 @@
 
 import gymnasium as gym
 
+import miniwob
 from utils import get_all_registered_miniwob_envs, trim_docstring
 
 
 LAYOUT = "env"
 
+gym.register_envs(miniwob)
 gym.logger.set_level(gym.logger.DISABLED)
 
 

docs/content/basic_usage.md

@@ -8,8 +8,11 @@ The following code performs a deterministic action on the
 ```python
 import time
 import gymnasium
+import miniwob
 from miniwob.action import ActionTypes
 
+gymnasium.register_envs(miniwob)
+
 env = gymnasium.make('miniwob/click-test-2-v1', render_mode='human')
 
 # Wrap the code in try-finally to ensure proper cleanup.

docs/content/custom_environment.md

@@ -125,6 +125,7 @@ from miniwob.fields import field_lookup
 
 # Import `custom_registry.py` above to register the task.
 import custom_registry
+gymnasium.register_envs(custom_registry)
 
 # Create an environment.
 env = gymnasium.make('miniwob/custom-v0', render_mode='human')

docs/index.md

@@ -29,6 +29,8 @@ Exploration](https://arxiv.org/abs/1802.08802).
 The Gymnasium interface allows an agent to initialize and interact with a MiniWoB++ environment as follows:
 ```python
 import gymnasium
+import miniwob
+gymnasium.register_envs(miniwob)
 env = gymnasium.make('miniwob/click-test-2-v1', render_mode='human')
 try:
   observation, info = env.reset(seed=42)

miniwob/__init__.py

@@ -1,8 +1,12 @@
 """Root `__init__` of the miniwob module."""
 import sys
 
+from miniwob.registration import register_miniwob_envs
 
-__version__ = "1.0"
+
+__version__ = "1.0.1"
+
+register_miniwob_envs()
 
 try:
     from farama_notifications import notifications

pyproject.toml

@@ -24,11 +24,11 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
 ]
 dependencies = [
-    "Gymnasium==0.29.0",
+    "Gymnasium>=1.0.0a1",
     "Pillow>=9.0.0",
     "selenium>=4.5.0",
     "numpy>=1.18.0",
-    "farama-notifications >=0.0.1",
+    "farama-notifications>=0.0.1",
 ]
 dynamic = ["version"]
 

tests/test_api.py

@@ -3,7 +3,7 @@
 import pytest
 from gymnasium import spaces
 from gymnasium.utils.env_checker import check_env
-from gymnasium.wrappers.flatten_observation import FlattenObservation
+from gymnasium.wrappers import FlattenObservation
 
 from tests.utils import get_all_registered_miniwob_envs