forked from Gor-Ren/gym-jsbsim
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathreward_funcs.py
459 lines (431 loc) · 22.8 KB
/
reward_funcs.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
import markov_pilot.tasks.rewards as rewards
import markov_pilot.environment.properties as prp
from typing import Tuple
# the next three make_base_reward_components functions re successfully used in the experiments
# the standard 0-output reward function. Pass it in from here, as otherwise, the restore gets nifty due to the indent within a class definition.
def _make_base_reward_components(self): #may be overwritten by injected custom function
# pylint: disable=method-hidden
"""
Just adds an Asymptotic error component as standard reward to the PID_FlightTask.
May be overwritten by injected custom function.
"""
base_components = (
rewards.ConstantDummyRewardComponent(name = self.name+'_dummyRwd', const_output=0.0),
)
return base_components
def make_angular_integral_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ANGLE_DEG_ERROR_SCALING = 0.1
CMD_TRAVEL_MAX = 2/4 # a qarter of the max. absolute value of the delta-cmd;
ANGLE_INT_DEG_MAX = self.integral_limit
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_Angle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_DEG_ERROR_SCALING,
weight=6),
rewards.LinearErrorComponent(name='rwd_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=CMD_TRAVEL_MAX,
weight=4),
rewards.LinearErrorComponent(name='rwd_Angle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_INT_DEG_MAX,
weight=10),
)
return base_components
def make_sideslip_angle_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
SIDESLIP_ANGLE_DEG_ERROR_SCALING = 0.5
RUDDER_CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd; leverage the non-linearities
SIDESLIP_ANGLE_INT_DEG_MAX = self.integral_limit
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_sideslipAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=SIDESLIP_ANGLE_DEG_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=RUDDER_CMD_TRAVEL_MAX,
weight=1), #for the rudder, we increase this priority
rewards.LinearErrorComponent(name='rwd_sideslipAngle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=SIDESLIP_ANGLE_INT_DEG_MAX,
weight=1),
)
return base_components
###########################################################################
# all make_base_reward_components below were just used during experiments
# some might be useful, but no guarantees
def make_glide_angle_reward_components(self):
GLIDE_ANGLE_DEG_ERROR_SCALING = 0.1
GLIDE_ANGLE_INT_DEG_MAX = self.integral_limit
ELEVATOR_CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd; leverage the non-linearities
GLIDE_ANGULAR_VELOCITY_SCALING = 0.25
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_glideAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=GLIDE_ANGLE_DEG_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_glideAngle_error_derivative',
prop=self.prop_error_derivative,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=2,
weight=1),
rewards.LinearErrorComponent(name='rwd_glideAngle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=GLIDE_ANGLE_INT_DEG_MAX,
weight=9),
rewards.LinearErrorComponent(name='rwd_elevator_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ELEVATOR_CMD_TRAVEL_MAX,
weight=2),
# rewards.LinearErrorComponent(name='rwd_angular_velocity_q_rad',
# prop=prp.q_radps,
# state_variables=self.obs_props,
# target=0.0,
# potential_difference_based=False,
# scaling_factor=GLIDE_ANGULAR_VELOCITY_SCALING,
# weight=1),
)
return base_components
def make_elevator_actuation_reward_components(self):
ELEVATOR_CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd; leverage the non-linearities
base_components = (
rewards.LinearErrorComponent(name='rwd_elevator_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ELEVATOR_CMD_TRAVEL_MAX,
weight=2),
)
return base_components
def make_glide_path_angle_reward_components(self):
GLIDE_ANGLE_DEG_ERROR_SCALING = 0.1
GLIDE_ANGLE_INT_DEG_MAX = self.integral_limit
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_glideAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=GLIDE_ANGLE_DEG_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_glideAngle_error_derivative',
prop=self.prop_error_derivative,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=2,
weight=1),
rewards.LinearErrorComponent(name='rwd_glideAngle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=GLIDE_ANGLE_INT_DEG_MAX,
weight=9),
)
return base_components
def make_speed_reward_components(self):
KIAS_ERROR_SCALING = 1
KIAS_ERR_INT_DEG_MAX = self.integral_limit
ELEVATOR_CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd; leverage the non-linearities
GLIDE_ANGULAR_VELOCITY_SCALING = 0.25
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_kias_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=KIAS_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_kias_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=KIAS_ERR_INT_DEG_MAX,
weight=9),
rewards.LinearErrorComponent(name='rwd_elevator_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ELEVATOR_CMD_TRAVEL_MAX,
weight=2),
rewards.LinearErrorComponent(name='rwd_angular_velocity_q_rad',
prop=prp.q_radps,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=GLIDE_ANGULAR_VELOCITY_SCALING,
weight=1),
)
return base_components
def make_roll_angle_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ROLL_ANGLE_DEG_ERROR_SCALING = 0.5
ROLL_ANGLE_INT_DEG_MAX = self.integral_limit
AILERON_CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd; leverage the non-linearities
ROLL_ANGULAR_VELOCITY_SCALING = 0.25
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_rollAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_DEG_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_rollAngle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_INT_DEG_MAX,
weight=9),
rewards.LinearErrorComponent(name='rwd_aileron_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=AILERON_CMD_TRAVEL_MAX,
weight=2),
#check if the angular-velocity criterion is more helpful to avoid flittering.
#from a causality point of view, the command travel should be the criterion, as we want to avoid excessive movement.
#The control surface travel (derivative) must be presented to the ANN anyways.
rewards.LinearErrorComponent(name='rwd_roll_angular_velocity',
prop=prp.p_radps,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGULAR_VELOCITY_SCALING,
weight=1),
)
return base_components
def make_sideslip_angle_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
SIDESLIP_ANGLE_DEG_ERROR_SCALING = 0.5
SIDESLIP_ANGLE_INT_DEG_MAX = self.integral_limit
RUDDER_CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd; leverage the non-linearities
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_sideslipAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=SIDESLIP_ANGLE_DEG_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_rudder_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=RUDDER_CMD_TRAVEL_MAX,
weight=1), #for the rudder, we increase this priority
rewards.LinearErrorComponent(name='rwd_sideslipAngle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=SIDESLIP_ANGLE_INT_DEG_MAX,
weight=1),
)
return base_components
def make_roll_angle_error_only_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ROLL_ANGLE_DEG_ERROR_SCALING = 0.5
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_rollAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_DEG_ERROR_SCALING,
weight=1),
)
return base_components
def make_roll_angle_error_punish_actuation_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ROLL_ANGLE_DEG_ERROR_SCALING = 0.5
AILERON_CMD_TRAVEL_MAX = 2 # the max. absolute value of the delta-cmd;
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_rollAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_DEG_ERROR_SCALING,
weight=8),
rewards.LinearErrorComponent(name='rwd_aileron_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=AILERON_CMD_TRAVEL_MAX,
weight=2),
)
return base_components
def make_roll_angle_integral_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ROLL_ANGLE_DEG_ERROR_SCALING = 0.5
AILERON_CMD_TRAVEL_MAX = 2/4 # a qarter of the max. absolute value of the delta-cmd;
ROLL_ANGLE_INT_DEG_MAX = self.integral_limit
ROLL_ANGLE_DER_DEG_MAX = 10
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_rollAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_DEG_ERROR_SCALING,
weight=4),
rewards.LinearErrorComponent(name='rwd_aileron_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=AILERON_CMD_TRAVEL_MAX,
weight=2),
rewards.LinearErrorComponent(name='rwd_rollAngle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_INT_DEG_MAX,
weight=9),
rewards.QuadraticErrorComponent(name='rwd_rollAngle_error_Derivative',
prop=self.prop_error_derivative,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ROLL_ANGLE_DER_DEG_MAX**2,
weight=2),
)
return base_components
def make_angular_error_only_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ANGLE_DEG_ERROR_SCALING = 0.1
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_rollAngle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_DEG_ERROR_SCALING,
weight=1),
)
return base_components
def make_angular_error_punish_actuation_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ANGLE_DEG_ERROR_SCALING = 0.5
CMD_TRAVEL_MAX = 2/4 # a quarter of the max. absolute value of the delta-cmd;
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_Angle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_DEG_ERROR_SCALING,
weight=8),
rewards.LinearErrorComponent(name='rwd_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=CMD_TRAVEL_MAX,
weight=2),
)
return base_components
def make_angular_derivative_integral_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ANGLE_DEG_ERROR_SCALING = 0.1
CMD_TRAVEL_MAX = 2/4 # a qarter of the max. absolute value of the delta-cmd;
ANGLE_INT_DEG_MAX = self.integral_limit
ANGLE_DER_DEG_MAX = 0.1
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_Angle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_DEG_ERROR_SCALING,
weight=6),
rewards.LinearErrorComponent(name='rwd_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=CMD_TRAVEL_MAX,
weight=4),
rewards.LinearErrorComponent(name='rwd_Angle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_INT_DEG_MAX,
weight=10),
# rewards.AsymptoticErrorComponent(name='rwd_Angle_error_Derivative',
# prop=self.prop_error_derivative,
# state_variables=self.obs_props,
# target=0.0,
# potential_difference_based=False,
# scaling_factor=ANGLE_DER_DEG_MAX,
# weight=3),
)
return base_components
def make_rudder_reward_components(self) -> Tuple[rewards.RewardComponent, ...]:
ANGLE_DEG_ERROR_SCALING = 0.1
CMD_TRAVEL_MAX = 2/4 # a qarter of the max. absolute value of the delta-cmd;
ANGLE_INT_DEG_MAX = self.integral_limit
ANGLE_DER_DEG_MAX = 0.1
base_components = (
rewards.AngularAsymptoticErrorComponent(name='rwd_Angle_error',
prop=self.prop_error,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_DEG_ERROR_SCALING,
weight=6),
rewards.LinearErrorComponent(name='rwd_cmd_travel_error',
prop=self.prop_delta_cmd,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=CMD_TRAVEL_MAX,
weight=6),
rewards.LinearErrorComponent(name='rwd_Angle_error_Integral',
prop=self.prop_error_integral,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_INT_DEG_MAX,
weight=10),
rewards.AsymptoticErrorComponent(name='rwd_Angle_error_Derivative',
prop=self.prop_error_derivative,
state_variables=self.obs_props,
target=0.0,
potential_difference_based=False,
scaling_factor=ANGLE_DER_DEG_MAX,
weight=3),
)
return base_components