camel-ai 0.2.21__py3-none-any.whl → 0.2.23a0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of camel-ai might be problematic. Click here for more details.

Files changed (106) hide show
  1. camel/__init__.py +1 -1
  2. camel/agents/_types.py +41 -0
  3. camel/agents/_utils.py +188 -0
  4. camel/agents/chat_agent.py +556 -965
  5. camel/agents/knowledge_graph_agent.py +7 -1
  6. camel/agents/multi_hop_generator_agent.py +1 -1
  7. camel/configs/base_config.py +10 -13
  8. camel/configs/deepseek_config.py +4 -30
  9. camel/configs/gemini_config.py +5 -31
  10. camel/configs/openai_config.py +14 -32
  11. camel/configs/qwen_config.py +36 -36
  12. camel/datagen/self_improving_cot.py +79 -1
  13. camel/datagen/self_instruct/filter/instruction_filter.py +19 -3
  14. camel/datagen/self_instruct/self_instruct.py +7 -2
  15. camel/datasets/__init__.py +28 -0
  16. camel/datasets/base.py +969 -0
  17. camel/embeddings/openai_embedding.py +10 -1
  18. camel/environments/__init__.py +16 -0
  19. camel/environments/base.py +503 -0
  20. camel/extractors/__init__.py +16 -0
  21. camel/extractors/base.py +263 -0
  22. camel/interpreters/docker/Dockerfile +12 -0
  23. camel/interpreters/docker_interpreter.py +19 -1
  24. camel/interpreters/subprocess_interpreter.py +42 -17
  25. camel/loaders/__init__.py +2 -0
  26. camel/loaders/mineru_extractor.py +250 -0
  27. camel/memories/agent_memories.py +16 -1
  28. camel/memories/blocks/chat_history_block.py +10 -2
  29. camel/memories/blocks/vectordb_block.py +1 -0
  30. camel/memories/context_creators/score_based.py +20 -3
  31. camel/memories/records.py +10 -0
  32. camel/messages/base.py +8 -8
  33. camel/models/_utils.py +57 -0
  34. camel/models/aiml_model.py +48 -17
  35. camel/models/anthropic_model.py +41 -3
  36. camel/models/azure_openai_model.py +39 -3
  37. camel/models/base_model.py +132 -4
  38. camel/models/cohere_model.py +88 -11
  39. camel/models/deepseek_model.py +107 -63
  40. camel/models/gemini_model.py +133 -15
  41. camel/models/groq_model.py +72 -10
  42. camel/models/internlm_model.py +14 -3
  43. camel/models/litellm_model.py +9 -2
  44. camel/models/mistral_model.py +42 -5
  45. camel/models/model_manager.py +48 -3
  46. camel/models/moonshot_model.py +33 -4
  47. camel/models/nemotron_model.py +32 -3
  48. camel/models/nvidia_model.py +43 -3
  49. camel/models/ollama_model.py +139 -17
  50. camel/models/openai_audio_models.py +7 -1
  51. camel/models/openai_compatible_model.py +37 -3
  52. camel/models/openai_model.py +158 -46
  53. camel/models/qwen_model.py +61 -4
  54. camel/models/reka_model.py +53 -3
  55. camel/models/samba_model.py +209 -4
  56. camel/models/sglang_model.py +153 -14
  57. camel/models/siliconflow_model.py +16 -3
  58. camel/models/stub_model.py +46 -4
  59. camel/models/togetherai_model.py +38 -3
  60. camel/models/vllm_model.py +37 -3
  61. camel/models/yi_model.py +36 -3
  62. camel/models/zhipuai_model.py +38 -3
  63. camel/retrievers/__init__.py +3 -0
  64. camel/retrievers/hybrid_retrival.py +237 -0
  65. camel/toolkits/__init__.py +9 -2
  66. camel/toolkits/arxiv_toolkit.py +2 -1
  67. camel/toolkits/ask_news_toolkit.py +4 -2
  68. camel/toolkits/base.py +22 -3
  69. camel/toolkits/code_execution.py +2 -0
  70. camel/toolkits/dappier_toolkit.py +2 -1
  71. camel/toolkits/data_commons_toolkit.py +38 -12
  72. camel/toolkits/function_tool.py +13 -0
  73. camel/toolkits/github_toolkit.py +5 -1
  74. camel/toolkits/google_maps_toolkit.py +2 -1
  75. camel/toolkits/google_scholar_toolkit.py +2 -0
  76. camel/toolkits/human_toolkit.py +0 -3
  77. camel/toolkits/linkedin_toolkit.py +3 -2
  78. camel/toolkits/meshy_toolkit.py +3 -2
  79. camel/toolkits/mineru_toolkit.py +178 -0
  80. camel/toolkits/networkx_toolkit.py +240 -0
  81. camel/toolkits/notion_toolkit.py +2 -0
  82. camel/toolkits/openbb_toolkit.py +3 -2
  83. camel/toolkits/reddit_toolkit.py +11 -3
  84. camel/toolkits/retrieval_toolkit.py +6 -1
  85. camel/toolkits/semantic_scholar_toolkit.py +2 -1
  86. camel/toolkits/stripe_toolkit.py +8 -2
  87. camel/toolkits/sympy_toolkit.py +44 -1
  88. camel/toolkits/video_toolkit.py +2 -0
  89. camel/toolkits/whatsapp_toolkit.py +3 -2
  90. camel/toolkits/zapier_toolkit.py +191 -0
  91. camel/types/__init__.py +2 -2
  92. camel/types/agents/__init__.py +16 -0
  93. camel/types/agents/tool_calling_record.py +52 -0
  94. camel/types/enums.py +3 -0
  95. camel/types/openai_types.py +16 -14
  96. camel/utils/__init__.py +2 -1
  97. camel/utils/async_func.py +2 -2
  98. camel/utils/commons.py +114 -1
  99. camel/verifiers/__init__.py +23 -0
  100. camel/verifiers/base.py +340 -0
  101. camel/verifiers/models.py +82 -0
  102. camel/verifiers/python_verifier.py +202 -0
  103. {camel_ai-0.2.21.dist-info → camel_ai-0.2.23a0.dist-info}/METADATA +273 -256
  104. {camel_ai-0.2.21.dist-info → camel_ai-0.2.23a0.dist-info}/RECORD +106 -85
  105. {camel_ai-0.2.21.dist-info → camel_ai-0.2.23a0.dist-info}/WHEEL +1 -1
  106. {camel_ai-0.2.21.dist-info → camel_ai-0.2.23a0.dist-info}/LICENSE +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: camel-ai
3
- Version: 0.2.21
3
+ Version: 0.2.23a0
4
4
  Summary: Communicative Agents for AI Society Study
5
5
  License: Apache-2.0
6
6
  Keywords: communicative-ai,ai-societies,artificial-intelligence,deep-learning,multi-agent-systems,cooperative-ai,natural-language-processing,large-language-models
@@ -32,7 +32,6 @@ Requires-Dist: anthropic (>=0.42.0,<0.43.0) ; extra == "model-platforms" or extr
32
32
  Requires-Dist: apify_client (>=1.8.1,<2.0.0) ; extra == "web-tools" or extra == "all"
33
33
  Requires-Dist: arxiv (>=2.1.3,<3.0.0) ; extra == "research-tools" or extra == "all"
34
34
  Requires-Dist: arxiv2text (>=0.1.14,<0.2.0) ; extra == "research-tools" or extra == "all"
35
- Requires-Dist: asknews (>=0.7.54,<0.8.0) ; extra == "web-tools" or extra == "all"
36
35
  Requires-Dist: azure-storage-blob (>=12.21.0,<13.0.0) ; extra == "storage" or extra == "all"
37
36
  Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "document-tools" or extra == "all"
38
37
  Requires-Dist: botocore (>=1.35.3,<2.0.0) ; extra == "storage" or extra == "all"
@@ -56,7 +55,7 @@ Requires-Dist: firecrawl-py (>=1.0.0,<2.0.0) ; extra == "web-tools" or extra ==
56
55
  Requires-Dist: fish-audio-sdk (>=2024.12.5,<2025.0.0) ; extra == "model-platforms" or extra == "all"
57
56
  Requires-Dist: google-cloud-storage (>=2.18.0,<3.0.0) ; extra == "storage" or extra == "all"
58
57
  Requires-Dist: googlemaps (>=4.10.0,<5.0.0) ; extra == "web-tools" or extra == "all"
59
- Requires-Dist: httpx (>=0.23.0,<0.27.3)
58
+ Requires-Dist: httpx (>=0.28.0,<1.0.0dev)
60
59
  Requires-Dist: imageio[pyav] (>=2.34.2,<3.0.0) ; extra == "media-tools" or extra == "all"
61
60
  Requires-Dist: ipykernel (>=6.0.0,<7.0.0) ; extra == "dev-tools" or extra == "all"
62
61
  Requires-Dist: jsonschema (>=4,<5)
@@ -67,17 +66,16 @@ Requires-Dist: mistralai (>=1.1.0,<2.0.0) ; extra == "model-platforms" or extra
67
66
  Requires-Dist: mock (>=5,<6) ; extra == "test"
68
67
  Requires-Dist: nebula3-python (==3.8.2) ; extra == "rag" or extra == "storage" or extra == "all"
69
68
  Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "rag" or extra == "storage" or extra == "all"
69
+ Requires-Dist: networkx (>=3.4.2,<4.0.0) ; extra == "data-tools" or extra == "all"
70
70
  Requires-Dist: newspaper3k (>=0.2.8,<0.3.0) ; extra == "web-tools" or extra == "all"
71
71
  Requires-Dist: notion-client (>=2.2.1,<3.0.0) ; extra == "communication-tools" or extra == "all"
72
72
  Requires-Dist: numpy (>=1.26,<2.0)
73
73
  Requires-Dist: openai (>=1.59.7,<2.0.0)
74
74
  Requires-Dist: openapi-spec-validator (>=0.7.1,<0.8.0) ; extra == "document-tools" or extra == "all"
75
- Requires-Dist: openbb (>=4.3.5,<5.0.0) ; extra == "data-tools" or extra == "all"
76
75
  Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface" or extra == "all"
77
76
  Requires-Dist: outlines (>=0.1.7,<0.2.0) ; extra == "all"
78
77
  Requires-Dist: pandas (>=1.5.3,<2.0.0) ; extra == "data-tools" or extra == "all"
79
78
  Requires-Dist: pandasai (>=2.3.0,<3.0.0) ; extra == "rag" or extra == "document-tools" or extra == "all"
80
- Requires-Dist: pandoc (>=2.4,<3.0)
81
79
  Requires-Dist: pillow (>=10.1.0,<11.0.0) ; extra == "media-tools" or extra == "all"
82
80
  Requires-Dist: prance (>=23.6.21.0,<24.0.0.0) ; extra == "document-tools" or extra == "all"
83
81
  Requires-Dist: praw (>=7.7.1,<8.0.0) ; extra == "communication-tools" or extra == "all"
@@ -91,7 +89,6 @@ Requires-Dist: pymilvus (>=2.4.0,<3.0.0) ; extra == "rag" or extra == "storage"
91
89
  Requires-Dist: pyowm (>=3.3.0,<4.0.0) ; extra == "web-tools" or extra == "all"
92
90
  Requires-Dist: pytest (>=7,<8) ; extra == "test"
93
91
  Requires-Dist: pytest-asyncio (>=0.23.0,<0.24.0) ; extra == "test"
94
- Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
95
92
  Requires-Dist: qdrant-client (>=1.9.0,<2.0.0) ; extra == "rag" or extra == "storage" or extra == "all"
96
93
  Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0) ; extra == "rag" or extra == "all"
97
94
  Requires-Dist: redis (>=5.0.6,<6.0.0) ; extra == "storage" or extra == "all"
@@ -101,7 +98,6 @@ Requires-Dist: rouge (>=1.0.1,<2.0.0) ; extra == "data-tools" or extra == "all"
101
98
  Requires-Dist: scholarly[tor] (==1.7.11) ; extra == "research-tools" or extra == "all"
102
99
  Requires-Dist: sentence-transformers (>=3.0.1,<4.0.0) ; extra == "rag" or extra == "all"
103
100
  Requires-Dist: sentencepiece (>=0.2,<0.3) ; extra == "huggingface" or extra == "all"
104
- Requires-Dist: sglang (>=0.4.0,<0.5.0) ; extra == "model-platforms" or extra == "all"
105
101
  Requires-Dist: slack-bolt (>=1.20.1,<2.0.0) ; extra == "communication-tools" or extra == "all"
106
102
  Requires-Dist: slack-sdk (>=3.27.2,<4.0.0) ; extra == "communication-tools" or extra == "all"
107
103
  Requires-Dist: soundfile (>=0.13,<0.14) ; extra == "huggingface" or extra == "all"
@@ -115,7 +111,7 @@ Requires-Dist: torch (>=2,<3) ; (platform_system != "Darwin" or platform_machine
115
111
  Requires-Dist: transformers (>=4,<5) ; extra == "huggingface" or extra == "all"
116
112
  Requires-Dist: tree-sitter (>=0.23.2,<0.24.0) ; extra == "dev-tools" or extra == "all"
117
113
  Requires-Dist: tree-sitter-python (>=0.23.6,<0.24.0) ; extra == "dev-tools" or extra == "all"
118
- Requires-Dist: unstructured[all-docs] (==0.16.20) ; extra == "rag" or extra == "document-tools" or extra == "all"
114
+ Requires-Dist: unstructured (==0.16.20) ; extra == "rag" or extra == "document-tools" or extra == "all"
119
115
  Requires-Dist: wikipedia (>=1,<2) ; extra == "web-tools" or extra == "all"
120
116
  Requires-Dist: wolframalpha (>=5.0.0,<6.0.0) ; extra == "web-tools" or extra == "all"
121
117
  Requires-Dist: yt-dlp (>=2024.11.4,<2025.0.0) ; extra == "media-tools" or extra == "all"
@@ -124,232 +120,201 @@ Project-URL: Homepage, https://www.camel-ai.org/
124
120
  Project-URL: Repository, https://github.com/camel-ai/camel
125
121
  Description-Content-Type: text/markdown
126
122
 
127
- [![Colab][colab-image]][colab-url]
128
- [![Hugging Face][huggingface-image]][huggingface-url]
129
- [![Slack][slack-image]][slack-url]
130
- [![Discord][discord-image]][discord-url]
131
- [![Wechat][wechat-image]][wechat-url]
132
- [![Twitter][twitter-image]][twitter-url]
123
+ <div align="center">
124
+ <a href="https://www.camel-ai.org/">
125
+ <img src="docs/images/banner.png" alt="Banner">
126
+ </a>
127
+ </div>
133
128
 
134
- ______________________________________________________________________
129
+ </br>
135
130
 
136
- # CAMEL: Finding the Scaling Laws of Agents
131
+ <div align="center">
137
132
 
138
- [![Python Version][python-image]][python-url]
139
- [![PyTest Status][pytest-image]][pytest-url]
140
133
  [![Documentation][docs-image]][docs-url]
134
+ [![Discord][discord-image]][discord-url]
135
+ [![X][x-image]][x-url]
136
+ [![Reddit][reddit-image]][reddit-url]
137
+ [![Wechat][wechat-image]][wechat-url]
138
+ [![Hugging Face][huggingface-image]][huggingface-url]
141
139
  [![Star][star-image]][star-url]
142
140
  [![Package License][package-license-image]][package-license-url]
143
141
 
144
- <p align="center">
145
- <a href="https://github.com/camel-ai/camel#community">Community</a> |
146
- <a href="https://github.com/camel-ai/camel#installation">Installation</a> |
147
- <a href="https://camel-ai.github.io/camel/">Documentation</a> |
148
- <a href="https://github.com/camel-ai/camel/tree/HEAD/examples">Examples</a> |
149
- <a href="https://arxiv.org/abs/2303.17760">Paper</a> |
150
- <a href="https://github.com/camel-ai/camel#citation">Citation</a> |
151
- <a href="https://github.com/camel-ai/camel#contributing-to-camel-">Contributing</a> |
152
- <a href="https://www.camel-ai.org/">CAMEL-AI</a>
153
- </p>
142
+ </div>
154
143
 
155
- <p align="center">
156
- <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo_light.png' width=800>
157
- </p>
158
144
 
145
+ <hr>
159
146
 
160
- ## Community
161
- 🐫 CAMEL is an open-source community dedicated to finding the scaling laws of agents. We believe that studying these agents on a large scale offers valuable insights into their behaviors, capabilities, and potential risks. To facilitate research in this field, we implement and support various types of agents, tasks, prompts, models, and simulated environments.
147
+ <div align="center">
148
+ <h4 align="center">
162
149
 
163
- Join us ([*Discord*](https://discord.camel-ai.org/), [*WeChat*](https://ghli.org/camel/wechat.png) or [*Slack*](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ)) in pushing the boundaries of finding the scaling laws of agents.
150
+ [Community](https://github.com/camel-ai/camel#community) |
151
+ [Installation](https://github.com/camel-ai/camel#installation) |
152
+ [Examples](https://github.com/camel-ai/camel/tree/HEAD/examples) |
153
+ [Paper](https://arxiv.org/abs/2303.17760) |
154
+ [Citation](https://github.com/camel-ai/camel#citation) |
155
+ [Contributing](https://github.com/camel-ai/camel#contributing-to-camel-) |
156
+ [CAMEL-AI](https://www.camel-ai.org/)
164
157
 
165
- ## What Can You Build With CAMEL?
158
+ </h4>
166
159
 
167
- ### 🤖 Customize Agents
168
- - Customizable agents are the fundamental entities of the CAMEL architecture. CAMEL empowers you to customize agents using our modular components for specific tasks.
160
+ <p style="line-height: 1.5; text-align: center;"> 🐫 CAMEL is an open-source community dedicated to finding the scaling laws of agents. We believe that studying these agents on a large scale offers valuable insights into their behaviors, capabilities, and potential risks. To facilitate research in this field, we implement and support various types of agents, tasks, prompts, models, and simulated environments.</p>
169
161
 
170
- ### ⚙️ Build Multi-Agent Systems
171
- - We propose a multi-agent framework to address agents' autonomous cooperation challenges, guiding agents toward task completion while maintaining human intentions.
172
162
 
173
- ### 💻 Practical Applications
174
- - The CAMEL framework serves as a generic infrastructure for a wide range of multi-agent applications, including task automation, data generation, and world simulations.
163
+ <br>
175
164
 
176
165
 
177
- ## Why Should You Use CAMEL?
166
+ Join us ([*Discord*](https://discord.camel-ai.org/) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of finding the scaling laws of agents.
178
167
 
179
- 1. Comprehensive Customization and Collaboration:
168
+ 🌟 Star CAMEL on GitHub and be instantly notified of new releases.
180
169
 
181
- - Integrates over 20 advanced model platforms (e.g., commercial models like OpenAI, open-source models such as Llama3, and self-deployment frameworks like Ollama).
170
+ </div>
182
171
 
183
- - Supports extensive external tools (e.g., Search, Twitter, Github, Google Maps, Reddit, Slack utilities).
184
- - Includes memory and prompt components for deep customization.
185
- - Facilitates complex multi-agent systems with advanced collaboration features.
172
+ <div align="center">
173
+ <img src="docs/images/star.gif" alt="Star" width="186" height="60">
174
+ </a>
175
+ </div>
186
176
 
177
+ <br>
187
178
 
188
- 2. User-Friendly with Transparent Internal Structure:
189
- - Designed for transparency and consistency in internal structure.
190
179
 
191
- - Offers comprehensive [tutorials and detailed docstrings](https://docs.camel-ai.org/) for all functions.
192
- - Ensures an approachable learning curve for newcomers.
180
+ ## CAMEL Framework Design Principles
193
181
 
182
+ <h3>🧬 Evolvability</h3 >
194
183
 
195
- ## Try It Yourself
196
- We provide a [![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing) demo showcasing a conversation between two ChatGPT agents playing roles as a python programmer and a stock trader collaborating on developing a trading bot for stock market.
184
+ The framework enables multi-agent systems to continuously evolve by generating data and interacting with environments. This evolution can be driven by reinforcement learning with verifiable rewards or supervised learning.
197
185
 
198
- <p align="center">
199
- <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/framework.png' width=800>
200
- </p>
186
+ <h3>📈 Scalability</h3>
201
187
 
202
- ## Installation
188
+ The framework is designed to support systems with millions of agents, ensuring efficient coordination, communication, and resource management at scale.
203
189
 
204
- ### From PyPI
190
+ <h3>💾 Statefulness</h3>
205
191
 
206
- To install the base CAMEL library:
207
- ```bash
208
- pip install camel-ai
209
- ```
192
+ Agents maintain stateful memory, enabling them to perform multi-step interactions with environments and efficiently tackle sophisticated tasks.
210
193
 
211
- > **Note**: Some features may not work without their required dependencies. Install `camel-ai[all]` to ensure all dependencies are available, or install specific extras based on the features you need.
194
+ <h3>📖 Code-as-Prompt</h3>
212
195
 
213
- ```bash
214
- pip install 'camel-ai[all]' # Replace with options below
215
- ```
196
+ Every line of code and comment serves as a prompt for agents. Code should be written clearly and readably, ensuring both humans and agents can interpret it effectively.
216
197
 
217
- Available extras:
218
- - `all`: Includes all features below
219
- - `model_platforms`: OpenAI, Google, Mistral, Anthropic Claude, Cohere etc.
220
- - `huggingface`: Transformers, Diffusers, Accelerate, Datasets, PyTorch etc.
221
- - `rag`: Sentence Transformers, Qdrant, Milvus, BM25 etc.
222
- - `storage`: Neo4j, Redis, Azure Blob, Google Cloud Storage, AWS S3 etc.
223
- - `web_tools`: DuckDuckGo, Wikipedia, WolframAlpha, Google Maps, Weather API etc.
224
- - `document_tools`: PDF, Word, OpenAPI, BeautifulSoup, Unstructured etc.
225
- - `media_tools`: Image Processing, Audio Processing, YouTube Download, FFmpeg etc.
226
- - `communication_tools`: Slack, Discord, Telegram, GitHub, Reddit, Notion etc.
227
- - `data_tools`: Pandas, TextBlob, DataCommons, OpenBB, Stripe etc.
228
- - `research_tools`: arXiv, Google Scholar etc.
229
- - `dev_tools`: Docker, Jupyter, Tree-sitter, Code Interpreter etc.
230
-
231
- Multiple extras can be combined using commas:
232
- ```bash
233
- pip install 'camel-ai[rag,web_tools,document_tools]' # Example: RAG system with web search and document processing
234
- ```
198
+ <br>
235
199
 
236
- ### From Docker
200
+ ## Why Use CAMEL for Your Research?
237
201
 
238
- Detailed guidance can be found [here](https://github.com/camel-ai/camel/blob/master/.container/README.md)
202
+ We are a community-driven research collective comprising over 100 researchers dedicated to advancing frontier research in Multi-Agent Systems. Researchers worldwide choose CAMEL for their studies based on the following reasons.
239
203
 
240
- ## Quick Start
241
-
242
- By default, the agent uses the `ModelType.DEFAULT` model from the `ModelPlatformType.DEFAULT`. You can configure the default model platform and model type using environment variables. If these are not set, the agent will fall back to the default settings:
204
+ <table style="width: 100%;">
205
+ <tr>
206
+ <td align="left"></td>
207
+ <td align="left"></td>
208
+ <td align="left"></td>
209
+ </tr>
210
+ <tr>
211
+ <td align="left">✅</td>
212
+ <td align="left" style="font-weight: bold;">Large-Scale Agent System</td>
213
+ <td align="left">Simulate up to 1M agents to study emergent behaviors and scaling laws in complex, multi-agent environments.</td>
214
+ </tr>
215
+ <tr>
216
+ <td align="left">✅</td>
217
+ <td align="left" style="font-weight: bold;">Dynamic Communication</td>
218
+ <td align="left">Enable real-time interactions among agents, fostering seamless collaboration for tackling intricate tasks.</td>
219
+ </tr>
220
+ <tr>
221
+ <td align="left">✅</td>
222
+ <td align="left" style="font-weight: bold;">Stateful Memory</td>
223
+ <td align="left">Equip agents with the ability to retain and leverage historical context, improving decision-making over extended interactions.</td>
224
+ </tr>
225
+ <tr>
226
+ <td align="left">✅</td>
227
+ <td align="left" style="font-weight: bold;">Support for Multiple Benchmarks</td>
228
+ <td align="left">Utilize standardized benchmarks to rigorously evaluate agent performance, ensuring reproducibility and reliable comparisons.</td>
229
+ </tr>
230
+ <tr>
231
+ <td align="left">✅</td>
232
+ <td align="left" style="font-weight: bold;">Support for Different Agent Types</td>
233
+ <td align="left">Work with a variety of agent roles, tasks, models, and environments, supporting interdisciplinary experiments and diverse research applications.</td>
234
+ </tr>
235
+ <tr>
236
+ <td align="left">✅</td>
237
+ <td align="left" style="font-weight: bold;">Data Generation and Tool Integration</td>
238
+ <td align="left">Automate the creation of large-scale, structured datasets while seamlessly integrating with multiple tools, streamlining synthetic data generation and research workflows.</td>
239
+ </tr>
240
+ </table>
243
241
 
244
- ```bash
245
- ModelPlatformType.DEFAULT = "openai"
246
- ModelType.DEFAULT = "gpt-4o-mini"
247
- ```
242
+ <br>
248
243
 
249
- ### Setting Default Model Platform and Model Type (Optional)
250
-
251
- You can customize the default model platform and model type by setting the following environment variables:
252
- ```bash
253
- export DEFAULT_MODEL_PLATFORM_TYPE=<your preferred platform> # e.g., openai, anthropic, etc.
254
- export DEFAULT_MODEL_TYPE=<your preferred model> # e.g., gpt-3.5-turbo, gpt-4o-mini, etc.
255
- ```
244
+ ## What Can You Build With CAMEL?
256
245
 
257
- ### Setting Your Model API Key (Using OpenAI as an Example)
258
246
 
259
- **For Bash shell (Linux, macOS, Git Bash on Windows):**
247
+ ### 1. Data Generation
260
248
 
261
- ```bash
262
- # Export your OpenAI API key
263
- export OPENAI_API_KEY=<insert your OpenAI API key>
264
- OPENAI_API_BASE_URL=<insert your OpenAI API BASE URL> #(Should you utilize an OpenAI proxy service, kindly specify this)
265
- ```
249
+ <div align="center">
250
+ <a href="https://github.com/camel-ai/camel/blob/master/camel/datagen/cot_datagen.py">
251
+ <img src="docs/images/cot.png" alt="CoT Data Generation">
252
+ </a>
253
+ </div>
266
254
 
267
- **For Windows Command Prompt:**
255
+ <div align="center">
256
+ <a href="https://github.com/camel-ai/camel/tree/master/camel/datagen/self_instruct">
257
+ <img src="docs/images/self_instruct.png" alt="Self-Instruct Data Generation">
258
+ </a>
259
+ </div>
268
260
 
269
- ```cmd
270
- REM export your OpenAI API key
271
- set OPENAI_API_KEY=<insert your OpenAI API key>
272
- set OPENAI_API_BASE_URL=<insert your OpenAI API BASE URL> #(Should you utilize an OpenAI proxy service, kindly specify this)
273
- ```
261
+ <div align="center">
262
+ <a href="https://github.com/camel-ai/camel/tree/master/camel/datagen/source2synth">
263
+ <img src="docs/images/source2synth.png" alt="Source2Synth Data Generation">
264
+ </a>
265
+ </div>
274
266
 
275
- **For Windows PowerShell:**
267
+ <div align="center">
268
+ <a href="https://github.com/camel-ai/camel/blob/master/camel/datagen/self_improving_cot.py">
269
+ <img src="docs/images/self_improving.png" alt="Self-Improving Data Generation">
270
+ </a>
271
+ </div>
276
272
 
277
- ```powershell
278
- # Export your OpenAI API key
279
- $env:OPENAI_API_KEY="<insert your OpenAI API key>"
280
- $env:OPENAI_API_BASE_URL="<insert your OpenAI API BASE URL>" #(Should you utilize an OpenAI proxy service, kindly specify this)
281
- ```
273
+ ### 2. Task Automation
282
274
 
283
- Replace `<insert your OpenAI API key>` with your actual OpenAI API key in each case. Make sure there are no spaces around the `=` sign.
275
+ <div align="center">
276
+ <a href="https://github.com/camel-ai/camel/blob/master/camel/societies/role_playing.py">
277
+ <img src="docs/images/role_playing.png" alt="Role Playing">
278
+ </a>
279
+ </div>
284
280
 
281
+ <div align="center">
282
+ <a href="https://github.com/camel-ai/camel/tree/master/camel/societies/workforce">
283
+ <img src="docs/images/workforce.png" alt="Workforce">
284
+ </a>
285
+ </div>
285
286
 
286
- Please note that the environment variable is session-specific. If you open a new terminal window or tab, you will need to set the API key again in that new session.
287
+ <div align="center">
288
+ <a href="https://docs.camel-ai.org/cookbooks/advanced_features/agents_with_rag.html">
289
+ <img src="docs/images/rag_pipeline.png" alt="RAG Pipeline">
290
+ </a>
291
+ </div>
287
292
 
288
- **For `.env` File:**
289
293
 
290
- To simplify the process of managing API Keys, you can use store information in a `.env` file and load them into your application dynamically.
294
+ ### 3. World Simulation
291
295
 
292
- 1. Modify .env file in the root directory of CAMEL and fill the following lines:
296
+ <div align="center">
297
+ <a href="https://github.com/camel-ai/oasis">
298
+ <img src="docs/images/oasis_case.png" alt="Oasis Case">
299
+ </a>
300
+ </div>
293
301
 
294
- ```bash
295
- OPENAI_API_KEY=<fill your API KEY here>
296
- ```
302
+ <br>
297
303
 
298
- Replace <fill your API KEY here> with your actual API key.
299
-
300
- 2. Load the .env file in your Python script: Use the load_dotenv() function from the dotenv module to load the variables from the .env file into the environment. Here's an example:
301
-
302
- ```python
303
- from dotenv import load_dotenv
304
- import os
305
-
306
- # Load environment variables from the .env file
307
- load_dotenv()
308
- ```
309
- For more details about the key names in project and how to apply key,
310
- you can refer to [here](https://github.com/camel-ai/camel/.env).
311
-
312
- > [!TIP]
313
- > By default, the load_dotenv() function does not overwrite existing environment variables that are already set in your system. It only populates variables that are missing.
314
- If you need to overwrite existing environment variables with the values from your `.env` file, use the `override=True` parameter:
315
- > ```python
316
- > load_dotenv(override=True)
317
- > ```
304
+ ## Quick Start
318
305
 
319
- After setting the OpenAI API key, you can run the `role_playing.py` script. Find tasks for various assistant-user roles [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link).
306
+ Installing CAMEL is a breeze thanks to its availability on PyPI. Simply open your terminal and run:
320
307
 
321
308
  ```bash
322
- # You can change the role pair and initial prompt in role_playing.py
323
- python examples/ai_society/role_playing.py
309
+ pip install camel-ai
324
310
  ```
325
311
 
326
- Also feel free to run any scripts below that interest you:
327
-
328
- ```bash
329
- # You can change the role pair and initial prompt in these python files
330
-
331
- # Examples of two agents role-playing
332
- python examples/ai_society/role_playing.py
333
-
334
- # The agent answers questions by utilizing code execution tools.
335
- python examples/toolkits/code_execution_toolkit.py
336
-
337
- # Generating a knowledge graph with an agent
338
- python examples/knowledge_graph/knowledge_graph_agent_example.py
339
-
340
- # Multiple agents collaborating to decompose and solve tasks
341
- python examples/workforce/multiple_single_agents.py
342
-
343
- # Use agent to generate creative image
344
- python examples/vision/image_crafting.py
345
- ```
346
- For additional feature examples, see the [`examples`](https://github.com/camel-ai/camel/tree/master/examples) directory.
312
+ For more detailed instructions and additional configuration options, check out the [installation section](https://github.com/camel-ai/camel/blob/master/INSTALLATION.md).
347
313
 
348
- ## Documentation
314
+ After running, you can explore our CAMEL Tech Stack and Cookbooks at [www.docs.camel-ai.org](https://www.docs.camel-ai.org) to build powerful multi-agent systems.
349
315
 
350
- The [complete documentation](https://camel-ai.github.io/camel/) pages for the CAMEL package. Also, detailed tutorials for each part are provided below:
316
+ We provide a [![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing) demo showcasing a conversation between two ChatGPT agents playing roles as a python programmer and a stock trader collaborating on developing a trading bot for stock market.
351
317
 
352
- ### Agents
353
318
  Explore different types of agents, their roles, and their applications.
354
319
 
355
320
  - **[Creating Your First Agent](https://docs.camel-ai.org/cookbooks/basic_concepts/create_your_first_agent.html)**
@@ -357,37 +322,120 @@ Explore different types of agents, their roles, and their applications.
357
322
  - **[Embodied Agents](https://docs.camel-ai.org/cookbooks/advanced_features/embodied_agents.html)**
358
323
  - **[Critic Agents](https://docs.camel-ai.org/cookbooks/advanced_features/critic_agents_and_tree_search.html)**
359
324
 
360
- ---
325
+ ### Seeking Help
326
+
327
+ Please reachout to us on [CAMEL discord](https://discord.camel-ai.org/) if you encounter any issue set up CAMEL.
328
+
329
+ <br>
330
+
331
+ ## Tech Stack
332
+
333
+ <div align="center">
334
+ <a href="https://docs.camel-ai.org">
335
+ <img src="docs/images/techstack.png" alt="TechStack">
336
+ </a>
337
+ </div>
361
338
 
362
339
  ### Key Modules
363
340
  Core components and utilities to build, operate, and enhance CAMEL-AI agents and societies.
364
341
 
365
342
  | Module | Description |
366
343
  |:---|:---|
344
+ | **[Agents](https://docs.camel-ai.org/key_modules/agents.html)** | Core agent architectures and behaviors for autonomous operation. |
345
+ | **[Agent Societies](https://docs.camel-ai.org/key_modules/society.html)** | Components for building and managing multi-agent systems and collaboration. |
346
+ | **[Data Generation](https://docs.camel-ai.org/key_modules/datagen.html)** | Tools and methods for synthetic data creation and augmentation. |
367
347
  | **[Models](https://docs.camel-ai.org/key_modules/models.html)** | Model architectures and customization options for agent intelligence. |
368
- | **[Messages](https://docs.camel-ai.org/key_modules/messages.html)** | Messaging protocols for agent communication. |
369
- | **[Memory](https://docs.camel-ai.org/key_modules/memory.html)** | Memory storage and retrieval mechanisms. |
370
348
  | **[Tools](https://docs.camel-ai.org/key_modules/tools.html)** | Tools integration for specialized agent tasks. |
371
- | **[Prompts](https://docs.camel-ai.org/key_modules/prompts.html)** | Prompt engineering and customization. |
372
- | **[Tasks](https://docs.camel-ai.org/key_modules/tasks.html)** | Task creation and management for agent workflows. |
373
- | **[Loaders](https://docs.camel-ai.org/key_modules/loaders.html)** | Data loading tools for agent operation. |
374
- | **[Storages](https://docs.camel-ai.org/key_modules/storages.html)** | Storage solutions for agent. |
375
- | **[Society](https://docs.camel-ai.org/key_modules/society.html)** | Components for building agent societies and inter-agent collaboration. |
376
- | **[Embeddings](https://docs.camel-ai.org/key_modules/embeddings.html)** | Embedding models for RAG. |
377
- | **[Retrievers](https://docs.camel-ai.org/key_modules/retrievers.html)** | Retrieval methods for knowledge access. |
349
+ | **[Memory](https://docs.camel-ai.org/key_modules/memory.html)** | Memory storage and retrieval mechanisms for agent state management. |
350
+ | **[Storage](https://docs.camel-ai.org/key_modules/storages.html)** | Persistent storage solutions for agent data and states. |
351
+ | **[Benchmarks](https://github.com/camel-ai/camel/tree/master/camel/benchmarks)** | Performance evaluation and testing frameworks. |
352
+ | **[Interpreters](https://docs.camel-ai.org/key_modules/interpreters.html)** | Code and command interpretation capabilities. |
353
+ | **[Data Loaders](https://docs.camel-ai.org/key_modules/loaders.html)** | Data ingestion and preprocessing tools. |
354
+ | **[Retrievers](https://docs.camel-ai.org/key_modules/retrievers.html)** | Knowledge retrieval and RAG components. |
355
+ | **[Runtime](https://github.com/camel-ai/camel/tree/master/camel/runtime)** | Execution environment and process management. |
356
+ | **[Human-in-the-Loop](https://docs.camel-ai.org/cookbooks/advanced_features/agents_with_human_in_loop_and_tool_approval.html)** | Interactive components for human oversight and intervention. |
378
357
  ---
379
358
 
380
- ### Cookbooks
359
+ ## Research
360
+
361
+ We believe that studying these agents on a large scale offers valuable insights into their behaviors, capabilities, and potential risks.
362
+
363
+ **Explore our research projects:**
364
+
365
+ <div align="center">
366
+ <a href="https://crab.camel-ai.org/">
367
+ <img src="docs/images/crab.png" alt="CRAB">
368
+ </a>
369
+ </div>
370
+
371
+ <div align="center">
372
+ <a href="https://www.agent-trust.camel-ai.org/">
373
+ <img src="docs/images/agent_trust.png" alt="Agent Trust">
374
+ </a>
375
+ </div>
376
+
377
+ <div align="center">
378
+ <a href="https://oasis.camel-ai.org/">
379
+ <img src="docs/images/oasis.png" alt="OASIS">
380
+ </a>
381
+ </div>
382
+
383
+ <div align="center">
384
+ <a href="https://emos-project.github.io/">
385
+ <img src="docs/images/emos.png" alt="Emos">
386
+ </a>
387
+ </div>
388
+
389
+ >### Research with US
390
+ >
391
+ >We warmly invite you to use CAMEL for your impactful research.
392
+ >
393
+ > Rigorous research takes time and resources. We are a community-driven research collective with 100+ researchers exploring the frontier research of Multi-agent Systems. Join our ongoing projects or test new ideas with us, [reach out via email](mailto:camel-ai@eigent.ai) for more information.
394
+ >
395
+ ><div align="center">
396
+ > <img src="docs/images/partners.png" alt="Partners">
397
+ ></div>
398
+
399
+ <br>
400
+
401
+ ## Syenthetic Datasets
402
+
403
+ ### 1. Utilize Various LLMs as Backends
404
+
405
+ For more details, please see our [`Models Documentation`](https://docs.camel-ai.org/key_modules/models.html#).
406
+
407
+ > **Data (Hosted on Hugging Face)**
408
+
409
+ | Dataset | Chat format | Instruction format | Chat format (translated) |
410
+ |----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
411
+ | **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) |
412
+ | **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 |
413
+ | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x |
414
+ | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
415
+ | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
416
+ | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
417
+
418
+ ### 2. Visualizations of Instructions and Tasks
419
+
420
+ | Dataset | Instructions | Tasks |
421
+ |------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
422
+ | **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) |
423
+ | **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) |
424
+ | **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) |
425
+
426
+ <br>
427
+
428
+ ## Cookbooks (Usecases)
381
429
  Practical guides and tutorials for implementing specific functionalities in CAMEL-AI agents and societies.
382
430
 
383
- ### Basic Concepts
431
+ ### 1. Basic Concepts
384
432
  | Cookbook | Description |
385
433
  |:---|:---|
386
434
  | **[Creating Your First Agent](https://docs.camel-ai.org/cookbooks/basic_concepts/create_your_first_agent.html)** | A step-by-step guide to building your first agent. |
387
435
  | **[Creating Your First Agent Society](https://docs.camel-ai.org/cookbooks/basic_concepts/create_your_first_agents_society.html)** | Learn to build a collaborative society of agents. |
388
436
  | **[Message Cookbook](https://docs.camel-ai.org/cookbooks/basic_concepts/agents_message.html)** | Best practices for message handling in agents. |
389
437
 
390
- ### Advanced Features
438
+ ### 2. Advanced Features
391
439
  | Cookbook | Description |
392
440
  |:---|:---|
393
441
  | **[Tools Cookbook](https://docs.camel-ai.org/cookbooks/advanced_features/agents_with_tools.html)** | Integrating tools for enhanced functionality. |
@@ -395,88 +443,54 @@ Practical guides and tutorials for implementing specific functionalities in CAME
395
443
  | **[RAG Cookbook](https://docs.camel-ai.org/cookbooks/advanced_features/agents_with_rag.html)** | Recipes for Retrieval-Augmented Generation. |
396
444
  | **[Graph RAG Cookbook](https://docs.camel-ai.org/cookbooks/advanced_features/agents_with_graph_rag.html)** | Leveraging knowledge graphs with RAG. |
397
445
  | **[Track CAMEL Agents with AgentOps](https://docs.camel-ai.org/cookbooks/advanced_features/agents_tracking.html)** | Tools for tracking and managing agents in operations. |
398
- | **[Agents with Human-in-loop and Tool Approval from HumanLayer](https://docs.camel-ai.org/cookbooks/advanced_features/agents_with_human_in_loop_and_tool_approval.html)** | Implementing human oversight and tool approval within agent workflows using HumanLayer. |
399
446
 
400
- ### Data Generation & Model Training
447
+ ### 3. Model Training & Data Generation
401
448
  | Cookbook | Description |
402
449
  |:---|:---|
403
- | **[Data Generation with CAMEL and Finetuning with Unsloth](https://docs.camel-ai.org/cookbooks/data_generation/sft_data_generation_and_unsloth_finetuning_Qwen2_5_7B.html)** | Learn how to generate data with CAMEL and fine-tune models effectively with Unsloth. |
404
- | **[Data Gen with Real Function Calls and Hermes Format](https://docs.camel-ai.org/cookbooks/data_generation/data_gen_with_real_function_calls_and_hermes_format.html)** | Explore how to generate data with real function calls and the Hermes format. |
405
- | **[Self-instruct Data Generation](https://docs.camel-ai.org/cookbooks/data_generation/self_instruct_data_generation.html)** | Explore comprehensive guidelines and best practices for generating self-instructional data, enabling robust model training and improved performance. |
406
- | **[CoT Data Generation and SFT Qwen with Unsolth](https://docs.camel-ai.org/cookbooks/data_generation/cot_data_gen_sft_qwen_unsolth_upload_huggingface.html)** | Discover how to generate CoT data using CAMEL and SFT Qwen with Unsolth, and seamlessly upload your data and model to Huggingface. |
407
- | **[Agentic Data Generation, Evaluation & Filtering with Reward Models](https://docs.camel-ai.org/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.html)** | Discover methods for generating, evaluating, and filtering agentic data using reward models to enhance the quality and efficiency of your synthetic data pipelines. |
408
- | **[Data Model Generation and Structured Output with Qwen Model](https://docs.camel-ai.org/cookbooks/data_generation/data_model_generation_and_structured_output_with_qwen.html)** |Learn how to generate data models and structured outputs using the Qwen Model for improved data representation.|
409
- | **[Distill Math Reasoning Data from DeepSeek R1](https://docs.camel-ai.org/cookbooks/data_generation/distill_math_reasoning_data_from_deepseek_r1.html)** |Learn how to set up and leverage CAMEL's data distillation pipline for distilling high-quality maths reasoning data with thought process (Long CoT data)from deepseek R1, and uploading the results to Hugging Face.|
410
- | **[Self-Improving Math Reasoning Data Distillation from DeepSeek R1](https://docs.camel-ai.org/cookbooks/data_generation/self_improving_math_reasoning_data_distillation_from_deepSeek_r1.html)** |Learn how to set up and leverage CAMEL's data distillation pipline for self-improving math reasoning data distillation from deepseek R1, and uploading the results to Hugging Face.|
411
-
412
- ### Multi-Agent Systems & Applications
450
+ | **[Data Generation with CAMEL and Finetuning with Unsloth](https://docs.camel-ai.org/cookbooks/model_training/sft_data_generation_and_unsloth_finetuning_Qwen2_5_7B.html)** | Learn how to generate data with CAMEL and fine-tune models effectively with Unsloth. |
451
+ | **[Data Gen with Real Function Calls and Hermes Format](https://docs.camel-ai.org/cookbooks/model_training/data_gen_with_real_function_calls_and_hermes_format.html)** | Explore how to generate data with real function calls and the Hermes format. |
452
+ | **[CoT Data Generation and Upload Data to Huggingface](https://docs.camel-ai.org/cookbooks/model_training/cot_data_gen_upload_to_huggingface.html)** | Uncover how to generate CoT data with CAMEL and seamlessly upload it to Huggingface. |
453
+ | **[CoT Data Generation and SFT Qwen with Unsolth](https://docs.camel-ai.org/cookbooks/model_training/cot_data_gen_sft_qwen_unsolth_upload_huggingface.html)** | Discover how to generate CoT data using CAMEL and SFT Qwen with Unsolth, and seamlessly upload your data and model to Huggingface. |
454
+
455
+ ### 4. Multi-Agent Systems & Applications
413
456
  | Cookbook | Description |
414
457
  |:---|:---|
415
458
  | **[Role-Playing Scraper for Report & Knowledge Graph Generation](https://docs.camel-ai.org/cookbooks/applications/roleplaying_scraper.html)** | Create role-playing agents for data scraping and reporting. |
416
459
  | **[Create A Hackathon Judge Committee with Workforce](https://docs.camel-ai.org/cookbooks/multi_agent_society/workforce_judge_committee.html)** | Building a team of agents for collaborative judging. |
417
- | **[Dynamic Travel Planner Role-Playing: Multi-Agent System with Real-Time Insights Powered by Dappier](https://docs.camel-ai.org/cookbooks/applications/dynamic_travel_planner.html)** | Explore an innovative approach to travel planning, blending AI-driven role-playing and real-time data for seamless experiences. |
418
460
  | **[Customer Service Discord Bot with Agentic RAG](https://docs.camel-ai.org/cookbooks/applications/customer_service_Discord_bot_using_SambaNova_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG. |
419
461
  | **[Customer Service Discord Bot with Local Model](https://docs.camel-ai.org/cookbooks/applications/customer_service_Discord_bot_using_local_model_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG which supports local deployment. |
420
- | **[Customer Service Discord Bot for Finance with OpenBB](https://docs.camel-ai.org/cookbooks/applications/finance_discord_bot.html)**| Learn how to build a sipmle yet powerful financial data assistant Discord bot using OpenBB tools. |
421
462
 
422
- ### Data Processing
463
+ ### 5. Data Processing
423
464
  | Cookbook | Description |
424
465
  |:---|:---|
425
466
  | **[Video Analysis](https://docs.camel-ai.org/cookbooks/data_processing/video_analysis.html)** | Techniques for agents in video data analysis. |
426
467
  | **[3 Ways to Ingest Data from Websites with Firecrawl](https://docs.camel-ai.org/cookbooks/data_processing/ingest_data_from_websites_with_Firecrawl.html)** | Explore three methods for extracting and processing data from websites using Firecrawl. |
427
468
  | **[Create AI Agents that work with your PDFs](https://docs.camel-ai.org/cookbooks/data_processing/agent_with_chunkr_for_pdf_parsing.html)** | Learn how to create AI agents that work with your PDFs using Chunkr and Mistral AI. |
428
469
 
429
- ## Utilize Various LLMs as Backends
430
-
431
- For more details, please see our [`Models Documentation`](https://docs.camel-ai.org/key_modules/models.html#).
432
-
433
- ## Data (Hosted on Hugging Face)
434
- | Dataset | Chat format | Instruction format | Chat format (translated) |
435
- |----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
436
- | **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) |
437
- | **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 |
438
- | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x |
439
- | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
440
- | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
441
- | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
442
-
443
- ## Visualizations of Instructions and Tasks
444
470
 
445
- | Dataset | Instructions | Tasks |
446
- |------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
447
- | **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) |
448
- | **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) |
449
- | **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) |
471
+ <br>
450
472
 
451
- ## Implemented Research Ideas from Other Works
452
- We implemented amazing research ideas from other works for you to build, compare and customize your agents. If you use any of these modules, please kindly cite the original works:
453
- - `TaskCreationAgent`, `TaskPrioritizationAgent` and `BabyAGI` from *Nakajima et al.*: [Task-Driven Autonomous Agent](https://yoheinakajima.com/task-driven-autonomous-agent-utilizing-gpt-4-pinecone-and-langchain-for-diverse-applications/). [[Example](https://github.com/camel-ai/camel/blob/master/examples/ai_society/babyagi_playing.py)]
454
473
 
455
- - `PersonaHub` from *Tao Ge et al.*: [Scaling Synthetic Data Creation with 1,000,000,000 Personas](https://arxiv.org/pdf/2406.20094). [[Example](https://github.com/camel-ai/camel/blob/master/examples/personas/personas_generation.py)]
474
+ ## Contributing to CAMEL
456
475
 
457
- - `Self-Instruct` from *Yizhong Wang et al.*: [SELF-INSTRUCT: Aligning Language Models with Self-Generated Instructions](https://arxiv.org/pdf/2212.10560). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/self_instruct/self_instruct.py)]
476
+ > For those who'd like to contribute code, we appreciate your interest in contributing to our open-source initiative. Please take a moment to review our [contributing guidelines](https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md) to get started on a smooth collaboration journey.🚀
477
+ >
478
+ > We also welcome you to help CAMEL grow by sharing it on social media, at events, or during conferences. Your support makes a big difference!
458
479
 
459
- - `Source2Synth` from *Alisia Lupidi et al.*: [Source2Synth: Synthetic Data Generation and Curation Grounded in Real Data Sources](https://arxiv.org/abs/2409.08239). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/source2synth.py)]
480
+ <br>
460
481
 
461
- - `STaR` from *Eric Zelikman et al.*: [STaR: Bootstrapping Reasoning With Reasoning](https://arxiv.org/abs/2203.14465). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/star)]
482
+ ## Community & Contact
483
+ For more information please contact camel-ai@eigent.ai
462
484
 
463
- ## Other Research Works Based on Camel
464
- - [Agent Trust](http://agent-trust.camel-ai.org/): Can Large Language Model Agents Simulate Human Trust Behavior?
485
+ - **GitHub Issues:** Report bugs, request features, and track development. [Submit an issue](https://github.com/camel-ai/camel/issues)
465
486
 
466
- - [CRAB](https://crab.camel-ai.org/): Cross-environment Agent Benchmark for Multimodal Language Model Agents.
487
+ - **Discord:** Get real-time support, chat with the community, and stay updated. [Join us](https://discord.camel-ai.org/)
467
488
 
468
- - OASIS: Open Agents Social Interaction Simulations on a Large Scale.
489
+ - **X (Twitter):** Follow for updates, AI insights, and key announcements. [Follow us](https://x.com/CamelAIOrg)
469
490
 
470
- We warmly invite you to use CAMEL for your impactful research.
491
+ - **Ambassador Project:** Advocate for CAMEL-AI, host events, and contribute content. [Learn more](https://www.camel-ai.org/community)
471
492
 
472
- ## News
473
- 📢 Added support for Qwen models, Deepseek models to the 🐫 CAMEL framework!. (Nov 28, 2024)
474
- - Integrate SGLang into the 🐫 CAMEL framework. (Dec, 13, 2024)
475
- - Integrated Reward Model into the 🐫 CAMEL framework. (Dec, 13, 2024)
476
- - Added GAIA Benchmark! (Dec, 09, 2024)
477
- - ...
478
- - Released AI Society and Code dataset (April 2, 2023)
479
- - Initial release of `CAMEL` python library (March 21, 2023)
493
+ <br>
480
494
 
481
495
  ## Citation
482
496
  ```
@@ -487,26 +501,27 @@ We warmly invite you to use CAMEL for your impactful research.
487
501
  year={2023}
488
502
  }
489
503
  ```
504
+
490
505
  ## Acknowledgment
491
506
  Special thanks to [Nomic AI](https://home.nomic.ai/) for giving us extended access to their data set exploration tool (Atlas).
492
507
 
493
508
  We would also like to thank Haya Hammoud for designing the initial logo of our project.
494
509
 
510
+ We implemented amazing research ideas from other works for you to build, compare and customize your agents. If you use any of these modules, please kindly cite the original works:
511
+ - `TaskCreationAgent`, `TaskPrioritizationAgent` and `BabyAGI` from *Nakajima et al.*: [Task-Driven Autonomous Agent](https://yoheinakajima.com/task-driven-autonomous-agent-utilizing-gpt-4-pinecone-and-langchain-for-diverse-applications/). [[Example](https://github.com/camel-ai/camel/blob/master/examples/ai_society/babyagi_playing.py)]
512
+
513
+ - `PersonaHub` from *Tao Ge et al.*: [Scaling Synthetic Data Creation with 1,000,000,000 Personas](https://arxiv.org/pdf/2406.20094). [[Example](https://github.com/camel-ai/camel/blob/master/examples/personas/personas_generation.py)]
514
+
515
+ - `Self-Instruct` from *Yizhong Wang et al.*: [SELF-INSTRUCT: Aligning Language Models with Self-Generated Instructions](https://arxiv.org/pdf/2212.10560). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/self_instruct/self_instruct.py)]
516
+
517
+
495
518
  ## License
496
519
 
497
520
  The source code is licensed under Apache 2.0.
498
521
 
499
- ## Contributing to CAMEL 🐫
500
- We appreciate your interest in contributing to our open-source initiative. We provide a document of [contributing guidelines](https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md) which outlines the steps for contributing to CAMEL. Please refer to this guide to ensure smooth collaboration and successful contributions. 🤝🚀
501
-
502
- ## Contact
503
- For more information please contact camel.ai.team@gmail.com.
522
+ <br>
504
523
 
505
- [python-image]: https://img.shields.io/badge/Python-3.10%2C%203.11%2C%203.12-brightgreen.svg
506
- [python-url]: https://www.python.org/
507
- [pytest-image]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml/badge.svg
508
- [pytest-url]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml
509
- [docs-image]: https://img.shields.io/badge/Documentation-grey.svg?logo=github
524
+ [docs-image]: https://img.shields.io/badge/Documentation-EB3ECC
510
525
  [docs-url]: https://camel-ai.github.io/camel/index.html
511
526
  [star-image]: https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen
512
527
  [star-url]: https://github.com/camel-ai/camel/stargazers
@@ -517,12 +532,14 @@ For more information please contact camel.ai.team@gmail.com.
517
532
  [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
518
533
  [huggingface-url]: https://huggingface.co/camel-ai
519
534
  [huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white
520
- [slack-url]: https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ
521
- [slack-image]: https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack
522
535
  [discord-url]: https://discord.camel-ai.org/
523
- [discord-image]: https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da
536
+ [discord-image]: https://img.shields.io/discord/1082486657678311454?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb
524
537
  [wechat-url]: https://ghli.org/camel/wechat.png
525
538
  [wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white
526
- [twitter-url]: https://twitter.com/CamelAIOrg
539
+ [x-url]: https://x.com/CamelAIOrg
540
+ [x-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social
527
541
  [twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter
542
+ [reddit-url]: https://www.reddit.com/r/CamelAI/
543
+ [reddit-image]: https://img.shields.io/reddit/subreddit-subscribers/CamelAI?style=plastic&logo=reddit&label=r%2FCAMEL&labelColor=white
544
+ [ambassador-url]: https://www.camel-ai.org/community
528
545