mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-29 17:45:07 +00:00
3a8daafce1
* removed return_info, made info dict mandatory in reset * tenatively removed deprecated seed api for environments * added more info type checks to wrapper tests * formatting/style compliance * addressed some comments * polish to address review * fixed tests after merge, and added a test of the return_info deprecation assertion if found in reset signature * some organization of env_checker tests, reverted a probably merge error * added deprecation check for seed function in env * updated docstring * removed debug prints, tweaked test_check_seed_deprecation * changed return_info deprecation check from assertion to warning * fixes to vector envs, now should be correctly structured * added some explanation and typehints for mockup depcreated return info reset function * re-removed seed function from vector envs * added explanation to _reset_return_info_type and changed the return statement
99 lines
3.2 KiB
Python
99 lines
3.2 KiB
Python
"""Tests for the flatten observation wrapper."""
|
|
|
|
from collections import OrderedDict
|
|
from typing import Optional
|
|
|
|
import numpy as np
|
|
import pytest
|
|
|
|
import gym
|
|
from gym.spaces import Box, Dict, flatten, unflatten
|
|
from gym.wrappers import FlattenObservation
|
|
|
|
|
|
class FakeEnvironment(gym.Env):
|
|
def __init__(self, observation_space):
|
|
self.observation_space = observation_space
|
|
|
|
def reset(self, *, seed: Optional[int] = None, options: Optional[dict] = None):
|
|
super().reset(seed=seed)
|
|
self.observation = self.observation_space.sample()
|
|
return self.observation, {}
|
|
|
|
|
|
OBSERVATION_SPACES = (
|
|
(
|
|
Dict(
|
|
OrderedDict(
|
|
[
|
|
("key1", Box(shape=(2, 3), low=0, high=0, dtype=np.float32)),
|
|
("key2", Box(shape=(), low=1, high=1, dtype=np.float32)),
|
|
("key3", Box(shape=(2,), low=2, high=2, dtype=np.float32)),
|
|
]
|
|
)
|
|
),
|
|
True,
|
|
),
|
|
(
|
|
Dict(
|
|
OrderedDict(
|
|
[
|
|
("key2", Box(shape=(), low=0, high=0, dtype=np.float32)),
|
|
("key3", Box(shape=(2,), low=1, high=1, dtype=np.float32)),
|
|
("key1", Box(shape=(2, 3), low=2, high=2, dtype=np.float32)),
|
|
]
|
|
)
|
|
),
|
|
True,
|
|
),
|
|
(
|
|
Dict(
|
|
{
|
|
"key1": Box(shape=(2, 3), low=-1, high=1, dtype=np.float32),
|
|
"key2": Box(shape=(), low=-1, high=1, dtype=np.float32),
|
|
"key3": Box(shape=(2,), low=-1, high=1, dtype=np.float32),
|
|
}
|
|
),
|
|
False,
|
|
),
|
|
)
|
|
|
|
|
|
class TestFlattenEnvironment:
|
|
@pytest.mark.parametrize("observation_space, ordered_values", OBSERVATION_SPACES)
|
|
def test_flattened_environment(self, observation_space, ordered_values):
|
|
"""
|
|
make sure that flattened observations occur in the order expected
|
|
"""
|
|
env = FakeEnvironment(observation_space=observation_space)
|
|
wrapped_env = FlattenObservation(env)
|
|
flattened, info = wrapped_env.reset()
|
|
|
|
unflattened = unflatten(env.observation_space, flattened)
|
|
original = env.observation
|
|
|
|
self._check_observations(original, flattened, unflattened, ordered_values)
|
|
|
|
@pytest.mark.parametrize("observation_space, ordered_values", OBSERVATION_SPACES)
|
|
def test_flatten_unflatten(self, observation_space, ordered_values):
|
|
"""
|
|
test flatten and unflatten functions directly
|
|
"""
|
|
original = observation_space.sample()
|
|
|
|
flattened = flatten(observation_space, original)
|
|
unflattened = unflatten(observation_space, flattened)
|
|
|
|
self._check_observations(original, flattened, unflattened, ordered_values)
|
|
|
|
def _check_observations(self, original, flattened, unflattened, ordered_values):
|
|
# make sure that unflatten(flatten(original)) == original
|
|
assert set(unflattened.keys()) == set(original.keys())
|
|
for k, v in original.items():
|
|
np.testing.assert_allclose(unflattened[k], v)
|
|
|
|
if ordered_values:
|
|
# make sure that the values were flattened in the order they appeared in the
|
|
# OrderedDict
|
|
np.testing.assert_allclose(sorted(flattened), flattened)
|