/
test_Reward.py
379 lines (304 loc) · 12.5 KB
/
test_Reward.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
# 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.
import unittest
import pdb
import warnings
import numbers
from abc import ABC, abstractmethod
import grid2op
from grid2op.tests.helper_path_test import *
from grid2op.Reward import *
from grid2op.Parameters import Parameters
from grid2op.Runner import Runner
from grid2op.Agent import BaseAgent
import warnings
class TestLoadingReward(ABC):
def setUp(self):
with warnings.catch_warnings():
warnings.filterwarnings("ignore")
self.env = grid2op.make(
"rte_case5_example", test=True, reward_class=self._reward_type(),
_add_to_name=type(self).__name__
)
self.action = self.env.action_space()
self.has_error = False
self.is_done = False
self.is_illegal = False
self.is_ambiguous = False
def tearDown(self):
self.env.close()
@abstractmethod
def _reward_type(self):
pass
def test_reward(self):
_, r_, _, _ = self.env.step(self.action)
assert isinstance(r_, numbers.Number)
assert issubclass(self._reward_type(), BaseReward)
class TestLoadingConstantReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return ConstantReward
class TestLoadingEconomicReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return EconomicReward
class TestLoadingFlatReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return FlatReward
class TestLoadingL2RPNReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return L2RPNReward
class TestLoadingRedispReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return RedispReward
class TestLoadingBridgeReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return BridgeReward
class TestLoadingL2RPNSandBoxScore(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return L2RPNSandBoxScore
class TestLoadingLinesCapacityReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return LinesCapacityReward
class TestDistanceReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return DistanceReward
def test_do_nothing(self):
self.env.reset()
dn_action = self.env.action_space({})
obs, r, d, info = self.env.step(dn_action)
max_reward = self.env._reward_helper.range()[1]
assert r == max_reward
def test_disconnect(self):
self.env.reset()
set_status = self.env.action_space.get_set_line_status_vect()
set_status[1] = -1
disconnect_action = self.env.action_space({"set_line_status": set_status})
obs, r, d, info = self.env.step(disconnect_action)
assert r < 1.0
def test_setBus2(self):
self.env.reset()
set_action = self.env.action_space({"set_bus": {"lines_or_id": [(0, 2)]}})
obs, r, d, info = self.env.step(set_action)
assert r != 1.0
class TestLoadingGameplayReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return GameplayReward
class TestCombinedReward(TestLoadingReward, unittest.TestCase):
def _reward_type(self):
return CombinedReward
def test_add_reward(self):
cr = self.env._reward_helper.template_reward
assert cr is not None
cr.addReward("Gameplay", GameplayReward(), 1.0)
cr.addReward("Flat", FlatReward(), 1.0)
cr.initialize(self.env)
def test_remove_reward(self):
cr = self.env._reward_helper.template_reward
assert cr is not None
added = cr.addReward("Gameplay", GameplayReward(), 1.0)
assert added == True
removed = cr.removeReward("Gameplay")
assert removed == True
removed = cr.removeReward("Unknow")
assert removed == False
def test_update_reward_weight(self):
cr = self.env._reward_helper.template_reward
assert cr is not None
added = cr.addReward("Gameplay", GameplayReward(), 1.0)
assert added == True
updated = cr.updateRewardWeight("Gameplay", 0.5)
assert updated == True
updated = cr.updateRewardWeight("Unknow", 0.5)
assert updated == False
def test_combine_distance_gameplay(self):
cr = self.env._reward_helper.template_reward
assert cr is not None
added = cr.addReward("Gameplay", GameplayReward(), 0.5)
assert added == True
distance_reward = DistanceReward()
added = cr.addReward("Distance", distance_reward, 0.5)
assert added == True
self.env.reset()
cr.initialize(self.env)
set_action = self.env.action_space({"set_bus": {"lines_or_id": [(1, 2)]}})
obs, r, d, info = self.env.step(set_action)
assert r < 1.0
def test_combine_simulate(self):
cr = self.env._reward_helper.template_reward
assert cr is not None
gr = GameplayReward()
gr.set_range(-21.0, 21.0)
added = cr.addReward("Gameplay", gr, 2.0)
assert added is True
self.env.change_reward(cr)
obs = self.env.reset()
assert self.env.reward_range == (-42, 42)
_, reward, done, info = obs.simulate(self.env.action_space({}))
assert done is False
assert reward == 42.0
class TestIncreaseFlatReward(unittest.TestCase):
def test_ok(self):
with warnings.catch_warnings():
warnings.filterwarnings("ignore")
env = grid2op.make(
"l2rpn_case14_sandbox", reward_class=IncreasingFlatReward, test=True,
_add_to_name=type(self).__name__
)
assert env.nb_time_step == 0
obs, reward, done, info = env.step(env.action_space())
assert env.nb_time_step == 1
assert reward == 1
obs, reward, done, info = env.step(env.action_space())
assert env.nb_time_step == 2
assert reward == 2
obs = env.reset()
assert env.nb_time_step == 0
obs, reward, done, info = env.step(env.action_space())
assert env.nb_time_step == 1
assert reward == 1
class TestEpisodeDurationReward(unittest.TestCase):
def test_ok(self):
with warnings.catch_warnings():
warnings.filterwarnings("ignore")
env = grid2op.make(
"l2rpn_case14_sandbox", reward_class=EpisodeDurationReward, test=True,
_add_to_name=type(self).__name__
)
assert env.nb_time_step == 0
obs, reward, done, info = env.step(env.action_space())
assert env.nb_time_step == 1
assert reward == 0
obs, reward, done, info = env.step(env.action_space())
assert env.nb_time_step == 2
assert reward == 0
obs, reward, done, info = env.step(
env.action_space({"set_bus": {"generators_id": [(0, -1)]}})
)
assert done
assert env.nb_time_step == 3
assert reward == 3.0 / 575.0
obs = env.reset()
assert env.nb_time_step == 0
obs, reward, done, info = env.step(env.action_space())
assert env.nb_time_step == 1
assert reward == 0
env.fast_forward_chronics(573)
obs, reward, done, info = env.step(env.action_space())
assert done
assert env.nb_time_step == 575
assert reward == 1.0
class TestN1Reward(unittest.TestCase):
def test_ok(self):
L_ID = 2
with warnings.catch_warnings():
warnings.filterwarnings("ignore")
env = grid2op.make(
"l2rpn_case14_sandbox", reward_class=N1Reward(l_id=L_ID), test=True,
_add_to_name=type(self).__name__
)
obs = env.reset()
obs, reward, *_ = env.step(env.action_space())
# obs._obs_env._reward_helper.template_reward._DEBUG = True
obs_n1, *_ = obs.simulate(
env.action_space({"set_line_status": [(L_ID, -1)]}), time_step=0
)
assert obs_n1.rho[L_ID] == 0 # line should have been disconnected
assert (
abs(reward - obs_n1.rho.max()) <= 1e-5
), "the correct reward has not been computed"
env.close()
L_IDS = [0, 1]
with warnings.catch_warnings():
warnings.filterwarnings("ignore")
env = grid2op.make(
"l2rpn_case14_sandbox",
other_rewards={f"line_{l_id}": N1Reward(l_id=l_id) for l_id in L_IDS},
test=True,
_add_to_name=type(self).__name__,
)
obs, reward, done, info = env.step(env.action_space())
for l_id in L_IDS:
obs_n1, *_ = obs.simulate(
env.action_space({"set_line_status": [(l_id, -1)]}), time_step=0
)
assert (
abs(info["rewards"][f"line_{l_id}"] - obs_n1.rho.max()) <= 1e-5
), f"the correct reward has not been computed for line {l_id}"
env.close()
class TMPRewardForTest(BaseReward):
def __call__(self, action, env, has_error, is_done, is_illegal, is_ambiguous):
if is_done:
assert not has_error
return super().__call__(action, env, has_error, is_done, is_illegal, is_ambiguous)
class ErrorAgent(BaseAgent):
def act(self, observation, reward, done=False):
if observation.current_step == 9:
return self.action_space({"set_bus": {"loads_id": [(0, -1)]}}) # force a game over
return super().act(observation, reward, done)
class TestEndOfEpisode(unittest.TestCase):
"""test the appropriate flags at the end of an episode"""
def setUp(self) -> None:
param = Parameters()
with warnings.catch_warnings():
warnings.filterwarnings("ignore")
self.env = grid2op.make("l2rpn_case14_sandbox", test=True,
reward_class=TMPRewardForTest, _add_to_name=type(self).__name__)
return super().setUp()
def tearDown(self) -> None:
self.env.close()
return super().tearDown()
def test_ok_end_of_episode(self):
# done = False
# i = 0
# while not done:
# obs, reward, done, info = self.env.step(self.env.action_space())
# i += 1
# assert i == 575, f"{i = } vs 575"
# above passed and took more than 30s
self.env.set_max_iter(10)
# episode goes until the end, no error is raised
self.env.reset()
done = False
i = 0
while not done:
obs, reward, done, info = self.env.step(self.env.action_space())
i += 1
assert i == 10, f"{i = } vs 10"
# agent does a game over, the reward should raise an error
self.env.reset()
done = False
i = 0
while i <= 1:
obs, reward, done, info = self.env.step(self.env.action_space())
i += 1
with self.assertRaises(AssertionError):
obs, reward, done, info = self.env.step(self.env.action_space({"set_bus": {"loads_id": [(0, -1)]}}))
# agent does a game over at last step, the reward should raise an error
self.env.reset()
done = False
i = 0
while i <= 8:
obs, reward, done, info = self.env.step(self.env.action_space())
i += 1
with self.assertRaises(AssertionError):
obs, reward, done, info = self.env.step(self.env.action_space({"set_bus": {"loads_id": [(0, -1)]}}))
def test_runner(self):
runner = Runner(**self.env.get_params_for_runner())
res = runner.run(nb_episode=1, max_iter=10)
assert res[0][3] == 10
runner = Runner(**self.env.get_params_for_runner(),
agentClass=ErrorAgent)
# error before last observation
with self.assertRaises(AssertionError):
res = runner.run(nb_episode=1, max_iter=11)
# error just at last observation
with self.assertRaises(AssertionError):
res = runner.run(nb_episode=1, max_iter=10)
# no error
res = runner.run(nb_episode=1, max_iter=9)
if __name__ == "__main__":
unittest.main()