From b35c27229a5261f80c1b297c60bc5da84f5bcc0b Mon Sep 17 00:00:00 2001
From: Yijia Shao <67158122+shaoyijia@users.noreply.github.com>
Date: Wed, 25 Sep 2024 10:15:59 -0700
Subject: [PATCH] Update comments.

---
 .../collaborative_storm/modules/co_storm_agents.py     | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/knowledge_storm/collaborative_storm/modules/co_storm_agents.py b/knowledge_storm/collaborative_storm/modules/co_storm_agents.py
index afc138d..e092cd6 100644
--- a/knowledge_storm/collaborative_storm/modules/co_storm_agents.py
+++ b/knowledge_storm/collaborative_storm/modules/co_storm_agents.py
@@ -109,8 +109,9 @@ def generate_utterance(
 
 class SimulatedUser(Agent):
     """
-    Simulated Users is a special type of Agent in Co-STORM that simulate real user interaction behavior or automatic experiments.
-
+    Simulated Users is a special type of Agent in Co-STORM that simulates real user interaction behavior based on the given intent.
+    
+    This class can be used for automatic experiments.
     For more information, please refer to Section 3.4 of Co-STORM paper: https://www.arxiv.org/pdf/2408.15232
     """
 
@@ -318,8 +319,9 @@ def generate_utterance(
 
 class PureRAGAgent(Agent):
     """
-    PureRAGAgent only handles grounded question generation by retrieving information from retriever based on the query.
-    It does not utilize any other information besides query itself.
+    PureRAGAgent only handles grounded question generation by retrieving information from the retriever based on the query.
+    It does not utilize any other information besides the query itself.
+    
     It's designed for Co-STORM paper baseline comparison.
     """