adding some documentation

Author: TLSDC

src/agentlab/agents/__init__.py

@@ -1,4 +1,13 @@
-"""TEST
+"""
+AgentLab's agent implementations
+
+This module contains the agent implementations for AgentLab. With currently:
+
+- GenericAgent: Our baseline agent for evaluation
+
+- MostBasicAgent: A basic agent for learning our framework
+
+- TapeAgent: An agent that uses the Tape data structure to perform actions
 
-Stuff written here
+- VisualWebArenaAgent: An implentation of the agent used in WebArena and VisualWebArena
 """

src/agentlab/agents/generic_agent/__init__.py

@@ -1,9 +1,17 @@
+"""
+Baseline agent for all ServiceNow papers
+
+This module contains the GenericAgent class, which is the baseline agent for all ServiceNow papers. \
+It is a simple agent that can be ran OOB on all BrowserGym environments. It is also shipped with \
+a few configurations that can be used to run it on different environments.
+"""
+
 from .agent_configs import (
     AGENT_3_5,
     AGENT_8B,
+    AGENT_CUSTOM,
     AGENT_LLAMA3_70B,
     AGENT_LLAMA31_70B,
-    AGENT_CUSTOM,
     RANDOM_SEARCH_AGENT,
     AGENT_4o,
     AGENT_4o_MINI,

src/agentlab/agents/generic_agent/agent_configs.py

@@ -1,3 +1,7 @@
+"""
+Basic flags and agent configurations for generic agents.
+"""
+
 import bgym
 
 from agentlab.agents import dynamic_prompting as dp

src/agentlab/agents/generic_agent/generic_agent.py

@@ -1,3 +1,13 @@
+"""
+GenericAgent implementation for AgentLab
+
+This module defines a `GenericAgent` class and its associated arguments for use in the AgentLab framework. \
+The `GenericAgent` class is designed to interact with a chat-based model to determine actions based on \
+observations. It includes methods for preprocessing observations, generating actions, and managing internal \
+state such as plans, memories, and thoughts. The `GenericAgentArgs` class provides configuration options for \
+the agent, including model arguments and flags for various behaviors.
+"""
+
 from copy import deepcopy
 from dataclasses import asdict, dataclass
 from functools import partial

src/agentlab/agents/generic_agent/generic_agent_prompt.py

@@ -1,3 +1,9 @@
+"""
+Prompt builder for GenericAgent
+
+It is based on the dynamic_prompting module from the agentlab package.
+"""
+
 import logging
 from dataclasses import dataclass
 

src/agentlab/agents/generic_agent/reproducibility_agent.py

@@ -1,4 +1,5 @@
-"""Reproducibility Agent
+"""
+An agent that reproduces exactly the same traces as GenericAgent, to compare the results.
 
 
 This module contains the classes and functions to reproduce the results of a

src/agentlab/agents/generic_agent/tmlr_config.py

@@ -1,3 +1,7 @@
+"""
+Specific configurations for our 2024 TMLR submission.
+"""
+
 from copy import deepcopy
 
 from agentlab.agents import dynamic_prompting as dp