UI supporting (#16)

.gitignore

@@ -14,6 +14,7 @@ data/
 bin/
 include/
 .chainlit
+.files
 
 # Python virtualenv
 .venv

README.md

@@ -28,6 +28,7 @@
 AgentLite is a research-oriented library designed for building and advancing LLM-based task-oriented agent systems. It simplifies the implementation of new agent/multi-agent architectures, enabling easy orchestration of multiple agents through a manager agent. Whether you're building individual agents or complex multi-agent systems, AgentLite provides a straightforward and lightweight foundation for your research and development. Check more details in [our paper](https://arxiv.org/abs/2402.15538).
 
 ## 🎉 News
+- **[04.2024]** [UI Supporting](./app/Homepage.py) is released for AgentLite! 
 - **[03.2024]** [xLAM model](https://huggingface.co/collections/Salesforce/xlam-models-65f00e2a0a63bbcd1c2dade4) and [xLAM code](https://github.com/SalesforceAIResearch/xLAM) is released! Try it with [AgentLite benchmark](./benchmark/), which is comparable to GPT-4!
 - **[03.2024]** We developed all the agent architectures in [BOLAA](https://arxiv.org/pdf/2308.05960.pdf) with AgentLite. Check our [new benchmark](./benchmark/)
 - **[02.2024]** Initial Release of AgentLite library and [paper](https://arxiv.org/abs/2402.15538)!
@@ -63,6 +64,16 @@ export OPENAI_API_KEY=<INSERT YOUR OpenAI API KEY HERE>
 python ./example/SearchManager.py
 ```
 
+## 🖥️ UI Supporting
+We provide a simple UI feature with AgentLite for demo purpose. To enable this capbility, uncomment the UI parts in [requirements.txt](./requirements.txt) to install the steamlite package.
+After installation, start with
+```shell
+steamlite run app/Homepage.py
+```
+Check our recorded UI demo.
+![UI demo](./image/weather_agent.gif)
+
+
 ## 🔍 Examples
 
 ### Building Individual Agents

agentlite/agents/BaseAgent.py

@@ -8,7 +8,7 @@
 from agentlite.commons.AgentAct import ActObsChainType
 from agentlite.llm.agent_llms import BaseLLM
 from agentlite.logging import DefaultLogger
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 from agentlite.memory.AgentSTMemory import AgentSTMemory, DictAgentSTMemory
 
 from .ABCAgent import ABCAgent

agentlite/agents/ManagerAgent.py

@@ -8,7 +8,7 @@
 from agentlite.commons.AgentAct import ActObsChainType
 from agentlite.llm.agent_llms import BaseLLM
 from agentlite.logging import DefaultLogger
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 from .ABCAgent import ABCAgent
 from .BaseAgent import BaseAgent

agentlite/logging/__init__.py

@@ -1,3 +1,3 @@
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 DefaultLogger = AgentLogger()

agentlite/logging/BaseLogger.py → agentlite/logging/base.py

@@ -1,17 +1,20 @@
-import os
+from abc import ABC, abstractmethod
 
 from agentlite.commons import AgentAct, TaskPackage
-from agentlite.logging.utils import *
-from agentlite.utils import bcolors
 
 
-class BaseAgentLogger:
+
+class BaseAgentLogger(ABC):
     def __init__(
         self,
         log_file_name: str = "agent.log",
     ) -> None:
         self.log_file_name = log_file_name
 
+    def __save_log__(self, log_str: str):
+        """how to save the log"""
+        pass
+
     def receive_task(self, task: TaskPackage, agent_name: str):
         """the agent receives a task and log it"""
         pass

agentlite/logging/streamlit_log.py → agentlite/logging/streamlit_logger.py

@@ -5,11 +5,10 @@
 
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.logging.utils import *
-from agentlite.utils import bcolors
 
-from .BaseLogger import BaseAgentLogger
+from .base import BaseAgentLogger
 
-class AgentLogger(BaseAgentLogger):
+class UILogger(BaseAgentLogger):
     def __init__(
         self,
         log_file_name: str = "agent.log",
@@ -21,13 +20,6 @@ def __init__(
         self.FLAG_PRINT = FLAG_PRINT  # whether print the log into terminal
         self.OBS_OFFSET = OBS_OFFSET
         self.PROMPT_DEBUG_FLAG = PROMPT_DEBUG_FLAG
-
-    def __check_log_file__(self):
-        if os.path.isdir(self.log_file_name):
-            return True
-        else:
-            print(f"{self.log_file_name} does not exist. Created one")
-            return False
 
     def __save_log__(self, log_str: str):
         with st.chat_message("assistant"):

agentlite/logging/multi_agent_log.py → agentlite/logging/terminal_logger.py

@@ -4,7 +4,7 @@
 from agentlite.logging.utils import *
 from agentlite.utils import bcolors
 
-from .BaseLogger import BaseAgentLogger
+from .base import BaseAgentLogger
 
 class AgentLogger(BaseAgentLogger):
     def __init__(
@@ -34,13 +34,6 @@ def __color_obs_str__(self, act_str: str):
     def __color_prompt_str__(self, prompt: str):
         return f"""{bcolors.WARNING}{prompt}{bcolors.ENDC}"""
 
-    def __check_log_file__(self):
-        if os.path.isdir(self.log_file_name):
-            return True
-        else:
-            print(f"{self.log_file_name} does not exist. Created one")
-            return False
-
     def __save_log__(self, log_str: str):
         if self.FLAG_PRINT:
             print(log_str)

agentlite/logging/utils.py

@@ -1,3 +1,4 @@
+import os
 import re
 
 
@@ -14,3 +15,11 @@ def str_color_remove(color_str: str):
     ansi_escape = re.compile(r"\x1B[@-_][0-?]*[ -/]*[@-~]")
     clean_str = ansi_escape.sub("", color_str)
     return clean_str
+
+
+def check_log_file(log_file_name):
+    if os.path.isdir(log_file_name):
+        return True
+    else:
+        print(f"{log_file_name} does not exist. Created one")
+        return False

app/pages/Philosophers.py

@@ -5,7 +5,7 @@
 from agentlite.llm.LLMConfig import LLMConfig
 from agentlite.actions.BaseAction import BaseAction
 
-from agentlite.logging.streamlit_log import AgentLogger
+from agentlite.logging.streamlit_logger import UILogger
 
 import streamlit as st
 
@@ -40,7 +40,7 @@ def __init__(
 llm_config = LLMConfig({"llm_name": llm_name, "temperature": 0.0})
 llm = get_llm_backend(llm_config)
 
-logger = AgentLogger()
+logger = UILogger()
 
 
 Confucius = Philosopher(philosopher="Confucius", llm=llm)

app/pages/Weatherman.py

@@ -12,7 +12,7 @@
 from agentlite.commons import TaskPackage
 from agentlite.llm.agent_llms import get_llm_backend, LLMConfig
 
-from agentlite.logging.streamlit_log import AgentLogger
+from agentlite.logging.streamlit_logger import UILogger
 
 llm_name = "gpt-4"
 llm_config = LLMConfig({"llm_name": llm_name, "temperature": 0.0})
@@ -30,7 +30,7 @@
     get_weather_forcast(),
 ]
 
-logger = AgentLogger()
+logger = UILogger()
 
 agent = BaseAgent(
     name=agent_info["name"],

benchmark/hotpotqa/evaluate_hotpot_qa.py

@@ -20,7 +20,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 
 

benchmark/hotpotqa/hotpotagents.py

@@ -6,7 +6,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 class WikiSearchAgent(BaseAgent):
     """

benchmark/tool/evaluate_tools.py

@@ -13,7 +13,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 LAM_URL = os.environ["LAM_URL"]
 

benchmark/tool/tool_agents.py

@@ -4,7 +4,7 @@
 from agentlite.agents import ABCAgent, BaseAgent
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 class WeatherAgent(BaseAgent):
     def __init__(self, env, llm: BaseLLM, agent_arch: str = "react", PROMPT_DEBUG_FLAG=False):

benchmark/webshop/evaluate_webshop.py

@@ -13,7 +13,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 LAM_URL = os.environ["LAM_URL"]
 webshop_env = Webshop()

benchmark/webshop/webshop_agents.py

@@ -7,7 +7,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 class WebshopAgent(BaseAgent):
     """

benchmark/webshop/webshop_multiagent.py

@@ -6,7 +6,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 class SearchAgent(BaseAgent):
     """

example/SearchAgent.py

@@ -8,7 +8,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 # set PROMPT_DEBUG_FLAG to True to see the debug info
 agent_logger = AgentLogger(PROMPT_DEBUG_FLAG=False)

example/SearchManager.py

@@ -9,7 +9,7 @@
 from agentlite.commons import ActObsChainType, AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 # set PROMPT_DEBUG_FLAG to True to see the debug info
 agent_logger = AgentLogger(PROMPT_DEBUG_FLAG=False)

example/philosopher_chat.py

@@ -3,7 +3,7 @@
 from agentlite.agents import ABCAgent, BaseAgent
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 from agentlite.actions.BaseAction import BaseAction
 
 # Define the Philosopher class 

example/run_hotpot_qa.py

@@ -18,7 +18,7 @@
 from agentlite.commons import AgentAct, TaskPackage
 from agentlite.llm.agent_llms import BaseLLM, get_llm_backend
 from agentlite.llm.LLMConfig import LLMConfig
-from agentlite.logging.multi_agent_log import AgentLogger
+from agentlite.logging.terminal_logger import AgentLogger
 
 
 def download_file(url, filename):