feat: react agent integration #179

HalberdOfPineapple · 2023-06-22T13:40:15Z

Description

Basically implemented the agent which outputs in ReAct pattern but only tested on several QA tasks. This PR is mainly for review purposes.

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax close #15213 if this solves the issue #15213

I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds core functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (update in the documentation)
Example (update in the folder of example)

Implemented Tasks

Subtask 1
Subtask 2
Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

I have read the CONTRIBUTION guide. (required)
My change requires a change to the documentation.
I have updated the tests accordingly. (required for a bug fix or a new feature)
I have updated the documentation accordingly.

…tools" This reverts commit 294fe26.

The file structure in master branch was modified to be different as this branch. The merge is for convenience of developing later.

Obs01ete

Overall looks good. Tests must be added.

Obs01ete · 2023-06-30T19:27:23Z

camel/agents/ReAct_agent.py

@@ -0,0 +1,222 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========


Rename to lower case react_agent.py

Obs01ete · 2023-06-30T19:31:41Z

camel/agents/ReAct_agent.py

+ self,
+ input_message: ChatMessage,
+ max_turns: int = 10,
+ ) -> Tuple[ChatMessage, bool, Dict[str, Any]]:


The signature of step does not follow the signature of the base class. If you want to introduce a new signature you must name the method differently

Sorry but this pattern was borrowed fromEmbodiedAgent and ChatAgent where they both used a completely different signature as the one in base class (def step(self) -> None:). I think the version in the base (BaseAgent) is too abstract and does not return anything and should not be used?

Please do not use EmbodiedAgent as a reference. There are some deficiencies in the code that we will fix soon. Please check your code with mypy and make sure you code does not introduce any warnings. Soon mypy will be made obligatory.

I do not totally agree with naming all the methods differently which will make it very difficult for the user to use. Just like PyTorch, every deviated Module has a different forward method with a different signature. It is still ok. IMO, the base class method's signature could be def step(self, *args, **kwargs) -> Any:.

The key feature of Module is polymorphism, a Module can be composed, the implementation can be abstracted away. In camel I do not see a single instance of polymorphic use of step() and reset(), implying it is not needed so far.

Obs01ete · 2023-06-30T19:34:17Z

camel/agents/ReAct_agent.py

+ return action, action_input
+
+
+class ReActAgent(ChatAgent):


In the nearest future we are going to move away from inheritance to a "part of" principle for agents. A chat agent must be a field of ReactAgent.

Obs01ete · 2023-06-30T19:36:10Z

camel/agents/tool_agents/Google_tool_agent.py

+ *args: Any,
+ ) -> None:
+ try:
+ from langchain.utilities import SerpAPIWrapper


You are bringing in langchain as a dependency which is not reflected in requirements.txt

In pyproject.toml, it is

Obs01ete · 2023-06-30T19:38:30Z

examples/ReAct/tool_usage.py

+from camel.typing import RoleType, ModelType
+
+
+def main():


Every example must be tested with pytest, parametrized with at least ModelType.STUB

Obs01ete · 2023-06-30T19:39:31Z

camel/agents/ReAct_agent.py

+
+
+class ReActAgent(ChatAgent):
+ r"""Class for managing conversions of a CAMEL agent following ReAct pattern.


Every introduced code must be covered by a test.

Obs01ete · 2023-06-30T19:39:50Z

camel/agents/tool_agents/Google_tool_agent.py

+from camel.agents.tool_agents import BaseToolAgent
+
+
+class GoogleToolAgent(BaseToolAgent):


Every introduced code must be covered by a test.

Obs01ete · 2023-06-30T19:40:21Z

camel/agents/tool_agents/wiki_tool_agent.py

+ return p.encode().decode("unicode-escape").encode("latin1").decode("utf-8")
+
+
+class WikiToolAgent(BaseToolAgent):


Every introduced code must be covered by a test.

HalberdOfPineapple · 2023-07-01T10:53:16Z

Overall looks good. Tests must be added.

Thanks very much for these comments. I know there are many problems with this commit and because I spent past several days working on another functionality (OpenAI function calling) I have not updated them on time. I will continue on this following your guidance later :)

Merge to see the changes brought by introducing mypy

HalberdOfPineapple · 2023-07-05T19:56:03Z

Hi, currently I ran into some problems:

the test cannot be passed because the package langchain is not installed when Github does the check, which leads to failure of examples with Google search included. But I did included langchain in requirements.txt
For integrating Google search, some external API is needed and here I used the wrapper of SerpAPI (the wrapper is implemented by langchain but I can replace the wrapper later). No matter what the wrapper is, the API itself needs an API key. I am wondering whether our group can provide this for search-related functionalities (not necessarily SerpAPI) and integrate the API key in Git checks (without this my implementation cannot pass the tests because it cannot Google search operations when needed) .

Obs01ete · 2023-07-06T09:40:27Z

For extra packages, put them in pyproject.toml poetry section.

HalberdOfPineapple added 4 commits June 19, 2023 23:43

initial commit

89730ca

Basically implemented ReAct-based agent with Wiki and Google tools

294fe26

Revert "Basically implemented ReAct-based agent with Wiki and Google …

0884cd5

…tools" This reverts commit 294fe26.

Re-adjust the basic implementation

97f7ace

HalberdOfPineapple requested a review from lightaime June 22, 2023 13:40

HalberdOfPineapple added 2 commits June 26, 2023 16:05

Commit before synchronizing with master

8917b15

Merge branch 'master' into feature/ReAct

689adc8

The file structure in master branch was modified to be different as this branch. The merge is for convenience of developing later.

lightaime mentioned this pull request Jun 28, 2023

[Roadmap] Reproduce more SOTA LLM agents #186

Open

14 tasks

lightaime assigned HalberdOfPineapple Jun 30, 2023

lightaime added the Agent Related to camel agents label Jun 30, 2023

Benjamin-eecs changed the title ~~Feature/re act~~ feat: react agent integration Jun 30, 2023

Obs01ete requested changes Jun 30, 2023

View reviewed changes

HalberdOfPineapple and others added 5 commits July 2, 2023 22:12

Typing, system message, documentation and tests

ed4eb12

Fix a small PEP8 error

4addce4

Merge branch 'master' into feature/ReAct

50a683b

commit before merging mypy

6cdd5f1

Merge branch 'master' into feature/ReAct

a4caa38

Merge to see the changes brought by introducing mypy

update documentation

daa79b7

Remove langchain dependency

c5c7645

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: react agent integration #179

feat: react agent integration #179

HalberdOfPineapple commented Jun 22, 2023 •

edited

Obs01ete left a comment

Obs01ete Jun 30, 2023

Obs01ete Jun 30, 2023

HalberdOfPineapple Jul 1, 2023

Obs01ete Jul 1, 2023

lightaime Jul 1, 2023 •

edited

Obs01ete Jul 1, 2023

Obs01ete Jun 30, 2023

Obs01ete Jun 30, 2023

Obs01ete Jul 6, 2023

Obs01ete Jun 30, 2023

Obs01ete Jun 30, 2023

Obs01ete Jun 30, 2023

Obs01ete Jun 30, 2023

HalberdOfPineapple commented Jul 1, 2023 •

edited

HalberdOfPineapple commented Jul 5, 2023

Obs01ete commented Jul 6, 2023

		@@ -0,0 +1,222 @@
		# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========



		class ReActAgent(ChatAgent):
		r"""Class for managing conversions of a CAMEL agent following ReAct pattern.

		from camel.agents.tool_agents import BaseToolAgent


		class GoogleToolAgent(BaseToolAgent):

		return p.encode().decode("unicode-escape").encode("latin1").decode("utf-8")


		class WikiToolAgent(BaseToolAgent):

feat: react agent integration #179

Are you sure you want to change the base?

feat: react agent integration #179

Conversation

HalberdOfPineapple commented Jun 22, 2023 • edited

Description

Motivation and Context

Types of changes

Implemented Tasks

Checklist

Obs01ete left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lightaime Jul 1, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HalberdOfPineapple commented Jul 1, 2023 • edited

HalberdOfPineapple commented Jul 5, 2023

Obs01ete commented Jul 6, 2023

HalberdOfPineapple commented Jun 22, 2023 •

edited

lightaime Jul 1, 2023 •

edited

HalberdOfPineapple commented Jul 1, 2023 •

edited