🐫 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 README and some other minor fixes (#439)
Zecheng Zhang8b268a0d2c45
diff --git a/README.md b/README.mdindex a04eca4d5..ba2e7cfd1 100644--- a/README.md+++ b/README.md@@ -1,41 +1,23 @@-<div style="left">- <a href="https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing" target="_blank">- <img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />- </a>- <a href="https://huggingface.co/camel-ai" target="_blank">- <img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white" />- </a>- <a href="https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA" target="_blank">- <img alt="Slack" src="https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack" />- </a>- <a href="https://discord.gg/CNcNpquyDc" target="_blank">- <img alt="Discord" src="https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da" />- </a>- <a href="https://ghli.org/camel/wechat.png" target="_blank">- <img alt="Discord" src="https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white" />- </a>- <a href="https://twitter.com/CamelAIOrg" target="_blank">- <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter" />- </a>-</div>--# CAMEL: Communicative Agents for “Mind” Exploration of Large Scale Language Model Society--<div align="center">-- <a></a>- <a href="https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml"></a>- <a href="https://camel-ai.github.io/camel/">- - </a>- <a href="https://github.com/camel-ai/camel/stargazers" target="_blank">- <img alt="GitHub Repo Stars" src="https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen" />- </a>- <a href="https://github.com/camel-ai/camel/blob/master/licenses/LICENSE"></a>-</div>+[![Colab][colab-image]][colab-url]+[![Hugging Face][huggingface-image]][huggingface-url]+[![Slack][slack-image]][slack-url]+[![Discord][discord-image]][discord-url]+[![Wechat][wechat-image]][wechat-url]+[![Twitter][twitter-image]][twitter-url]++______________________________________________________________________++# CAMEL: Communicative Agents for “Mind” Exploration of Large Language Model Society++[![Python Version][python-image]][python-url]+[![PyTest Status][pytest-image]][pytest-url]+[![Documentation][docs-image]][docs-url]+[![Star][star-image]][star-url]+[![Package License][package-license-image]][package-license-url]+[![Data License][data-license-image]][data-license-url]<p align="center">- <a href="https://github.com/camel-ai/camel#community">Community</a> |+ <a href="https://github.com/camel-ai/camel#community">Community</a> |<a href="https://github.com/camel-ai/camel#installation">Installation</a> |<a href="https://camel-ai.github.io/camel/">Documentation</a> |<a href="https://github.com/camel-ai/camel/tree/HEAD/examples">Examples</a> |@@ -46,7 +28,7 @@</p><p align="center">- <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo.png' width=800>+ <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png' width=800></p>## Overview@@ -70,7 +52,7 @@ We provide a [## Data (Hosted on Hugging Face)-| Dataset | Chat format | Instruction format | Chat format (translated) |-| -- | -- | -- | -- |+| Dataset | Chat format | Instruction format | Chat format (translated) |+|----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|| **AI Society** | [Chat format](https://huggingface.co/datasets/camel-ai/ai_society/blob/main/ai_society_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/ai_society/blob/main/ai_society_instructions.json) | [Chat format (translated)](https://huggingface.co/datasets/camel-ai/ai_society_translated) |-| **Code** | [Chat format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_instructions.json) | x |-| **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x|-| **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |-| **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |-| **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |+| **Code** | [Chat format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_instructions.json) | x |+| **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x |+| **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |+| **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |+| **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |## Visualizations of Instructions and Tasks-| Dataset | Instructions | Tasks |-| -- | -- | -- |-| **AI Society** | [Instructions](https://atlas.nomic.ai/map/3a559a06-87d0-4476-a879-962656242452/db961915-b254-48e8-8e5c-917f827b74c6) | [Tasks](https://atlas.nomic.ai/map/cb96f41b-a6fd-4fe4-ac40-08e101714483/ae06156c-a572-46e9-8345-ebe18586d02b) |-| **Code** | [Instructions](https://atlas.nomic.ai/map/902d6ccb-0bbb-4294-83a8-1c7d2dae03c8/ace2e146-e49f-41db-a1f4-25a2c4be2457) | [Tasks](https://atlas.nomic.ai/map/efc38617-9180-490a-8630-43a05b35d22d/2576addf-a133-45d5-89a9-6b067b6652dd) |+| Dataset | Instructions | Tasks |+|------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|+| **AI Society** | [Instructions](https://atlas.nomic.ai/map/3a559a06-87d0-4476-a879-962656242452/db961915-b254-48e8-8e5c-917f827b74c6) | [Tasks](https://atlas.nomic.ai/map/cb96f41b-a6fd-4fe4-ac40-08e101714483/ae06156c-a572-46e9-8345-ebe18586d02b) |+| **Code** | [Instructions](https://atlas.nomic.ai/map/902d6ccb-0bbb-4294-83a8-1c7d2dae03c8/ace2e146-e49f-41db-a1f4-25a2c4be2457) | [Tasks](https://atlas.nomic.ai/map/efc38617-9180-490a-8630-43a05b35d22d/2576addf-a133-45d5-89a9-6b067b6652dd) || **Misalignment** | [Instructions](https://atlas.nomic.ai/map/5c491035-a26e-4a05-9593-82ffb2c3ab40/2bd98896-894e-4807-9ed8-a203ccb14d5e) | [Tasks](https://atlas.nomic.ai/map/abc357dd-9c04-4913-9541-63e259d7ac1f/825139a4-af66-427c-9d0e-f36b5492ab3f) |## Implemented Research Ideas from Other Works@@ -261,12 +243,10 @@ We implemented amazing research ideas from other works for you to build, compare## AcknowledgementSpecial thanks to [Nomic AI](https://home.nomic.ai/) for giving us extended access to their data set exploration tool (Atlas).-We would also like to thank Haya Hammoud for designing the logo of our project.+We would also like to thank Haya Hammoud for designing the initial logo of our project.## License-The intended purpose and licensing of CAMEL is solely for research use.-The source code is licensed under Apache 2.0.The datasets are licensed under CC BY NC 4.0, which permits only non-commercial usage. It is advised that any models trained using the dataset should not be utilized for anything other than research purposes.@@ -276,3 +256,29 @@ We appreciate your interest in contributing to our open-source initiative. We pr## ContactFor more information please contact [email protected].++[python-image]: https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg+[python-url]: https://docs.python.org/3.9/+[pytest-image]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml/badge.svg+[pytest-url]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml+[docs-image]: https://img.shields.io/badge/Documentation-grey.svg?logo=github+[docs-url]: https://camel-ai.github.io/camel/index.html+[star-image]: https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen+[star-url]: https://github.com/camel-ai/camel/stargazers+[package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg+[package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE+[data-license-image]: https://img.shields.io/badge/License-CC_BY--NC_4.0-lightgrey.svg+[data-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/DATA_LICENSE++[colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing+[colab-image]: https://colab.research.google.com/assets/colab-badge.svg+[huggingface-url]: https://huggingface.co/camel-ai+[huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white+[slack-url]: https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA+[slack-image]: https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack+[discord-url]: https://discord.gg/CNcNpquyDc+[discord-image]: https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da+[wechat-url]: https://ghli.org/camel/wechat.png+[wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white+[twitter-url]: https://twitter.com/CamelAIOrg+[twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitterdiff --git a/camel/agents/chat_agent.py b/camel/agents/chat_agent.pyindex 8ed3d1e26..304db8737 100644--- a/camel/agents/chat_agent.py+++ b/camel/agents/chat_agent.py@@ -82,7 +82,7 @@ class ChatAgent(BaseAgent):message_window_size (int, optional): The maximum number of previousmessages to include in the context window. If `None`, no windowingis performed. (default: :obj:`None`)- token_limit (int, optional): The maxinum number of tokens in a context.+ token_limit (int, optional): The maximum number of tokens in a context.The context will be automatically pruned to fulfill the limitation.If `None`, it will be set according to the backend model.(default: :obj:`None`)diff --git a/camel/functions/search_functions.py b/camel/functions/search_functions.pyindex 81dc424d6..f0147d73f 100644--- a/camel/functions/search_functions.py+++ b/camel/functions/search_functions.py@@ -83,7 +83,7 @@ def search_google(query: str) -> List[Dict[str, Any]]:as a whole','url': 'https://www.openai.com'}- title, descrption, url of a website.+ title, description, url of a website."""import requests@@ -150,7 +150,7 @@ def text_extract_from_web(url: str) -> str:r"""Get the text information from given url.Args:- url (str): The web site you want to search.+ url (str): The website you want to search.Returns:str: All texts extract from the web.@@ -190,7 +190,7 @@ def create_chunks(text: str, n: int) -> List[str]:n (int): The max length of a single chunk.Returns:- List[str]: A list of splitted texts.+ List[str]: A list of split texts."""chunks = []@@ -238,7 +238,7 @@ def summarize_text(text: str, query: str) -> str:given.Args:- text (str): Text to summarise.+ text (str): Text to summarize.query (str): What information you want.Returns:diff --git a/misc/framework.png b/misc/framework.pngindex 5a1811e85..1f4662c5f 100644Binary files a/misc/framework.png and b/misc/framework.png differdiff --git a/misc/logo.png b/misc/logo.pngdeleted file mode 100644index aea587ba1..000000000Binary files a/misc/logo.png and /dev/null differdiff --git a/test/functions/test_search_functions.py b/test/functions/test_search_functions.pyindex a4eb3f8e9..dfd2f0629 100644--- a/test/functions/test_search_functions.py+++ b/test/functions/test_search_functions.py@@ -32,8 +32,7 @@ def test_search_wiki_normal():def test_search_wiki_not_found():- search_output = search_output = search_wiki(- "South Africa Women Football Team")+ search_output = search_wiki("South Africa Women Football Team")assert search_output.startswith("There is no page in Wikipedia corresponding to entity South Africa ""Women Football Team, please specify another word to describe the "