chore: update contribution guideline and poetry toml (#992)

Author: Wendong-Fan

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 🐫 **Welcome to CAMEL!** 🐫
 
-Thank you for your interest in contributing to the CAMEL project! 🎉 We're excited to have your support. As an open-source initiative in a rapidly evolving and open-ended field, we wholeheartedly welcome contributions of all kinds. Whether you want to introduce new features, enhance the infrastructure, improve documentation, asking issues, add more examples, implement state-of-the-art research ideas, or fix bugs, we appreciate your enthusiasm and efforts. 🙌  You are welcome to join our [slack](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ) for more efficient communication. 💬
+Thank you for your interest in contributing to the CAMEL project! 🎉 We're excited to have your support. As an open-source initiative in a rapidly evolving and open-ended field, we wholeheartedly welcome contributions of all kinds. Whether you want to introduce new features, enhance the infrastructure, improve documentation, asking issues, add more examples, implement state-of-the-art research ideas, or fix bugs, we appreciate your enthusiasm and efforts. 🙌  You are welcome to join our [discord](https://discord.gg/eNsRwtnT) for more efficient communication. 💬
 
 ## Join Our Community 🌍
 
@@ -9,13 +9,13 @@ Thank you for your interest in contributing to the CAMEL project! 🎉 We're exc
 - Chinese speakers: [here](https://calendly.com/sisi-qu/welcome-to-camel-onboarding-meeting?month=2024-05)
 
 ### Developer Meeting Time & Link 💻
-- English speakers: Mondays at 5 PM GMT+1. Join via Zoom: [Meeting Link](https://kaust.zoom.us/j/91735108083)
+- English speakers: Mondays at 5 PM GMT+1. Join via Discord: [Meeting Link](https://discord.gg/aWfgSTh5?event=1288737688794435634)
 - Chinese Speakers: Mondays at 9 PM UTC+8. Join via Zoom: [Meeting Link](https://kaust.zoom.us/j/94271505221)
 
 ### Our Communication Channels 💬
-- **Slack:** [Join here](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ)
 - **Discord:** [Join here](https://discord.gg/CNcNpquyDc)
 - **WeChat:** Scan the QR code [here](https://ghli.org/camel/wechat.png)
+- **Slack:** [Join here](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ)
 
 ## Guidelines 📝
 
@@ -161,10 +161,6 @@ cd camel
 poetry shell
 
 # Install camel from source
-# It takes about 75s to resolve dependencies and 10s to install them, depending on your hardware and network
-poetry install --with dev,docs
-
-# Or if you want to use all other extra packages
 poetry install --with dev,docs -E all  # (Suggested for developers, needed to pass all tests)
 
 # The following command installs a pre-commit hook into the local git repo,
@@ -185,6 +181,9 @@ These commands will install all the necessary dependencies for running the packa
 
 To verify that everything is set up correctly, run `pytest .` This will ensure that all tests pass successfully. ✅
 
+> [!TIP]
+> You need to config different API Keys as environment variables to pass all tests.
+
 ## Common Actions 🔄
 
 ### Update dependencies

camel/agents/chat_agent.py

@@ -426,7 +426,7 @@ def step(
             or isinstance(self.model_type, str)
             and "lama" in self.model_type
         ):
-            if self.model_backend.model_config_dict['tools']:
+            if self.model_backend.model_config_dict.get("tools", None):
                 tool_prompt = self._generate_tool_prompt(self.tool_schema_list)
 
                 tool_sys_msg = BaseMessage.make_assistant_message(

docs/cookbooks/create_your_first_agent.ipynb

@@ -20,6 +20,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {
     "id": "wFlfaGrjVAUy"
@@ -34,10 +35,15 @@
     "> Can we design an autonomous communicative agent capable of steering the conversation toward task completion with minimal human supervision?\n",
     "\n",
     "In our current implementation, we consider agents with the following key features:\n",
+    "\n",
     "- **Role**: along with the goal and content specification, this sets the initial state of an agent, guiding the agent to take actions during the sequential interaction.\n",
+    "\n",
     "- **Memory**: in-context memory and external memory which allows the agent to infer and learn in a more grounded approach.\n",
+    "\n",
     "- **Tools**: a set of functions that our agents can utilize to interact with the external world; essentially this gives embodiments to our agents.\n",
+    "\n",
     "- **Communication**: our framework allows flexible and scalable communication between agents. This is fundamental for the critical research question.\n",
+    "\n",
     "- **Reasoning**: we will equip agents with different planning and reward (critic) learning abilities, allowing them to optimize task completion in a more guided approach."
    ]
   },
@@ -367,22 +373,49 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {
     "id": "OY657qftWXtI"
    },
    "source": [
     "### Miscs\n",
     "\n",
-    "- Setting the agent to its initial state.\n",
-    "    ```python\n",
-    "    agent.reset()\n",
-    "    ```\n",
-    "- Set the output language for the agent.\n",
-    "    ```python\n",
-    "    agent.set_output_language('french')\n",
-    "    ```\n",
-    "- The `ChatAgent` class offers several useful initialization options, including `model_type`, `model_config`, `memory`, `message_window_size`, `token_limit`, `output_language`, `tools`, and `response_terminators`. Check [`chat_agent.py`](https://github.com/camel-ai/camel/blob/master/camel/agents/chat_agent.py) for detailed usage guidance."
+    "- Setting the agent to its initial state."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent.reset()"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- Set the output language for the agent."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent.set_output_language('french')"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- The `ChatAgent` class offers several useful initialization options, including `model_type`, `model_config`, `memory`, `message_window_size`, `token_limit`, `output_language`, `tools`, and `response_terminators`. Check [chat_agent.py](https://github.com/camel-ai/camel/blob/master/camel/agents/chat_agent.py) for detailed usage guidance."
    ]
   },
   {

docs/cookbooks/create_your_first_agents_society.ipynb

@@ -20,6 +20,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {
     "id": "wFlfaGrjVAUy"
@@ -34,8 +35,11 @@
     "> -- Marvin Minsky, The Society of Mind, p. 308\n",
     "\n",
     "In this section, we will take a spite of the task-oriented `RolyPlaying()` class. We design this in an instruction-following manner. The essence is that to solve a complex task, you can enable two communicative agents collabratively working together step by step to reach solutions. The main concepts include:\n",
+    "\n",
     "- **Task**: a task can be as simple as an idea, initialized by an inception prompt.\n",
+    "\n",
     "- **AI User**: the agent who is expected to provide instructions.\n",
+    "\n",
     "- **AI Assistant**: the agent who is expected to respond with solutions that fulfills the instructions."
    ]
   },

docs/key_modules/models.md

@@ -49,7 +49,7 @@ The following table lists currently supported model platforms by CAMEL.
 | Together AI | https://docs.together.ai/docs/chat-models | ----- |
 | LiteLLM | https://docs.litellm.ai/docs/providers | ----- |
 
-## 3. Model calling template
+## 3. Model Calling Template
 
 Here is the example code to use a chosen model. To utilize a different model, you can simply change three parameters the define your model to be used: `model_platform`, `model_type`, `model_config_dict` .
 

examples/models/ollama_model_example.py

@@ -19,7 +19,7 @@
 
 ollama_model = ModelFactory.create(
     model_platform=ModelPlatformType.OLLAMA,
-    model_type="mistral",
+    model_type="llama3.2",
     model_config_dict={"temperature": 0.4},
 )
 
@@ -41,11 +41,17 @@
 ===============================================================================
 Ollama server started on http://localhost:11434/v1 for mistral model
 
-Hi there! *waves* Hi to the amazing team at CAMEL AI - Autonomous and 
-Communicative Agents Laboratory! It's great to connect with you all. I'm 
-excited to learn more about your work in developing autonomous and 
-communicative agents, exploring the intersection of artificial intelligence, 
-robotics, and human-computer interaction. Keep pushing the boundaries of 
-what's possible!
+Hello CAMEL AI community!
+
+It's great to connect with such a fascinating group of individuals passionate 
+about autonomous and communicative agents. Your dedication to advancing 
+knowledge in this field is truly commendable.
+
+I'm here to help answer any questions, provide information, or engage in 
+discussions related to AI, machine learning, and autonomous systems. Feel free 
+to ask me anything!
+
+By the way, what topics would you like to explore within the realm of 
+autonomous and communicative agents?
 ===============================================================================
 """

examples/models/role_playing_with_sambanova.py

@@ -39,7 +39,7 @@ def main(
         "and then add 10 more years to this age."
     )
 
-    user_model_config = SambaCloudAPIConfig(temperature=0.2, max_tokens=2200)
+    user_model_config = SambaCloudAPIConfig(temperature=0.2, max_tokens=1800)
 
     tools_list = [
         *MathToolkit().get_tools(),