camel-ai 0.1.1__tar.gz → 0.1.3__tar.gz

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_ai-0.1.1 → camel_ai-0.1.3}/PKG-INFO +116 -74
  2. {camel_ai-0.1.1 → camel_ai-0.1.3}/README.md +98 -71
  3. camel_ai-0.1.3/camel/__init__.py +20 -0
  4. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/chat_agent.py +124 -63
  5. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/critic_agent.py +28 -17
  6. camel_ai-0.1.3/camel/agents/deductive_reasoner_agent.py +235 -0
  7. camel_ai-0.1.3/camel/agents/embodied_agent.py +190 -0
  8. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/role_assignment_agent.py +27 -17
  9. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/task_agent.py +60 -34
  10. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/tool_agents/base.py +0 -1
  11. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/tool_agents/hugging_face_tool_agent.py +7 -4
  12. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/configs.py +119 -7
  13. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/embeddings/__init__.py +2 -0
  14. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/embeddings/base.py +3 -2
  15. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/embeddings/openai_embedding.py +3 -3
  16. camel_ai-0.1.3/camel/embeddings/sentence_transformers_embeddings.py +65 -0
  17. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/functions/__init__.py +13 -3
  18. camel_ai-0.1.3/camel/functions/google_maps_function.py +335 -0
  19. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/functions/math_functions.py +7 -7
  20. camel_ai-0.1.3/camel/functions/openai_function.py +390 -0
  21. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/functions/search_functions.py +100 -35
  22. camel_ai-0.1.3/camel/functions/twitter_function.py +484 -0
  23. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/functions/weather_functions.py +36 -23
  24. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/generators.py +65 -46
  25. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/human.py +17 -11
  26. {camel_ai-0.1.1/camel/storages → camel_ai-0.1.3/camel/interpreters}/__init__.py +8 -6
  27. camel_ai-0.1.3/camel/interpreters/base.py +49 -0
  28. camel_ai-0.1.1/camel/utils/python_interpreter.py → camel_ai-0.1.3/camel/interpreters/internal_python_interpreter.py +129 -48
  29. camel_ai-0.1.3/camel/interpreters/interpreter_error.py +19 -0
  30. camel_ai-0.1.3/camel/interpreters/subprocess_interpreter.py +190 -0
  31. camel_ai-0.1.3/camel/loaders/__init__.py +22 -0
  32. camel_ai-0.1.1/camel/functions/base_io_functions.py → camel_ai-0.1.3/camel/loaders/base_io.py +38 -35
  33. camel_ai-0.1.1/camel/functions/unstructured_io_fuctions.py → camel_ai-0.1.3/camel/loaders/unstructured_io.py +199 -110
  34. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/memories/__init__.py +17 -7
  35. camel_ai-0.1.3/camel/memories/agent_memories.py +156 -0
  36. camel_ai-0.1.3/camel/memories/base.py +140 -0
  37. camel_ai-0.1.3/camel/memories/blocks/__init__.py +21 -0
  38. camel_ai-0.1.1/camel/memories/chat_history_memory.py → camel_ai-0.1.3/camel/memories/blocks/chat_history_block.py +34 -34
  39. camel_ai-0.1.3/camel/memories/blocks/vectordb_block.py +101 -0
  40. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/memories/context_creators/__init__.py +3 -2
  41. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/memories/context_creators/score_based.py +32 -20
  42. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/memories/records.py +6 -5
  43. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/messages/base.py +99 -16
  44. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/messages/func_message.py +7 -4
  45. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/models/__init__.py +4 -2
  46. camel_ai-0.1.3/camel/models/anthropic_model.py +132 -0
  47. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/models/base_model.py +3 -2
  48. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/models/model_factory.py +10 -8
  49. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/models/open_source_model.py +25 -13
  50. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/models/openai_model.py +9 -10
  51. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/models/stub_model.py +6 -5
  52. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/__init__.py +7 -5
  53. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/ai_society.py +21 -14
  54. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/base.py +54 -47
  55. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/code.py +22 -14
  56. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/evaluation.py +8 -5
  57. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/misalignment.py +26 -19
  58. camel_ai-0.1.3/camel/prompts/object_recognition.py +35 -0
  59. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/prompt_templates.py +14 -8
  60. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/role_description_prompt_template.py +16 -10
  61. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/solution_extraction.py +9 -5
  62. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/task_prompt_template.py +24 -21
  63. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/prompts/translation.py +9 -5
  64. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/responses/agent_responses.py +5 -2
  65. camel_ai-0.1.3/camel/retrievers/__init__.py +24 -0
  66. camel_ai-0.1.3/camel/retrievers/auto_retriever.py +319 -0
  67. camel_ai-0.1.3/camel/retrievers/base.py +64 -0
  68. camel_ai-0.1.3/camel/retrievers/bm25_retriever.py +149 -0
  69. camel_ai-0.1.3/camel/retrievers/vector_retriever.py +166 -0
  70. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/societies/babyagi_playing.py +56 -32
  71. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/societies/role_playing.py +188 -133
  72. camel_ai-0.1.3/camel/storages/__init__.py +41 -0
  73. camel_ai-0.1.3/camel/storages/graph_storages/__init__.py +23 -0
  74. camel_ai-0.1.3/camel/storages/graph_storages/base.py +82 -0
  75. camel_ai-0.1.3/camel/storages/graph_storages/graph_element.py +74 -0
  76. camel_ai-0.1.3/camel/storages/graph_storages/neo4j_graph.py +582 -0
  77. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/storages/key_value_storages/base.py +1 -2
  78. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/storages/key_value_storages/in_memory.py +1 -2
  79. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/storages/key_value_storages/json.py +8 -13
  80. {camel_ai-0.1.1/camel → camel_ai-0.1.3/camel/storages/vectordb_storages}/__init__.py +16 -13
  81. camel_ai-0.1.3/camel/storages/vectordb_storages/base.py +202 -0
  82. camel_ai-0.1.3/camel/storages/vectordb_storages/milvus.py +396 -0
  83. camel_ai-0.1.3/camel/storages/vectordb_storages/qdrant.py +371 -0
  84. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/terminators/__init__.py +1 -1
  85. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/terminators/base.py +2 -3
  86. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/terminators/response_terminator.py +21 -12
  87. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/terminators/token_limit_terminator.py +5 -3
  88. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/types/__init__.py +12 -6
  89. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/types/enums.py +86 -13
  90. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/types/openai_types.py +10 -5
  91. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/utils/__init__.py +18 -13
  92. camel_ai-0.1.3/camel/utils/commons.py +404 -0
  93. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/utils/token_counting.py +135 -15
  94. {camel_ai-0.1.1 → camel_ai-0.1.3}/pyproject.toml +97 -16
  95. camel_ai-0.1.1/camel/agents/embodied_agent.py +0 -138
  96. camel_ai-0.1.1/camel/functions/openai_function.py +0 -88
  97. camel_ai-0.1.1/camel/memories/base.py +0 -75
  98. camel_ai-0.1.1/camel/memories/context_creators/base.py +0 -72
  99. camel_ai-0.1.1/camel/utils/commons.py +0 -243
  100. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/__init__.py +5 -5
  101. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/base.py +0 -0
  102. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/agents/tool_agents/__init__.py +0 -0
  103. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/messages/__init__.py +2 -2
  104. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/responses/__init__.py +0 -0
  105. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/societies/__init__.py +1 -1
  106. {camel_ai-0.1.1 → camel_ai-0.1.3}/camel/storages/key_value_storages/__init__.py +0 -0
{camel_ai-0.1.1 → camel_ai-0.1.3}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: camel-ai
3
- Version: 0.1.1
3
+ Version: 0.1.3
4
4
  Summary: Communicative Agents for AI Society Study
5
5
  Home-page: https://www.camel-ai.org/
6
6
  License: Apache-2.0
@@ -13,74 +13,71 @@ Classifier: Programming Language :: Python :: 3.9
13
13
  Classifier: Programming Language :: Python :: 3.10
14
14
  Classifier: Programming Language :: Python :: 3.11
15
15
  Provides-Extra: all
16
+ Provides-Extra: encoders
17
+ Provides-Extra: graph-storages
16
18
  Provides-Extra: huggingface-agent
19
+ Provides-Extra: retrievers
17
20
  Provides-Extra: test
18
21
  Provides-Extra: tools
22
+ Provides-Extra: vector-databases
19
23
  Requires-Dist: PyMuPDF (>=1.22.5,<2.0.0) ; extra == "tools" or extra == "all"
20
24
  Requires-Dist: accelerate (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
21
- Requires-Dist: argilla (>=1.19.0,<2.0.0) ; extra == "tools" or extra == "all"
25
+ Requires-Dist: anthropic (>=0.21.3,<0.22.0)
22
26
  Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "tools" or extra == "all"
23
27
  Requires-Dist: colorama (>=0,<1)
24
28
  Requires-Dist: datasets (>=2,<3) ; extra == "huggingface-agent" or extra == "all"
25
29
  Requires-Dist: diffusers (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
30
+ Requires-Dist: docstring-parser (>=0.15,<0.16)
26
31
  Requires-Dist: docx2txt (>=0.8,<0.9) ; extra == "tools" or extra == "all"
32
+ Requires-Dist: googlemaps (>=4.10.0,<5.0.0) ; extra == "tools" or extra == "all"
27
33
  Requires-Dist: jsonschema (>=4,<5)
28
34
  Requires-Dist: mock (>=5,<6) ; extra == "test"
35
+ Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "graph-storages" or extra == "all"
29
36
  Requires-Dist: numpy (>=1,<2)
30
37
  Requires-Dist: openai (>=1.2.3,<2.0.0)
31
38
  Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
39
+ Requires-Dist: pathlib (>=1.0.1,<2.0.0)
32
40
  Requires-Dist: protobuf (>=4,<5)
41
+ Requires-Dist: pydantic (>=1.9,<3)
42
+ Requires-Dist: pymilvus (>=2.4.0,<3.0.0) ; extra == "vector-databases" or extra == "all"
33
43
  Requires-Dist: pyowm (>=3.3.0,<4.0.0) ; extra == "tools" or extra == "all"
34
44
  Requires-Dist: pytest (>=7,<8) ; extra == "test"
45
+ Requires-Dist: qdrant-client (>=1.9.0,<2.0.0) ; extra == "vector-databases" or extra == "all"
46
+ Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0) ; extra == "retrievers" or extra == "all"
47
+ Requires-Dist: requests_oauthlib (>=1.3.1,<2.0.0) ; extra == "tools" or extra == "all"
48
+ Requires-Dist: sentence-transformers (>=2.2.2,<3.0.0) ; extra == "encoders" or extra == "all"
35
49
  Requires-Dist: sentencepiece (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
36
50
  Requires-Dist: soundfile (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
37
51
  Requires-Dist: tiktoken (>=0,<1)
38
52
  Requires-Dist: torch (>=1,<2) ; extra == "huggingface-agent" or extra == "all"
39
53
  Requires-Dist: transformers (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
40
- Requires-Dist: unstructured (>=0.10.30,<0.11.0) ; extra == "tools" or extra == "all"
54
+ Requires-Dist: unstructured[all-docs] (>=0.10.30,<0.11.0) ; extra == "tools" or extra == "all"
41
55
  Requires-Dist: wikipedia (>=1,<2) ; extra == "tools" or extra == "all"
56
+ Requires-Dist: wolframalpha (>=5.0.0,<6.0.0) ; extra == "tools" or extra == "all"
42
57
  Project-URL: Documentation, https://docs.camel-ai.org
43
58
  Project-URL: Repository, https://github.com/camel-ai/camel
44
59
  Description-Content-Type: text/markdown
45
60
 
46
- <div style="left">
47
- <a href="https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing" target="_blank">
48
- <img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />
49
- </a>
50
- <a href="https://huggingface.co/camel-ai" target="_blank">
51
- <img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white" />
52
- </a>
53
- <a href="https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA" target="_blank">
54
- <img alt="Slack" src="https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack" />
55
- </a>
56
- <a href="https://discord.gg/CNcNpquyDc" target="_blank">
57
- <img alt="Discord" src="https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da" />
58
- </a>
59
- <a href="https://ghli.org/camel/wechat.png" target="_blank">
60
- <img alt="Discord" src="https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white" />
61
- </a>
62
- <a href="https://twitter.com/CamelAIOrg" target="_blank">
63
- <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter" />
64
- </a>
65
- </div>
66
-
67
- # CAMEL: Communicative Agents for “Mind” Exploration of Large Scale Language Model Society
68
-
69
- <div align="center">
70
-
71
- <a>![Python 3.9+](https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg)</a>
72
- <a href="https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml">![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/camel-ai/camel/pytest_package.yml?label=tests&logo=github)</a>
73
- <a href="https://camel-ai.github.io/camel/">
74
- ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/camel-ai/camel/documentation.yaml?label=docs&logo=github)
75
- </a>
76
- <a href="https://github.com/camel-ai/camel/stargazers" target="_blank">
77
- <img alt="GitHub Repo Stars" src="https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen" />
78
- </a>
79
- <a href="https://github.com/camel-ai/camel/blob/master/licenses/LICENSE">![License](https://img.shields.io/github/license/camel-ai/camel?label=license&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMi43NSAyLjc1YS43NS43NSAwIDAwLTEuNSAwVjQuNUg5LjI3NmExLjc1IDEuNzUgMCAwMC0uOTg1LjMwM0w2LjU5NiA1Ljk1N0EuMjUuMjUgMCAwMTYuNDU1IDZIMi4zNTNhLjc1Ljc1IDAgMTAwIDEuNUgzLjkzTC41NjMgMTUuMThhLjc2Mi43NjIgMCAwMC4yMS44OGMuMDguMDY0LjE2MS4xMjUuMzA5LjIyMS4xODYuMTIxLjQ1Mi4yNzguNzkyLjQzMy42OC4zMTEgMS42NjIuNjIgMi44NzYuNjJhNi45MTkgNi45MTkgMCAwMDIuODc2LS42MmMuMzQtLjE1NS42MDYtLjMxMi43OTItLjQzMy4xNS0uMDk3LjIzLS4xNTguMzEtLjIyM2EuNzUuNzUgMCAwMC4yMDktLjg3OEw1LjU2OSA3LjVoLjg4NmMuMzUxIDAgLjY5NC0uMTA2Ljk4NC0uMzAzbDEuNjk2LTEuMTU0QS4yNS4yNSAwIDAxOS4yNzUgNmgxLjk3NXYxNC41SDYuNzYzYS43NS43NSAwIDAwMCAxLjVoMTAuNDc0YS43NS43NSAwIDAwMC0xLjVIMTIuNzVWNmgxLjk3NGMuMDUgMCAuMS4wMTUuMTQuMDQzbDEuNjk3IDEuMTU0Yy4yOS4xOTcuNjMzLjMwMy45ODQuMzAzaC44ODZsLTMuMzY4IDcuNjhhLjc1Ljc1IDAgMDAuMjMuODk2Yy4wMTIuMDA5IDAgMCAuMDAyIDBhMy4xNTQgMy4xNTQgMCAwMC4zMS4yMDZjLjE4NS4xMTIuNDUuMjU2Ljc5LjRhNy4zNDMgNy4zNDMgMCAwMDIuODU1LjU2OCA3LjM0MyA3LjM0MyAwIDAwMi44NTYtLjU2OWMuMzM4LS4xNDMuNjA0LS4yODcuNzktLjM5OWEzLjUgMy41IDAgMDAuMzEtLjIwNi43NS43NSAwIDAwLjIzLS44OTZMMjAuMDcgNy41aDEuNTc4YS43NS43NSAwIDAwMC0xLjVoLTQuMTAyYS4yNS4yNSAwIDAxLS4xNC0uMDQzbC0xLjY5Ny0xLjE1NGExLjc1IDEuNzUgMCAwMC0uOTg0LS4zMDNIMTIuNzVWMi43NXpNMi4xOTMgMTUuMTk4YTUuNDE4IDUuNDE4IDAgMDAyLjU1Ny42MzUgNS40MTggNS40MTggMCAwMDIuNTU3LS42MzVMNC43NSA5LjM2OGwtMi41NTcgNS44M3ptMTQuNTEtLjAyNGMuMDgyLjA0LjE3NC4wODMuMjc1LjEyNi41My4yMjMgMS4zMDUuNDUgMi4yNzIuNDVhNS44NDYgNS44NDYgMCAwMDIuNTQ3LS41NzZMMTkuMjUgOS4zNjdsLTIuNTQ3IDUuODA3eiI+PC9wYXRoPjwvc3ZnPgo=)</a>
80
- </div>
61
+ [![Colab][colab-image]][colab-url]
62
+ [![Hugging Face][huggingface-image]][huggingface-url]
63
+ [![Slack][slack-image]][slack-url]
64
+ [![Discord][discord-image]][discord-url]
65
+ [![Wechat][wechat-image]][wechat-url]
66
+ [![Twitter][twitter-image]][twitter-url]
67
+
68
+ ______________________________________________________________________
69
+
70
+ # CAMEL: Communicative Agents for “Mind” Exploration of Large Language Model Society
71
+
72
+ [![Python Version][python-image]][python-url]
73
+ [![PyTest Status][pytest-image]][pytest-url]
74
+ [![Documentation][docs-image]][docs-url]
75
+ [![Star][star-image]][star-url]
76
+ [![Package License][package-license-image]][package-license-url]
77
+ [![Data License][data-license-image]][data-license-url]
81
78
 
82
79
  <p align="center">
83
- <a href="https://github.com/camel-ai/camel#community">Community</a> |
80
+ <a href="https://github.com/camel-ai/camel#community">Community</a> |
84
81
  <a href="https://github.com/camel-ai/camel#installation">Installation</a> |
85
82
  <a href="https://camel-ai.github.io/camel/">Documentation</a> |
86
83
  <a href="https://github.com/camel-ai/camel/tree/HEAD/examples">Examples</a> |
@@ -91,7 +88,7 @@ Description-Content-Type: text/markdown
91
88
  </p>
92
89
 
93
90
  <p align="center">
94
- <img src='./misc/logo.png' width=800>
91
+ <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png' width=800>
95
92
  </p>
96
93
 
97
94
  ## Overview
@@ -100,28 +97,46 @@ The rapid advancement of conversational and chat-based language models has led t
100
97
  ## Community
101
98
  🐫 CAMEL is an open-source library designed for the study of autonomous and communicative 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.
102
99
 
103
- Join us ([*Slack*](https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA), [*Discord*](https://discord.gg/CNcNpquyDc) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of building AI Societiy.
100
+ Join us ([*Slack*](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ), [*Discord*](https://discord.gg/CNcNpquyDc) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of building AI Society.
104
101
 
105
102
  ## Try it yourself
106
103
  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.
107
104
 
108
105
  <p align="center">
109
- <img src='./misc/framework.png' width=800>
106
+ <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/framework.png' width=800>
110
107
  </p>
111
108
 
112
- ## Documentation
109
+ ## Installation
113
110
 
114
- [CAMEL package documentation pages](https://camel-ai.github.io/camel/)
111
+ ### From PyPI
115
112
 
116
- ## Installation
113
+ To install the base CAMEL library:
114
+ ```bash
115
+ pip install camel-ai
116
+ ```
117
+ Some features require extra dependencies:
118
+ - To use the HuggingFace agents:
119
+ ```bash
120
+ pip install 'camel-ai[huggingface-agent]'
121
+ ```
122
+ - To enable RAG or use agent memory:
123
+ ```bash
124
+ pip install 'camel-ai[tools]'
125
+ ```
126
+ - To install with all dependencies:
127
+ ```bash
128
+ pip install 'camel-ai[all]'
129
+ ```
130
+
131
+ ### From Source
117
132
 
118
133
  Install `CAMEL` from source with poetry (Recommended):
119
134
  ```sh
135
+ # Make sure your python version is later than 3.9
136
+ # You can use pyenv to manage multiple python verisons in your sytstem
137
+
120
138
  # Clone github repo
121
- # For the latest code:
122
139
  git clone https://github.com/camel-ai/camel.git
123
- # Or for the stable code:
124
- git clone -b v0.1.0 https://github.com/camel-ai/camel.git
125
140
 
126
141
  # Change directory into project directory
127
142
  cd camel
@@ -133,10 +148,8 @@ poetry shell
133
148
  # It takes about 90 seconds to resolve dependencies
134
149
  poetry install
135
150
 
136
- # Or if you want to use "huggingface agent"
137
- poetry install -E huggingface-agent # (Optional)
138
-
139
- # do something with camel
151
+ # Or if you want to use all other extra packages
152
+ poetry install -E all # (Optional)
140
153
 
141
154
  # Exit the virtual environment
142
155
  exit
@@ -151,7 +164,7 @@ conda create --name camel python=3.10
151
164
  conda activate camel
152
165
 
153
166
  # Clone github repo
154
- git clone -b v0.1.0 https://github.com/camel-ai/camel.git
167
+ git clone -b v0.1.3 https://github.com/camel-ai/camel.git
155
168
 
156
169
  # Change directory into project directory
157
170
  cd camel
@@ -159,13 +172,19 @@ cd camel
159
172
  # Install camel from source
160
173
  pip install -e .
161
174
 
162
- # Or if you want to use "huggingface agent"
163
- pip install -e .[huggingface-agent] # (Optional)
175
+ # Or if you want to use all other extra packages
176
+ pip install -e .[all] # (Optional)
164
177
  ```
178
+
179
+ ## Documentation
180
+
181
+ [CAMEL package documentation pages](https://camel-ai.github.io/camel/).
182
+
165
183
  ## Example
166
- You can find a list of tasks for different set of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link)
167
184
 
168
- Run the `role_playing.py` script
185
+ You can find a list of tasks for different sets of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link).
186
+
187
+ As an example, to run the `role_playing.py` script:
169
188
 
170
189
  First, you need to add your OpenAI API key to system environment variables. The method to do this depends on your operating system and the shell you're using.
171
190
 
@@ -191,7 +210,6 @@ set OPENAI_API_BASE_URL=<inert your OpenAI API BASE URL> #(Should you utilize a
191
210
  # Export your OpenAI API key
192
211
  $env:OPENAI_API_KEY="<insert your OpenAI API key>"
193
212
  $env:OPENAI_API_BASE_URL="<inert your OpenAI API BASE URL>" #(Should you utilize an OpenAI proxy service, kindly specify this)
194
-
195
213
  ```
196
214
 
197
215
  Replace `<insert your OpenAI API key>` with your actual OpenAI API key in each case. Make sure there are no spaces around the `=` sign.
@@ -208,7 +226,7 @@ Please note that the environment variable is session-specific. If you open a new
208
226
 
209
227
  ## Use Open-Source Models as Backends
210
228
 
211
- The basic workflow of using an open-sourced model as the backend is based on an external server running LLM inference service, e.g. during the development we chose [FastChat](https://github.com/lm-sys/FastChat) to run the service.
229
+ The basic workflow of using an open-sourced model as the backend is based on an external server running LLM inference service, e.g. during the development we chose [FastChat](https://github.com/lm-sys/FastChat) to run the service.
212
230
 
213
231
  We do not fix the choice of server to decouple the implementation of any specific LLM inference server with CAMEL (indicating the server needs to be deployed by the user himself). But the server to be deployed must satisfy that **it supports OpenAI-compatible APIs, especially the method `openai.ChatCompletion.create`**.
214
232
 
@@ -227,7 +245,7 @@ python3 -m fastchat.serve.model_worker --model-path meta-llama/Llama-2-7b-chat-h
227
245
  python3 -m fastchat.serve.openai_api_server --host localhost --port 8000
228
246
  ```
229
247
 
230
- 2. After observing the controller successfully receiving the heart beat signal from the worker, the server should be ready for use at http://localhost:8000/v1.
248
+ 2. After observing the controller successfully receiving the heart beat signal from the worker, the server should be ready for use at http://localhost:8000/v1.
231
249
 
232
250
  3. Then we can try on running `role_playing_with_open_source_model.py`, where each agent in this example is initialized with specifying the `model_path` and `server_url`, similar to the example code below:
233
251
 
@@ -256,21 +274,21 @@ agent = ChatAgent(
256
274
  - example: [lmsys/vicuna-7b-v1.5](https://huggingface.co/lmsys/vicuna-7b-v1.5)
257
275
 
258
276
  ## Data (Hosted on Hugging Face)
259
- | Dataset | Chat format | Instruction format | Chat format (translated) |
260
- | -- | -- | -- | -- |
277
+ | Dataset | Chat format | Instruction format | Chat format (translated) |
278
+ |----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
261
279
  | **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) |
262
- | **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 |
263
- | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x|
264
- | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
265
- | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
266
- | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
280
+ | **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 |
281
+ | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x |
282
+ | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
283
+ | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
284
+ | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
267
285
 
268
286
  ## Visualizations of Instructions and Tasks
269
287
 
270
- | Dataset | Instructions | Tasks |
271
- | -- | -- | -- |
272
- | **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) |
273
- | **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) |
288
+ | Dataset | Instructions | Tasks |
289
+ |------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
290
+ | **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) |
291
+ | **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) |
274
292
  | **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) |
275
293
 
276
294
  ## Implemented Research Ideas from Other Works
@@ -293,12 +311,10 @@ We implemented amazing research ideas from other works for you to build, compare
293
311
  ## Acknowledgement
294
312
  Special thanks to [Nomic AI](https://home.nomic.ai/) for giving us extended access to their data set exploration tool (Atlas).
295
313
 
296
- We would also like to thank Haya Hammoud for designing the logo of our project.
314
+ We would also like to thank Haya Hammoud for designing the initial logo of our project.
297
315
 
298
316
  ## License
299
317
 
300
- The intended purpose and licensing of CAMEL is solely for research use.
301
-
302
318
  The source code is licensed under Apache 2.0.
303
319
 
304
320
  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.
@@ -309,3 +325,29 @@ We appreciate your interest in contributing to our open-source initiative. We pr
309
325
  ## Contact
310
326
  For more information please contact camel.ai.team@gmail.com.
311
327
 
328
+ [python-image]: https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg
329
+ [python-url]: https://docs.python.org/3.9/
330
+ [pytest-image]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml/badge.svg
331
+ [pytest-url]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml
332
+ [docs-image]: https://img.shields.io/badge/Documentation-grey.svg?logo=github
333
+ [docs-url]: https://camel-ai.github.io/camel/index.html
334
+ [star-image]: https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen
335
+ [star-url]: https://github.com/camel-ai/camel/stargazers
336
+ [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
337
+ [package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE
338
+ [data-license-image]: https://img.shields.io/badge/License-CC_BY--NC_4.0-lightgrey.svg
339
+ [data-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/DATA_LICENSE
340
+
341
+ [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
342
+ [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
343
+ [huggingface-url]: https://huggingface.co/camel-ai
344
+ [huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white
345
+ [slack-url]: https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ
346
+ [slack-image]: https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack
347
+ [discord-url]: https://discord.gg/CNcNpquyDc
348
+ [discord-image]: https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da
349
+ [wechat-url]: https://ghli.org/camel/wechat.png
350
+ [wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white
351
+ [twitter-url]: https://twitter.com/CamelAIOrg
352
+ [twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter
353
+
{camel_ai-0.1.1 → camel_ai-0.1.3}/README.md RENAMED
@@ -1,41 +1,23 @@
1
- <div style="left">
2
- <a href="https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing" target="_blank">
3
- <img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />
4
- </a>
5
- <a href="https://huggingface.co/camel-ai" target="_blank">
6
- <img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white" />
7
- </a>
8
- <a href="https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA" target="_blank">
9
- <img alt="Slack" src="https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack" />
10
- </a>
11
- <a href="https://discord.gg/CNcNpquyDc" target="_blank">
12
- <img alt="Discord" src="https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da" />
13
- </a>
14
- <a href="https://ghli.org/camel/wechat.png" target="_blank">
15
- <img alt="Discord" src="https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white" />
16
- </a>
17
- <a href="https://twitter.com/CamelAIOrg" target="_blank">
18
- <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter" />
19
- </a>
20
- </div>
21
-
22
- # CAMEL: Communicative Agents for “Mind” Exploration of Large Scale Language Model Society
23
-
24
- <div align="center">
25
-
26
- <a>![Python 3.9+](https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg)</a>
27
- <a href="https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml">![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/camel-ai/camel/pytest_package.yml?label=tests&logo=github)</a>
28
- <a href="https://camel-ai.github.io/camel/">
29
- ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/camel-ai/camel/documentation.yaml?label=docs&logo=github)
30
- </a>
31
- <a href="https://github.com/camel-ai/camel/stargazers" target="_blank">
32
- <img alt="GitHub Repo Stars" src="https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen" />
33
- </a>
34
- <a href="https://github.com/camel-ai/camel/blob/master/licenses/LICENSE">![License](https://img.shields.io/github/license/camel-ai/camel?label=license&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMi43NSAyLjc1YS43NS43NSAwIDAwLTEuNSAwVjQuNUg5LjI3NmExLjc1IDEuNzUgMCAwMC0uOTg1LjMwM0w2LjU5NiA1Ljk1N0EuMjUuMjUgMCAwMTYuNDU1IDZIMi4zNTNhLjc1Ljc1IDAgMTAwIDEuNUgzLjkzTC41NjMgMTUuMThhLjc2Mi43NjIgMCAwMC4yMS44OGMuMDguMDY0LjE2MS4xMjUuMzA5LjIyMS4xODYuMTIxLjQ1Mi4yNzguNzkyLjQzMy42OC4zMTEgMS42NjIuNjIgMi44NzYuNjJhNi45MTkgNi45MTkgMCAwMDIuODc2LS42MmMuMzQtLjE1NS42MDYtLjMxMi43OTItLjQzMy4xNS0uMDk3LjIzLS4xNTguMzEtLjIyM2EuNzUuNzUgMCAwMC4yMDktLjg3OEw1LjU2OSA3LjVoLjg4NmMuMzUxIDAgLjY5NC0uMTA2Ljk4NC0uMzAzbDEuNjk2LTEuMTU0QS4yNS4yNSAwIDAxOS4yNzUgNmgxLjk3NXYxNC41SDYuNzYzYS43NS43NSAwIDAwMCAxLjVoMTAuNDc0YS43NS43NSAwIDAwMC0xLjVIMTIuNzVWNmgxLjk3NGMuMDUgMCAuMS4wMTUuMTQuMDQzbDEuNjk3IDEuMTU0Yy4yOS4xOTcuNjMzLjMwMy45ODQuMzAzaC44ODZsLTMuMzY4IDcuNjhhLjc1Ljc1IDAgMDAuMjMuODk2Yy4wMTIuMDA5IDAgMCAuMDAyIDBhMy4xNTQgMy4xNTQgMCAwMC4zMS4yMDZjLjE4NS4xMTIuNDUuMjU2Ljc5LjRhNy4zNDMgNy4zNDMgMCAwMDIuODU1LjU2OCA3LjM0MyA3LjM0MyAwIDAwMi44NTYtLjU2OWMuMzM4LS4xNDMuNjA0LS4yODcuNzktLjM5OWEzLjUgMy41IDAgMDAuMzEtLjIwNi43NS43NSAwIDAwLjIzLS44OTZMMjAuMDcgNy41aDEuNTc4YS43NS43NSAwIDAwMC0xLjVoLTQuMTAyYS4yNS4yNSAwIDAxLS4xNC0uMDQzbC0xLjY5Ny0xLjE1NGExLjc1IDEuNzUgMCAwMC0uOTg0LS4zMDNIMTIuNzVWMi43NXpNMi4xOTMgMTUuMTk4YTUuNDE4IDUuNDE4IDAgMDAyLjU1Ny42MzUgNS40MTggNS40MTggMCAwMDIuNTU3LS42MzVMNC43NSA5LjM2OGwtMi41NTcgNS44M3ptMTQuNTEtLjAyNGMuMDgyLjA0LjE3NC4wODMuMjc1LjEyNi41My4yMjMgMS4zMDUuNDUgMi4yNzIuNDVhNS44NDYgNS44NDYgMCAwMDIuNTQ3LS41NzZMMTkuMjUgOS4zNjdsLTIuNTQ3IDUuODA3eiI+PC9wYXRoPjwvc3ZnPgo=)</a>
35
- </div>
1
+ [![Colab][colab-image]][colab-url]
2
+ [![Hugging Face][huggingface-image]][huggingface-url]
3
+ [![Slack][slack-image]][slack-url]
4
+ [![Discord][discord-image]][discord-url]
5
+ [![Wechat][wechat-image]][wechat-url]
6
+ [![Twitter][twitter-image]][twitter-url]
7
+
8
+ ______________________________________________________________________
9
+
10
+ # CAMEL: Communicative Agents for “Mind” Exploration of Large Language Model Society
11
+
12
+ [![Python Version][python-image]][python-url]
13
+ [![PyTest Status][pytest-image]][pytest-url]
14
+ [![Documentation][docs-image]][docs-url]
15
+ [![Star][star-image]][star-url]
16
+ [![Package License][package-license-image]][package-license-url]
17
+ [![Data License][data-license-image]][data-license-url]
36
18
 
37
19
  <p align="center">
38
- <a href="https://github.com/camel-ai/camel#community">Community</a> |
20
+ <a href="https://github.com/camel-ai/camel#community">Community</a> |
39
21
  <a href="https://github.com/camel-ai/camel#installation">Installation</a> |
40
22
  <a href="https://camel-ai.github.io/camel/">Documentation</a> |
41
23
  <a href="https://github.com/camel-ai/camel/tree/HEAD/examples">Examples</a> |
@@ -46,7 +28,7 @@
46
28
  </p>
47
29
 
48
30
  <p align="center">
49
- <img src='./misc/logo.png' width=800>
31
+ <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png' width=800>
50
32
  </p>
51
33
 
52
34
  ## Overview
@@ -55,28 +37,46 @@ The rapid advancement of conversational and chat-based language models has led t
55
37
  ## Community
56
38
  🐫 CAMEL is an open-source library designed for the study of autonomous and communicative 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.
57
39
 
58
- Join us ([*Slack*](https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA), [*Discord*](https://discord.gg/CNcNpquyDc) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of building AI Societiy.
40
+ Join us ([*Slack*](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ), [*Discord*](https://discord.gg/CNcNpquyDc) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of building AI Society.
59
41
 
60
42
  ## Try it yourself
61
43
  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.
62
44
 
63
45
  <p align="center">
64
- <img src='./misc/framework.png' width=800>
46
+ <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/framework.png' width=800>
65
47
  </p>
66
48
 
67
- ## Documentation
49
+ ## Installation
68
50
 
69
- [CAMEL package documentation pages](https://camel-ai.github.io/camel/)
51
+ ### From PyPI
70
52
 
71
- ## Installation
53
+ To install the base CAMEL library:
54
+ ```bash
55
+ pip install camel-ai
56
+ ```
57
+ Some features require extra dependencies:
58
+ - To use the HuggingFace agents:
59
+ ```bash
60
+ pip install 'camel-ai[huggingface-agent]'
61
+ ```
62
+ - To enable RAG or use agent memory:
63
+ ```bash
64
+ pip install 'camel-ai[tools]'
65
+ ```
66
+ - To install with all dependencies:
67
+ ```bash
68
+ pip install 'camel-ai[all]'
69
+ ```
70
+
71
+ ### From Source
72
72
 
73
73
  Install `CAMEL` from source with poetry (Recommended):
74
74
  ```sh
75
+ # Make sure your python version is later than 3.9
76
+ # You can use pyenv to manage multiple python verisons in your sytstem
77
+
75
78
  # Clone github repo
76
- # For the latest code:
77
79
  git clone https://github.com/camel-ai/camel.git
78
- # Or for the stable code:
79
- git clone -b v0.1.0 https://github.com/camel-ai/camel.git
80
80
 
81
81
  # Change directory into project directory
82
82
  cd camel
@@ -88,10 +88,8 @@ poetry shell
88
88
  # It takes about 90 seconds to resolve dependencies
89
89
  poetry install
90
90
 
91
- # Or if you want to use "huggingface agent"
92
- poetry install -E huggingface-agent # (Optional)
93
-
94
- # do something with camel
91
+ # Or if you want to use all other extra packages
92
+ poetry install -E all # (Optional)
95
93
 
96
94
  # Exit the virtual environment
97
95
  exit
@@ -106,7 +104,7 @@ conda create --name camel python=3.10
106
104
  conda activate camel
107
105
 
108
106
  # Clone github repo
109
- git clone -b v0.1.0 https://github.com/camel-ai/camel.git
107
+ git clone -b v0.1.3 https://github.com/camel-ai/camel.git
110
108
 
111
109
  # Change directory into project directory
112
110
  cd camel
@@ -114,13 +112,19 @@ cd camel
114
112
  # Install camel from source
115
113
  pip install -e .
116
114
 
117
- # Or if you want to use "huggingface agent"
118
- pip install -e .[huggingface-agent] # (Optional)
115
+ # Or if you want to use all other extra packages
116
+ pip install -e .[all] # (Optional)
119
117
  ```
118
+
119
+ ## Documentation
120
+
121
+ [CAMEL package documentation pages](https://camel-ai.github.io/camel/).
122
+
120
123
  ## Example
121
- You can find a list of tasks for different set of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link)
122
124
 
123
- Run the `role_playing.py` script
125
+ You can find a list of tasks for different sets of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link).
126
+
127
+ As an example, to run the `role_playing.py` script:
124
128
 
125
129
  First, you need to add your OpenAI API key to system environment variables. The method to do this depends on your operating system and the shell you're using.
126
130
 
@@ -146,7 +150,6 @@ set OPENAI_API_BASE_URL=<inert your OpenAI API BASE URL> #(Should you utilize a
146
150
  # Export your OpenAI API key
147
151
  $env:OPENAI_API_KEY="<insert your OpenAI API key>"
148
152
  $env:OPENAI_API_BASE_URL="<inert your OpenAI API BASE URL>" #(Should you utilize an OpenAI proxy service, kindly specify this)
149
-
150
153
  ```
151
154
 
152
155
  Replace `<insert your OpenAI API key>` with your actual OpenAI API key in each case. Make sure there are no spaces around the `=` sign.
@@ -163,7 +166,7 @@ Please note that the environment variable is session-specific. If you open a new
163
166
 
164
167
  ## Use Open-Source Models as Backends
165
168
 
166
- The basic workflow of using an open-sourced model as the backend is based on an external server running LLM inference service, e.g. during the development we chose [FastChat](https://github.com/lm-sys/FastChat) to run the service.
169
+ The basic workflow of using an open-sourced model as the backend is based on an external server running LLM inference service, e.g. during the development we chose [FastChat](https://github.com/lm-sys/FastChat) to run the service.
167
170
 
168
171
  We do not fix the choice of server to decouple the implementation of any specific LLM inference server with CAMEL (indicating the server needs to be deployed by the user himself). But the server to be deployed must satisfy that **it supports OpenAI-compatible APIs, especially the method `openai.ChatCompletion.create`**.
169
172
 
@@ -182,7 +185,7 @@ python3 -m fastchat.serve.model_worker --model-path meta-llama/Llama-2-7b-chat-h
182
185
  python3 -m fastchat.serve.openai_api_server --host localhost --port 8000
183
186
  ```
184
187
 
185
- 2. After observing the controller successfully receiving the heart beat signal from the worker, the server should be ready for use at http://localhost:8000/v1.
188
+ 2. After observing the controller successfully receiving the heart beat signal from the worker, the server should be ready for use at http://localhost:8000/v1.
186
189
 
187
190
  3. Then we can try on running `role_playing_with_open_source_model.py`, where each agent in this example is initialized with specifying the `model_path` and `server_url`, similar to the example code below:
188
191
 
@@ -211,21 +214,21 @@ agent = ChatAgent(
211
214
  - example: [lmsys/vicuna-7b-v1.5](https://huggingface.co/lmsys/vicuna-7b-v1.5)
212
215
 
213
216
  ## Data (Hosted on Hugging Face)
214
- | Dataset | Chat format | Instruction format | Chat format (translated) |
215
- | -- | -- | -- | -- |
217
+ | Dataset | Chat format | Instruction format | Chat format (translated) |
218
+ |----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
216
219
  | **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) |
217
- | **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 |
218
- | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x|
219
- | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
220
- | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
221
- | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
220
+ | **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 |
221
+ | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x |
222
+ | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
223
+ | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
224
+ | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
222
225
 
223
226
  ## Visualizations of Instructions and Tasks
224
227
 
225
- | Dataset | Instructions | Tasks |
226
- | -- | -- | -- |
227
- | **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) |
228
- | **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) |
228
+ | Dataset | Instructions | Tasks |
229
+ |------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
230
+ | **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) |
231
+ | **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) |
229
232
  | **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) |
230
233
 
231
234
  ## Implemented Research Ideas from Other Works
@@ -248,12 +251,10 @@ We implemented amazing research ideas from other works for you to build, compare
248
251
  ## Acknowledgement
249
252
  Special thanks to [Nomic AI](https://home.nomic.ai/) for giving us extended access to their data set exploration tool (Atlas).
250
253
 
251
- We would also like to thank Haya Hammoud for designing the logo of our project.
254
+ We would also like to thank Haya Hammoud for designing the initial logo of our project.
252
255
 
253
256
  ## License
254
257
 
255
- The intended purpose and licensing of CAMEL is solely for research use.
256
-
257
258
  The source code is licensed under Apache 2.0.
258
259
 
259
260
  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.
@@ -263,3 +264,29 @@ We appreciate your interest in contributing to our open-source initiative. We pr
263
264
 
264
265
  ## Contact
265
266
  For more information please contact camel.ai.team@gmail.com.
267
+
268
+ [python-image]: https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg
269
+ [python-url]: https://docs.python.org/3.9/
270
+ [pytest-image]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml/badge.svg
271
+ [pytest-url]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml
272
+ [docs-image]: https://img.shields.io/badge/Documentation-grey.svg?logo=github
273
+ [docs-url]: https://camel-ai.github.io/camel/index.html
274
+ [star-image]: https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen
275
+ [star-url]: https://github.com/camel-ai/camel/stargazers
276
+ [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
277
+ [package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE
278
+ [data-license-image]: https://img.shields.io/badge/License-CC_BY--NC_4.0-lightgrey.svg
279
+ [data-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/DATA_LICENSE
280
+
281
+ [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
282
+ [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
283
+ [huggingface-url]: https://huggingface.co/camel-ai
284
+ [huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white
285
+ [slack-url]: https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ
286
+ [slack-image]: https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack
287
+ [discord-url]: https://discord.gg/CNcNpquyDc
288
+ [discord-image]: https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da
289
+ [wechat-url]: https://ghli.org/camel/wechat.png
290
+ [wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white
291
+ [twitter-url]: https://twitter.com/CamelAIOrg
292
+ [twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter