def __init__(self, gridobj, actionClass=BaseAction, _init_grid=True):
"""
INTERNAL USE ONLY
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
The :class:`grid2op.Environment.Environment` is responsible for the creation of the
action space. Do not attempt to make one yourself.
Parameters
----------
gridobj: :class:`grid2op.Space.GridObjects`
Representation of the underlying powergrid.
actionClass: ``type``
Type of action used to build :attr:`Space.SerializableSpace._template_obj`. It should derived from
:class:`BaseAction`.
"""
SerializableSpace.__init__(self,
gridobj=gridobj,
subtype=actionClass,
_init_grid=_init_grid)
self.actionClass = self.subtype
self._template_act = self.actionClass()
def __init__(self, gridobj, observationClass=CompleteObservation):
"""
Parameters
----------
gridobj: :class:`grid2op.Space.GridObjects`
Representation of the objects in the powergrid.
observationClass: ``type``
Type of action used to build :attr:`Space.SerializableSpace._template_obj`
"""
SerializableSpace.__init__(self, gridobj=gridobj, subtype=observationClass)
self.observationClass = self.subtype
self._empty_obs = self._template_obj
def __init__(self, gridobj, actionClass=BaseAction):
"""
Parameters
----------
gridobj: :class:`grid2op.Space.GridObjects`
Representation of the underlying powergrid.
actionClass: ``type``
Type of action used to build :attr:`Space.SerializableSpace._template_obj`. It should derived from
:class:`BaseAction`.
"""
SerializableSpace.__init__(self, gridobj=gridobj, subtype=actionClass)
self.actionClass = self.subtype
self._template_act = self._template_obj
def from_dict(dict_):
"""
Allows the de-serialization of an object stored as a dictionary (for example in the case of JSON saving).
Parameters
----------
dict_: ``dict``
Representation of an BaseAction Space (aka SerializableActionSpace) as a dictionary.
Returns
-------
res: :class:``SerializableActionSpace``
An instance of an action space matching the dictionary.
"""
tmp = SerializableSpace.from_dict(dict_)
res = SerializableActionSpace(gridobj=tmp, actionClass=tmp.subtype)
return res
def from_dict(dict_):
"""
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
This is used internally by EpisodeData to restore the state of the powergrid
Allows the de-serialization of an object stored as a dictionary (for example in the case of json saving).
Parameters
----------
dict_: ``dict``
Representation of an BaseObservation Space (aka SerializableObservationSpace) as a dictionary.
Returns
-------
res: :class:``SerializableObservationSpace``
An instance of an action space matching the dictionary.
"""
tmp = SerializableSpace.from_dict(dict_)
res = SerializableObservationSpace(gridobj=tmp,
observationClass=tmp.subtype)
return res
def from_dict(dict_):
"""
INTERNAL USE ONLY
.. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
Allows the de-serialization of an object stored as a dictionary (for example in the case of JSON saving).
Parameters
----------
dict_: ``dict``
Representation of an BaseAction Space (aka SerializableActionSpace) as a dictionary.
Returns
-------
res: :class:``SerializableActionSpace``
An instance of an action space matching the dictionary.
"""
tmp = SerializableSpace.from_dict(dict_)
res = SerializableActionSpace(gridobj=tmp, actionClass=tmp.subtype)
return res