Coverage for source/environment/reward_validator_base.py: 100%

1# environment/reward_validator_base.py 

2 

3from .order import Order 

4 

5class RewardValidatorBase(): 

6 """ 

7 Awards reward for successful or failure order basing on approach defined in 

8 derivative class. 

9 """ 

10 

11 def __init__(self, *args) -> None: 

12 """ 

13 Class constructor. Parameters are specified in derivative classes. 

14 """ 

15 

16 raise NotImplementedError 

17 

18 def validate_orders(self, orders: list[Order]) -> float: 

19 """ 

20 Calculates number of points to be rewarded for list of closed trades. 

21 

22 Parameters: 

23 orders (list[Order]): Orders to be validated. 

24 

25 Returns: 

26 (float): Calcualted reward. 

27 """ 

28 

29 raise NotImplementedError