🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
Fix `mypy` errors in step functions of `EmbodiedAgent`, `CriticAgent` and `Human` (#192)
Guohao Lia77218c22d8f
diff --git a/camel/agents/__init__.py b/camel/agents/__init__.pyindex 1ab31f3dc..bb30ced33 100644--- a/camel/agents/__init__.py+++ b/camel/agents/__init__.py@@ -12,7 +12,7 @@# limitations under the License.# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========from .base import BaseAgent-from .chat_agent import ChatAgent+from .chat_agent import ChatAgent, ChatAgentResponsefrom .task_agent import TaskPlannerAgent, TaskSpecifyAgentfrom .critic_agent import CriticAgentfrom .tool_agents.base import BaseToolAgent@@ -22,6 +22,7 @@ from .embodied_agent import EmbodiedAgent__all__ = ['BaseAgent','ChatAgent',+ 'ChatAgentResponse','TaskSpecifyAgent','TaskPlannerAgent','CriticAgent',diff --git a/camel/agents/base.py b/camel/agents/base.pyindex 5f46beb19..896bdbd8a 100644--- a/camel/agents/base.py+++ b/camel/agents/base.py@@ -12,17 +12,18 @@# limitations under the License.# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========from abc import ABC, abstractmethod+from typing import Anyclass BaseAgent(ABC):r"""An abstract base class for all CAMEL agents."""@abstractmethod- def reset(self) -> None:+ def reset(self, *args: Any, **kwargs: Any) -> Any:r"""Resets the agent to its initial state."""pass@abstractmethod- def step(self) -> None:+ def step(self, *args: Any, **kwargs: Any) -> Any:r"""Performs a single step of the agent."""passdiff --git a/camel/agents/chat_agent.py b/camel/agents/chat_agent.pyindex 926d115d2..ed82c52ac 100644--- a/camel/agents/chat_agent.py+++ b/camel/agents/chat_agent.py@@ -107,7 +107,7 @@ class ChatAgent(BaseAgent):self.role_name: str = system_message.role_nameself.role_type: RoleType = system_message.role_typeself.output_language: Optional[str] = output_language- if output_language is not None:+ if self.output_language is not None:self.set_output_language(self.output_language)self.model: ModelType = (model if model is not None else@@ -320,8 +320,8 @@ class ChatAgent(BaseAgent):tuple: A tuple of list of output `ChatMessage`, list offinish reasons, usage dictionary, and response id."""- content_dict = defaultdict(lambda: "")- finish_reasons = defaultdict(lambda: "")+ content_dict: defaultdict = defaultdict(lambda: "")+ finish_reasons_dict: defaultdict = defaultdict(lambda: "")output_messages: List[BaseMessage] = []response_id: str = ""# All choices in one response share one role@@ -329,8 +329,8 @@ class ChatAgent(BaseAgent):for chunk in response:response_id = chunk["id"]for choice in chunk["choices"]:- index = choice["index"]- delta = choice["delta"]+ index: int = choice["index"]+ delta: Dict = choice["delta"]if len(delta) != 0:# When response has not been stopped# Notice that only the first chunk has the "role"@@ -338,14 +338,14 @@ class ChatAgent(BaseAgent):delta_content = delta.get("content", "")content_dict[index] += delta_contentelse:- finish_reasons[index] = choice["finish_reason"]+ finish_reasons_dict[index] = choice["finish_reason"]chat_message = BaseMessage(role_name=self.role_name,role_type=self.role_type,meta_dict=dict(),content=content_dict[index])output_messages.append(chat_message)finish_reasons = [- finish_reasons[i] for i in range(len(finish_reasons))+ finish_reasons_dict[i] for i in range(len(finish_reasons_dict))]usage_dict = self.get_usage_dict(output_messages, prompt_tokens)return output_messages, finish_reasons, usage_dict, response_iddiff --git a/camel/agents/critic_agent.py b/camel/agents/critic_agent.pyindex 2941f698b..e1021e0b1 100644--- a/camel/agents/critic_agent.py+++ b/camel/agents/critic_agent.py@@ -11,14 +11,13 @@# See the License for the specific language governing permissions and# limitations under the License.# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========-import copyimport randomimport warningsfrom typing import Any, Dict, Optional, Sequencefrom colorama import Fore-from camel.agents import ChatAgent+from camel.agents import ChatAgent, ChatAgentResponsefrom camel.messages import BaseMessagefrom camel.typing import ModelTypefrom camel.utils import get_first_int, print_text_animated@@ -141,7 +140,10 @@ class CriticAgent(ChatAgent):choice = str(get_first_int(critic_msg.content))return choice- def step(self, messages: Sequence[BaseMessage]) -> BaseMessage:+ def reduce_step(+ self,+ input_messages: Sequence[BaseMessage],+ ) -> ChatAgentResponse:r"""Performs one step of the conversation by flattening options to thecritic, getting the option, and parsing the choice.@@ -149,25 +151,24 @@ class CriticAgent(ChatAgent):messages (Sequence[BaseMessage]): A list of BaseMessage objects.Returns:- BaseMessage: A `BaseMessage` object representing the critic's- choice.+ ChatAgentResponse: A `ChatAgentResponse` object includes the+ critic's choice."""meta_chat_message = BaseMessage(- role_name=messages[0].role_name,- role_type=messages[0].role_type,- meta_dict=messages[0].meta_dict,+ role_name=input_messages[0].role_name,+ role_type=input_messages[0].role_type,+ meta_dict=input_messages[0].meta_dict,content="",)- flatten_options = self.flatten_options(messages)+ flatten_options = self.flatten_options(input_messages)if self.verbose:print_text_animated(self.logger_color +f"\x1b[3m{flatten_options}\x1b[0m\n")- input_msg = copy.deepcopy(meta_chat_message)- input_msg.content = flatten_options+ input_msg = meta_chat_message.create_new_instance(flatten_options)option = self.get_option(input_msg)- output_msg = copy.deepcopy(meta_chat_message)- output_msg.content = option+ output_msg = meta_chat_message.create_new_instance(option)- return output_msg+ # TODO: The return `info` can be improved.+ return ChatAgentResponse([output_msg], terminated=False, info={})diff --git a/camel/agents/embodied_agent.py b/camel/agents/embodied_agent.pyindex 47ab0674a..5a6dc8505 100644--- a/camel/agents/embodied_agent.py+++ b/camel/agents/embodied_agent.py@@ -11,11 +11,16 @@# See the License for the specific language governing permissions and# limitations under the License.# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========-from typing import Any, Dict, List, Optional, Tuple+from typing import Any, List, Optionalfrom colorama import Fore-from camel.agents import BaseToolAgent, ChatAgent, HuggingFaceToolAgent+from camel.agents import (+ BaseToolAgent,+ ChatAgent,+ ChatAgentResponse,+ HuggingFaceToolAgent,+)from camel.messages import BaseMessagefrom camel.typing import ModelTypefrom camel.utils import print_text_animated@@ -80,16 +85,16 @@ class EmbodiedAgent(ChatAgent):def step(self,input_message: BaseMessage,- ) -> Tuple[BaseMessage, bool, Dict[str, Any]]:+ ) -> ChatAgentResponse:r"""Performs a step in the conversation.Args:input_message (BaseMessage): The input message.Returns:- Tuple[BaseMessage, bool, Dict[str, Any]]: A tuple- containing the output messages, termination status, and- additional information.+ ChatAgentResponse: A struct containing the output messages,+ a boolean indicating whether the chat session has terminated,+ and information about the chat session."""response = super().step(input_message)@@ -128,4 +133,4 @@ class EmbodiedAgent(ChatAgent):f"\n> Embodied Actions:\n{content}")message = BaseMessage(input_message.role_name, input_message.role_type,input_message.meta_dict, content)- return message, response.terminated, response.info+ return ChatAgentResponse([message], response.terminated, response.info)diff --git a/camel/agents/task_agent.py b/camel/agents/task_agent.pyindex 41f013ac7..9deb4c572 100644--- a/camel/agents/task_agent.py+++ b/camel/agents/task_agent.py@@ -51,7 +51,7 @@ class TaskSpecifyAgent(ChatAgent):model_config: Optional[Any] = None,task_specify_prompt: Optional[Union[str, TextPrompt]] = None,word_limit: int = DEFAULT_WORD_LIMIT,- output_language: str = None,+ output_language: Optional[str] = None,) -> None:if task_specify_prompt is None:@@ -135,7 +135,7 @@ class TaskPlannerAgent(ChatAgent):self,model: Optional[ModelType] = None,model_config: Any = None,- output_language: str = None,+ output_language: Optional[str] = None,) -> None:self.task_planner_prompt = TextPrompt(diff --git a/camel/human.py b/camel/human.pyindex fd7ffdfdf..97d96eff1 100644--- a/camel/human.py+++ b/camel/human.py@@ -15,6 +15,7 @@ from typing import Any, Dict, Sequencefrom colorama import Fore+from camel.agents import ChatAgentResponsefrom camel.messages import BaseMessagefrom camel.utils import print_text_animated@@ -86,28 +87,26 @@ class Human:return human_input- def parse_input(self, human_input: str,- meta_chat_message: BaseMessage) -> BaseMessage:+ def parse_input(self, human_input: str) -> str:r"""Parses the user's input and returns a `BaseMessage` object.Args:human_input (str): The user's input.- meta_chat_message (BaseMessage): A `BaseMessage` object.Returns:- BaseMessage: A `BaseMessage` object.+ content: A `str` object representing the user's input."""if self.options_dict[human_input] == self.input_button:- meta_chat_message.content = input(self.logger_color +- "Please enter your message: ")- return meta_chat_message+ content = input(self.logger_color + "Please enter your message: ")elif self.options_dict[human_input] == self.kill_button:exit(self.logger_color + f"Killed by {self.name}.")else:- meta_chat_message.content = self.options_dict[human_input]- return meta_chat_message+ content = self.options_dict[human_input]- def step(self, messages: Sequence[BaseMessage]) -> BaseMessage:+ return content++ def reduce_step(self,+ messages: Sequence[BaseMessage]) -> ChatAgentResponse:r"""Performs one step of the conversation by displaying options to theuser, getting their input, and parsing their choice.@@ -115,7 +114,8 @@ class Human:messages (Sequence[BaseMessage]): A list of BaseMessage objects.Returns:- BaseMessage: A `BaseMessage` object representing the user's choice.+ ChatAgentResponse: A `ChatAgentResponse` object representing the+ user's choice."""meta_chat_message = BaseMessage(role_name=messages[0].role_name,@@ -125,4 +125,6 @@ class Human:)self.display_options(messages)human_input = self.get_input()- return self.parse_input(human_input, meta_chat_message)+ content = self.parse_input(human_input)+ message = meta_chat_message.create_new_instance(content)+ return ChatAgentResponse([message], terminated=False, info={})diff --git a/camel/societies/role_playing.py b/camel/societies/role_playing.pyindex 652a21210..d8d66efe7 100644--- a/camel/societies/role_playing.py+++ b/camel/societies/role_playing.py@@ -88,7 +88,7 @@ class RolePlaying:sys_msg_generator_kwargs: Optional[Dict] = None,extend_sys_msg_meta_dicts: Optional[List[Dict]] = None,extend_task_specify_meta_dict: Optional[Dict] = None,- output_language: str = None,+ output_language: Optional[str] = None,) -> None:self.with_task_specify = with_task_specifyself.with_task_planner = with_task_planner@@ -250,7 +250,8 @@ class RolePlaying:raise ValueError("Got than one message to process. "f"Num of messages: {len(messages)}.")elif self.with_critic_in_the_loop and self.critic is not None:- processed_msg = self.critic.step(messages)+ critic_response = self.critic.reduce_step(messages)+ processed_msg = critic_response.msgelse:processed_msg = messages[0]diff --git a/examples/embodiment/hugging_face_tool.py b/examples/embodiment/hugging_face_tool.pyindex fdf66be7f..57f5cb1df 100644--- a/examples/embodiment/hugging_face_tool.py+++ b/examples/embodiment/hugging_face_tool.py@@ -46,8 +46,8 @@ def main():"caption the image content, ""save the images by species name."),)- output_message, _, _ = embodied_agent.step(user_msg)- print(output_message.content)+ response = embodied_agent.step(user_msg)+ print(response.msg.content)if __name__ == "__main__":diff --git a/pyproject.toml b/pyproject.tomlindex f11cfdf8c..169b05dd4 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -69,3 +69,9 @@ markers = [[tool.coverage.report]include_namespace_packages = true++[[tool.mypy.overrides]]+module = [+ "transformers.tools",+]+ignore_missing_imports = truediff --git a/test/agents/test_critic_agent.py b/test/agents/test_critic_agent.pyindex fb1ff3e31..85ddfee8e 100644--- a/test/agents/test_critic_agent.py+++ b/test/agents/test_critic_agent.py@@ -96,7 +96,7 @@ def test_parse_critic(critic_agent: CriticAgent):@pytest.mark.model_backend-def test_step(critic_agent: CriticAgent):+def test_reduce_step(critic_agent: CriticAgent):messages = [BaseMessage(role_name="user",@@ -112,5 +112,6 @@ def test_step(critic_agent: CriticAgent):),]- assert (critic_agent.step(messages)- == messages[0]) or (critic_agent.step(messages) == messages[1])+ critic_response = critic_agent.reduce_step(messages)+ assert (critic_response.msg == messages[0]) or (critic_response.msg+ == messages[1])diff --git a/test/agents/test_embodied_agent.py b/test/agents/test_embodied_agent.pyindex a4cfdc325..24c967aa3 100644--- a/test/agents/test_embodied_agent.py+++ b/test/agents/test_embodied_agent.py@@ -48,7 +48,7 @@ def test_step():role_name=role_name,content="Draw all the Camelidae species.",)- output_message, terminated, info = embodied_agent.step(user_msg)- assert isinstance(output_message, BaseMessage)- assert not terminated- assert isinstance(info, dict)+ response = embodied_agent.step(user_msg)+ assert isinstance(response.msg, BaseMessage)+ assert not response.terminated+ assert isinstance(response.info, dict)diff --git a/test/test_human.py b/test/test_human.pyindex b1a11f420..6a384181a 100644--- a/test/test_human.py+++ b/test/test_human.py@@ -39,7 +39,7 @@ def test_get_input(monkeypatch):assert human.get_input() == str(1)-def test_step(monkeypatch):+def test_reduce_step(monkeypatch):human = Human()msgs = [BaseMessage.make_assistant_message(role_name="assistant",@@ -49,5 +49,5 @@ def test_step(monkeypatch):]monkeypatch.setattr('builtins.input', lambda _: str(1))- msg = human.step(msgs)- assert msg.content == "Hello"+ human_response = human.reduce_step(msgs)+ assert human_response.msg.content == "Hello"