Add docstring to _rule_action()

maxbrenner-ai · Nov 14, 2018 · aed35a5 · aed35a5
1 parent 64b691f
commit aed35a5
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/dqn_agent.py b/dqn_agent.py
@@ -100,6 +100,17 @@ def get_action(self, state, use_rule=False):
                 return self._dqn_action(state)
 
     def _rule_action(self):
+        """
+        Returns a rule-based policy action.
+
+        Selects the next action of a simple rule-based policy.
+
+        Returns:
+            int: The index of the action in the possible actions
+            dict: The action/response itself
+
+        """
+
         if self.rule_current_slot_index < len(self.rule_request_set):
             slot = self.rule_request_set[self.rule_current_slot_index]
             self.rule_current_slot_index += 1