-
Notifications
You must be signed in to change notification settings - Fork 116
/
BaseMultiProcessEnv.py
501 lines (415 loc) · 20.4 KB
/
BaseMultiProcessEnv.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# Copyright (c) 2019-2020, RTE (https://www.rte-france.com)
# See AUTHORS.txt
# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
# you can obtain one at http://mozilla.org/MPL/2.0/.
# SPDX-License-Identifier: MPL-2.0
# This file is part of Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems.
from multiprocessing import Process, Pipe
import numpy as np
from grid2op.dtypes import dt_int
from grid2op.Exceptions import Grid2OpException, MultiEnvException
from grid2op.Space import GridObjects
from grid2op.Environment import Environment
from grid2op.Action import BaseAction
class RemoteEnv(Process):
"""
This class represent the environment that is executed on a remote process.
Note that the environment is only created in the subprocess, and is not available in the main process. Once created
it is not possible to access anything directly from it in the main process, where the BaseAgent lives. Only the
:class:`grid2op.Observation.BaseObservation` are forwarded to the agent.
"""
def __init__(self, env_params, remote, parent_remote, seed, name=None):
Process.__init__(self, group=None, target=None, name=name)
self.backend = None
self.env = None
self.env_params = env_params
self.remote = remote
self.parent_remote = parent_remote
self.seed_used = seed
self.space_prng = None
self.fast_forward = 0
self.all_seeds = []
def init_env(self):
"""
Initialize the environment that will perform all the computation of this process.
Remember the environment only lives in this process. It cannot
be transfer to / from the main process.
This function also makes sure the chronics are read in different order accross all processes. This is done
by calling the :func:`grid2op.Chronics.GridValue.shuffle` method. An example of how to use this function
is provided in :func:`grid2op.Chronics.Multifolder.shuffle`.
"""
# TODO documentation
self.space_prng = np.random.RandomState()
self.space_prng.seed(seed=self.seed_used)
self.backend = self.env_params["_raw_backend_class"]()
self.env = Environment(**self.env_params, backend=self.backend)
env_seed = self.space_prng.randint(np.iinfo(dt_int).max)
self.all_seeds = self.env.seed(env_seed)
self.env.chronics_handler.shuffle(shuffler=lambda x: x[self.space_prng.choice(len(x), size=len(x), replace=False)])
def _clean_observation(self, obs):
obs._forecasted_grid = []
obs._forecasted_inj = []
obs._obs_env = None
obs.action_helper = None
def get_obs_ifnotconv(self):
# TODO dirty hack because of wrong chronics
# need to check!!!
conv = False
obs_v = None
while not conv:
try:
obs = self.env.reset()
if self.fast_forward > 0:
self.env.fast_forward_chronics(self.space_prng.randint(0, self.fast_forward))
obs = self.env.get_obs()
obs_v = obs.to_vect()
if np.all(np.isfinite(obs_v)):
# i make sure that everything is not Nan
# other i consider it's "divergence" so "game over"
conv = True
except:
pass
return obs_v
def run(self):
if self.env is None:
self.init_env()
while True:
cmd, data = self.remote.recv()
if cmd == 'get_spaces':
self.remote.send((self.env.observation_space, self.env.action_space))
elif cmd == 's':
# perform a step
data = self.env.action_space.from_vect(data)
obs, reward, done, info = self.env.step(data)
obs_v = obs.to_vect()
if done or np.any(~np.isfinite(obs_v)):
# if done do a reset
obs_v = self.get_obs_ifnotconv()
self.remote.send((obs_v, reward, done, info))
elif cmd == 'r':
# perfom a reset
obs_v = self.get_obs_ifnotconv()
# self._clean_observation(obs)
self.remote.send(obs_v)
elif cmd == 'c':
# close everything
self.env.close()
self.remote.close()
break
elif cmd == 'z':
# adapt the chunk size
self.env.set_chunk_size(data)
elif cmd == 'o':
# get_obs
tmp = self.env.get_obs()
tmp = tmp.to_vect()
self.remote.send(tmp)
elif cmd == "f":
# fast forward the chronics when restart
self.fast_forward = int(data)
elif cmd == "seed":
self.remote.send((self.seed_used, self.all_seeds))
elif cmd == "params":
self.remote.send(self.env.parameters)
elif hasattr(self.env, cmd):
tmp = getattr(self.env, cmd)
self.remote.send(tmp)
else:
raise NotImplementedError
class BaseMultiProcessEnvironment(GridObjects):
"""
This class allows to evaluate a single agent instance on multiple environments running in parrallel.
It uses the python "multiprocessing" framework to work, and thus is suitable only on a single machine with multiple
cores (cpu / thread). We do not recommend to use this method on a cluster of different machines.
This class uses the following representation:
- an :class:`grid2op.BaseAgent.BaseAgent`: lives in a main process
- different environments lives into different processes
- a call to :func:`MultiEnv.step` will perform one step per environment, in parallel using a ``Pipe`` to transfer data
to and from the main process from each individual environment process. It is a synchronous function. It means
it will wait for every environment to finish the step before returning all the information.
There are some limitations. For example, even if forecast are available, it's not possible to use forecast of the
observations. This imply that :func:`grid2op.Observation.BaseObservation.simulate` is not available when using
:class:`MultiEnvironment`
Compare to regular Environments, :class:`MultiEnvironment` simply stack everything. You need to send not a single
:class:`grid2op.Action.BaseAction` but as many actions as there are underlying environments. You receive not one single
:class:`grid2op.Observation.BaseObservation` but as many observations as the number of underlying environments.
A broader support of regular grid2op environment capabilities as well as support for
:func:`grid2op.Observation.BaseObservation.simulate` call might be added in the future.
**NB** As opposed to :func:`Environment.step` a call to :func:`BaseMultiProcessEnvironment.step` or any of
its derived class (:class:`SingleEnvMultiProcess` or :class:`MultiEnvMultiProcess`) if a sub environment
is "done" then it is automatically reset. This means entails that you can call
:func:`BaseMultiProcessEnvironment.step` without worrying about having to reset.
Attributes
-----------
envs: `list::grid2op.Environment.Environment`
Al list of environments for which the evaluation will be made in parallel.
nb_env: ``int``
Number of parallel underlying environment that will be handled. It is also the size of the list of actions
that need to be provided in :func:`MultiEnvironment.step` and the return sizes of the list of this
same function.
"""
def __init__(self, envs):
GridObjects.__init__(self)
self.envs = envs
for env in envs:
if not isinstance(env, Environment):
raise MultiEnvException("You provided environment of type \"{}\" which is not supported."
"Please only provide a grid2op.Environment.Environment class."
"".format(type(env)))
self.nb_env = len(envs)
max_int = np.iinfo(dt_int).max
self._remotes, self._work_remotes = zip(*[Pipe() for _ in range(self.nb_env)])
env_params = [envs[e].get_kwargs(with_backend=False) for e in range(self.nb_env)]
self._ps = [RemoteEnv(env_params=env_,
remote=work_remote,
parent_remote=remote,
name="{}_subprocess_{}".format(envs[i].name, i),
seed=envs[i].space_prng.randint(max_int))
for i, (work_remote, remote, env_) in enumerate(zip(self._work_remotes, self._remotes, env_params))]
for p in self._ps:
p.daemon = True # if the main process crashes, we should not cause things to hang
p.start()
for remote in self._work_remotes:
remote.close()
self._waiting = True
def _send_act(self, actions):
for remote, action in zip(self._remotes, actions):
remote.send(('s', action.to_vect()))
self._waiting = True
def _wait_for_obs(self):
results = [remote.recv() for remote in self._remotes]
self._waiting = False
obs, rews, dones, infos = zip(*results)
obs = [self.envs[e].observation_space.from_vect(ob) for e, ob in enumerate(obs)]
return np.stack(obs), np.stack(rews), np.stack(dones), infos
def step(self, actions):
"""
Perform a step in all the underlying environments.
If one or more of the underlying environments encounters a game over, it is automatically restarted.
The observation sent back to the user is the observation after the :func:`grid2op.Environment.Environment.reset`
has been called.
As opposed to :class:`Environment.step` a call to this function will automatically reset
any of the underlying environments in case one of them is "done". This is performed the following way.
In the case one underlying environment is over (due to game over or due to end of the chronics), then:
- the corresponding "done" is returned as ``True``
- the corresponding observation returned is not the observation of the last time step (corresponding to the
underlying environment that is game over) but is the first observation after reset.
At the next call to step, the flag done will be (if not game over arise) set to ``False`` and the
corresponding observation is the next observation of this underlying environment: every thing works
as usual in this case.
We did that because restarting the game over environment added un necessary complexity.
Parameters
----------
actions: ``list``
List of :attr:`MultiEnvironment.nb_env` :class:`grid2op.Action.BaseAction`. Each action will be executed
in the corresponding underlying environment.
Returns
-------
obs: ``list``
List all the observations returned by each underlying environment.
rews: ``list``
List all the rewards returned by each underlying environment.
dones: ``list``
List all the "done" returned by each underlying environment. If one of this value is "True" this means
the environment encounter a game over.
infos: ``list``
List of dictionaries corresponding
Examples
---------
You can use this class as followed:
.. code-block:: python
import grid2op
from grid2op.Environment import BaseMultiProcessEnv
env1 = grid2op.make() # create an environment of your choosing
env2 = grid2op.make() # create another environment of your choosing
multi_env = BaseMultiProcessEnv([env1, env2])
obss = multi_env.reset()
obs1, obs2 = obss # here i extract the observation of the first environment and of the second one
# note that you cannot do obs1.simulate().
# this is equivalent to a call to
# obs1 = env1.reset(); obs2 = env2.reset()
# then you can do regular steps
action_env1 = env1.action_space()
action_env2 = env2.action_space()
obss, rewards, dones, infos = env.step([action_env1, action_env2])
# if you define
# obs1, obs2 = obss
# r1, r2 = rewards
# done1, done2 = dones
# info1, info2 = infos
# in this case, it is equivalent to calling
# obs1, r1, done1, info1 = env1.step(action_env1)
# obs2, r2, done2, info2 = env2.step(action_env2)
Let us now focus on the "automatic" reset part.
.. code-block:: python
# see above for the creation of a multi_env and the proper imports
multi_env = BaseMultiProcessEnv([env1, env2])
action_env1 = env1.action_space()
action_env2 = env2.action_space()
obss, rewards, dones, infos = env.step([action_env1, action_env2])
# say dones[0] is ``True``
# in this case if you define
# obs1 = obss[0]
# r1=rewards[0]
# done1=done[0]
# info1=info[0]
# in that case it is equivalent to the "single processed" code
# obs1_tmp, r1_tmp, done1_tmp, info1_tmp = env1.step(action_env1)
# done1 = done1_tmp
# r1 = r1_tmp
# info1 = info1_tmp
# obs1_aux = env1.reset()
# obs1 = obs1_aux
# CAREFULLL in this case, obs1 is NOT obs1_tmp but is really
"""
if len(actions) != self.nb_env:
raise MultiEnvException("Incorrect number of actions provided. You provided {} actions, but the "
"MultiEnvironment counts {} different environment."
"".format(len(actions), self.nb_env))
for act in actions:
if not isinstance(act, BaseAction):
raise MultiEnvException("All actions send to MultiEnvironment.step should be of type \"grid2op.BaseAction\""
"and not {}".format(type(act)))
self._send_act(actions)
obs, rews, dones, infos = self._wait_for_obs()
return obs, rews, dones, infos
def reset(self):
"""
Reset all the environments, and return all the associated observation.
**NB** Except in some specific occasion, there is no need to call this function reset. Indeed, when
a sub environment is "done" then it is automatically restarted in the
:func:BaseMultiEnvMultiProcess.step` function.
Returns
-------
res: ``list``
The list of all observations. This list counts :attr:`MultiEnvironment.nb_env` elements, each one being
an :class:`grid2op.Observation.BaseObservation`.
"""
for remote in self._remotes:
remote.send(('r', None))
res = [self.envs[e].observation_space.from_vect(remote.recv()) for e, remote in enumerate(self._remotes)]
return np.stack(res)
def close(self):
"""
Close all the environments and all the processes.
"""
for remote in self._remotes:
remote.send(('c', None))
def set_chunk_size(self, new_chunk_size):
"""
Dynamically adapt the amount of data read from the hard drive. Usefull to set it to a low integer value (eg 10
or 100) at the beginning of the learning process, when agent fails pretty quickly.
This takes effect only after a reset has been performed.
Parameters
----------
new_chunk_size: ``int``
The new chunk size (positive integer)
"""
try:
new_chunk_size = int(new_chunk_size)
except Exception as e:
raise Grid2OpException("Impossible to set the chunk size. It should be convertible a integer, and not"
"{}".format(new_chunk_size))
if new_chunk_size <= 0:
raise Grid2OpException("Impossible to read less than 1 data at a time. Please make sure \"new_chunk_size\""
"is a positive integer.")
for remote in self._remotes:
remote.send(('z', new_chunk_size))
def set_ff(self, ff_max=7*24*60/5):
"""
This method is primarily used for training.
The problem this method aims at solving is the following: most of grid2op environments starts a Monday at
00:00. This method will "fast forward" an environment for a random number of timestep between 0 and ``ff_max``
"""
try:
ff_max = int(ff_max)
except:
raise RuntimeError("ff_max parameters should be convertible to an integer.")
for remote in self._remotes:
remote.send(('f', ff_max))
def get_seeds(self):
"""
Get the seeds used to initialize each sub environments.
"""
for remote in self._remotes:
remote.send(('seed', None))
res = [remote.recv() for remote in self._remotes]
return np.stack(res)
def get_parameters(self):
"""
Get the parameters of each sub environments
"""
for remote in self._remotes:
remote.send(('params', None))
res = [remote.recv() for remote in self._remotes]
return res
def get_obs(self):
"""implement the get_obs function that is "broken" if you use the __getattr__"""
for remote in self._remotes:
remote.send(('o', None))
res = [self.envs[e].observation_space.from_vect(remote.recv()) for e, remote in enumerate(self._remotes)]
return res
def __getattr__(self, name):
"""
This function is used to get the attribute of the underlying sub environments.
Note that setting attributes or information to the sub_env this way will not work. This method only allows
to get the value of some attributes, NOT to modify them.
/!\ **DANGER** /!\ is you use this function, you are entering the danger zone. This might not work and
make your all python session dies without any notice. You've been warned.
Parameters
----------
name: ``str``
Name of the attribute you want to get the value, for each sub_env
Returns
-------
res: ``list``
The value of the given attribute for each sub env. Again, use with care.
"""
res = True
for sub_env in self.envs:
if not hasattr(sub_env, name):
res = False
if not res:
raise RuntimeError("At least one of the sub_env has not the attribute \"{}\". This will not be "
"executed.".format(name))
for remote in self._remotes:
remote.send((name, None))
res = [remote.recv() for remote in self._remotes]
return res
if __name__ == "__main__":
from tqdm import tqdm
from grid2op import make
from grid2op.Agent import DoNothingAgent
nb_env = 8 # change that to adapt to your system
NB_STEP = 100 # number of step for each environment
env = make()
env.seed(42)
envs = [env for _ in range(nb_env)]
agent = DoNothingAgent(env.action_space)
multi_envs = BaseMultiProcessEnvironment(envs)
obs = multi_envs.reset()
rews = [env.reward_range[0] for i in range(nb_env)]
dones = [False for i in range(nb_env)]
total_reward = 0.
for i in tqdm(range(NB_STEP)):
acts = [None for _ in range(nb_env)]
for env_act_id in range(nb_env):
acts[env_act_id] = agent.act(obs[env_act_id], rews[env_act_id], dones[env_act_id])
obs, rews, dones, infos = multi_envs.step(acts)
total_reward += np.sum(rews)
len(rews)
multi_envs.close()
ob = env.reset()
rew = env.reward_range[0]
done = False
total_reward_single = 0
for i in tqdm(range(NB_STEP)):
act = agent.act(ob, rew, done)
ob, rew, done, info = env.step(act)
if done:
ob = env.reset()
total_reward_single += np.sum(rew)
env.close()
print("total_reward mluti_env: {}".format(total_reward))
print("total_reward single env: {}".format(total_reward_single))