Update and rename dict_space.py to dict.py

gym/spaces/dict.py

@@ -0,0 +1,84 @@
+from collections import OrderedDict
+from .space import Space
+
+
+class Dict(Space):
+    """
+    A dictionary of simpler spaces.
+
+    Example usage:
+    self.observation_space = spaces.Dict({"position": spaces.Discrete(2), "velocity": spaces.Discrete(3)})
+
+    Example usage [nested]:
+    self.nested_observation_space = spaces.Dict({
+        'sensors':  spaces.Dict({
+            'position': spaces.Box(low=-100, high=100, shape=(3,)),
+            'velocity': spaces.Box(low=-1, high=1, shape=(3,)),
+            'front_cam': spaces.Tuple((
+                spaces.Box(low=0, high=1, shape=(10, 10, 3)),
+                spaces.Box(low=0, high=1, shape=(10, 10, 3))
+            )),
+            'rear_cam': spaces.Box(low=0, high=1, shape=(10, 10, 3)),
+        }),
+        'ext_controller': spaces.MultiDiscrete((5, 2, 2)),
+        'inner_state':spaces.Dict({
+            'charge': spaces.Discrete(100),
+            'system_checks': spaces.MultiBinary(10),
+            'job_status': spaces.Dict({
+                'task': spaces.Discrete(5),
+                'progress': spaces.Box(low=0, high=100, shape=()),
+            })
+        })
+    })
+    """
+    def __init__(self, spaces=None, **spaces_kwargs):
+        assert (spaces is None) or (not spaces_kwargs), 'Use either Dict(spaces=dict(...)) or Dict(foo=x, bar=z)'
+        if spaces is None:
+            spaces = spaces_kwargs
+        for space in spaces.values():
+            assert isinstance(space, gym.Space), 'Values of the dict should be instances of gym.Space'
+        if isinstance(spaces, dict) and not isinstance(spaces, OrderedDict):
+            spaces = OrderedDict(sorted(list(spaces.items())))
+        if isinstance(spaces, list):
+            spaces = OrderedDict(spaces)
+        self.spaces = spaces
+        super(Dict, self).__init__(None, None) # None for shape and dtype, since it'll require special handling
+
+    def seed(self, seed):
+        [space.seed(seed) for space in self.spaces.values()]
+
+    def sample(self):
+        return OrderedDict([(k, space.sample()) for k, space in self.spaces.items()])
+
+    def contains(self, x):
+        if not isinstance(x, dict) or len(x) != len(self.spaces):
+            return False
+        for k, space in self.spaces.items():
+            if k not in x:
+                return False
+            if not space.contains(x[k]):
+                return False
+        return True
+
+    def __repr__(self):
+        return "Dict(" + ", ". join([k + ":" + str(s) for k, s in self.spaces.items()]) + ")"
+
+    def to_jsonable(self, sample_n):
+        # serialize as dict-repr of vectors
+        return {key: space.to_jsonable([sample[key] for sample in sample_n]) \
+                for key, space in self.spaces.items()}
+
+    def from_jsonable(self, sample_n):
+        dict_of_list = {}
+        for key, space in self.spaces.items():
+            dict_of_list[key] = space.from_jsonable(sample_n[key])
+        ret = []
+        for i, _ in enumerate(dict_of_list[key]):
+            entry = {}
+            for key, value in dict_of_list.items():
+                entry[key] = value[i]
+            ret.append(entry)
+        return ret
+
+    def __eq__(self, other):
+        return isinstance(other, Dict) and self.spaces == other.spaces