Skip to content

Commit a108e0f

Browse files
committed
[Docs] Fix RewardWithPenalties class documentation
1 parent 1942e99 commit a108e0f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

job_shop_lib/reinforcement_learning/_reward_observers.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,9 @@ class RewardWithPenalties(RewardObserver):
9898
Attributes:
9999
base_reward_observer:
100100
The base reward observer to use for calculating the reward.
101-
penalty_per_violation:
102-
The penalty to apply for each constraint violation.
101+
penalty_function:
102+
A function that takes a scheduled operation and the dispatcher as
103+
input and returns the penalty for that operation.
103104
104105
Args:
105106
dispatcher:
@@ -125,8 +126,8 @@ class RewardWithPenalties(RewardObserver):
125126
The following functions (along with ``functools.partial``) can be
126127
used to create penalty functions:
127128
128-
- :class:`~job_shop_lib.reinforcement_learning.get_deadline_violation_penalty`
129-
- :class:`~job_shop_lib.reinforcement_learning.get_due_date_violation_penalty`
129+
- :func:`~job_shop_lib.reinforcement_learning.get_deadline_violation_penalty`
130+
- :func:`~job_shop_lib.reinforcement_learning.get_due_date_violation_penalty`
130131
131132
""" # noqa: E501
132133

0 commit comments

Comments
 (0)