From 3feb908900309b1445236bc79c9f1541307254e9 Mon Sep 17 00:00:00 2001 From: Charlie Crane Date: Thu, 5 Sep 2024 09:02:07 +0100 Subject: [PATCH] #2837 - Added a description of how some rewards can be made sticky/instantaneous. [skip ci] --- docs/source/rewards.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/rewards.rst b/docs/source/rewards.rst index 921544e8..0163284c 100644 --- a/docs/source/rewards.rst +++ b/docs/source/rewards.rst @@ -7,6 +7,9 @@ Rewards Rewards in PrimAITE are based on a system of individual components that react to events in the simulation. An agent's reward function is calculated as the weighted sum of several reward components. +Some rewards, such as the ``GreenAdminDatabaseUnreachablePenalty``, can be marked as 'sticky' in their configuration. Setting this to ``True`` will mean that they continue to output the same value after an event until another event of that type. +In the instance of the ``GreenAdminDatabaseUnreachablePenalty``, the database admin reward will stay negative until the next successful database request is made, even if the database admin agents do nothing and the database returns a good state. + Components ********** The following API pages describe the use of each reward component and the possible configuration options. An example of configuring each via yaml is also provided.