camel-ai 0.1.5.1__tar.gz → 0.1.5.3__tar.gz

{camel_ai-0.1.5.1 → camel_ai-0.1.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: camel-ai
-Version: 0.1.5.1
+Version: 0.1.5.3
 Summary: Communicative Agents for AI Society Study
 Home-page: https://www.camel-ai.org/
 License: Apache-2.0
@@ -16,37 +16,47 @@ Provides-Extra: all
 Provides-Extra: encoders
 Provides-Extra: graph-storages
 Provides-Extra: huggingface-agent
+Provides-Extra: model-platforms
 Provides-Extra: retrievers
 Provides-Extra: test
 Provides-Extra: tools
 Provides-Extra: vector-databases
 Requires-Dist: PyMuPDF (>=1.22.5,<2.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: accelerate (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
-Requires-Dist: anthropic (>=0.21.3,<0.22.0)
+Requires-Dist: anthropic (>=0.28.0,<0.29.0)
 Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "tools" or extra == "all"
 Requires-Dist: cohere (>=4.56,<5.0) ; extra == "retrievers" or extra == "all"
 Requires-Dist: colorama (>=0,<1)
+Requires-Dist: curl_cffi (==0.6.2)
 Requires-Dist: datasets (>=2,<3) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: diffusers (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
+Requires-Dist: discord.py (>=2.3.2,<3.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: docstring-parser (>=0.15,<0.16)
 Requires-Dist: docx2txt (>=0.8,<0.9) ; extra == "tools" or extra == "all"
+Requires-Dist: duckduckgo-search (>=6.1.0,<7.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: googlemaps (>=4.10.0,<5.0.0) ; extra == "tools" or extra == "all"
+Requires-Dist: imageio (>=2.34.1,<3.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: jsonschema (>=4,<5)
+Requires-Dist: litellm (>=1.38.1,<2.0.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: mock (>=5,<6) ; extra == "test"
 Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "graph-storages" or extra == "all"
+Requires-Dist: newspaper3k (>=0.2.8,<0.3.0) ; extra == "tools" or extra == "all"
 Requires-Dist: numpy (>=1,<2)
 Requires-Dist: openai (>=1.2.3,<2.0.0)
 Requires-Dist: openapi-spec-validator (>=0.7.1,<0.8.0) ; extra == "tools" or extra == "all"
 Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: pathlib (>=1.0.1,<2.0.0)
+Requires-Dist: pillow (>=10.2.0,<11.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: prance (>=23.6.21.0,<24.0.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: protobuf (>=4,<5)
+Requires-Dist: pyTelegramBotAPI (>=4.18.0,<5.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: pydantic (>=1.9,<3)
 Requires-Dist: pydub (>=0.25.1,<0.26.0) ; extra == "tools" or extra == "all"
 Requires-Dist: pygithub (>=2.3.0,<3.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: pymilvus (>=2.4.0,<3.0.0) ; extra == "vector-databases" or extra == "all"
 Requires-Dist: pyowm (>=3.3.0,<4.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: pytest (>=7,<8) ; extra == "test"
+Requires-Dist: pytest-asyncio (>=0.23.0,<0.24.0) ; extra == "test"
 Requires-Dist: qdrant-client (>=1.9.0,<2.0.0) ; extra == "vector-databases" or extra == "all"
 Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0) ; extra == "retrievers" or extra == "all"
 Requires-Dist: requests_oauthlib (>=1.3.1,<2.0.0) ; extra == "tools" or extra == "all"
@@ -121,6 +131,10 @@ To install the base CAMEL library:
 pip install camel-ai
 ```
 Some features require extra dependencies:
+- To install with all dependencies:
+    ```bash
+    pip install 'camel-ai[all]'
+    ```
 - To use the HuggingFace agents:
     ```bash
     pip install 'camel-ai[huggingface-agent]'
@@ -129,10 +143,6 @@ Some features require extra dependencies:
     ```bash
     pip install 'camel-ai[tools]'
     ```
-- To install with all dependencies:
-    ```bash
-    pip install 'camel-ai[all]'
-    ```
 
 ### From Source
 
@@ -147,14 +157,20 @@ git clone https://github.com/camel-ai/camel.git
 # Change directory into project directory
 cd camel
 
-# Activate camel virtual environment
+# If you didn't install peotry before
+pip install poetry  # (Optional)
+
+# We suggest using python 3.10
+poetry env use python3.10  # (Optional)
+
+# Activate CAMEL virtual environment
 poetry shell
 
-# Install camel from source
-# It takes about 90 seconds to resolve dependencies
+# Install the base CAMEL library
+# It takes about 90 seconds
 poetry install
 
-# Or if you want to use all other extra packages
+# Install CAMEL with all dependencies
 poetry install -E all  # (Optional)
 
 # Exit the virtual environment
@@ -166,16 +182,16 @@ Install `CAMEL` from source with conda and pip:
 # Create a conda virtual environment
 conda create --name camel python=3.10
 
-# Activate camel conda environment
+# Activate CAMEL conda environment
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.5.1 https://github.com/camel-ai/camel.git
+git clone -b v0.1.5.3 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel
 
-# Install camel from source
+# Install CAMEL from source
 pip install -e .
 
 # Or if you want to use all other extra packages
@@ -230,54 +246,67 @@ python examples/ai_society/role_playing.py
 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.
 
 
-## Use Open-Source Models as Backends
-
-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.
-
-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`**.
-
-Here are some instructions for enabling open-source backends, where we use the [FastChat](https://github.com/lm-sys/FastChat) and a LLaMA2-based model ([`meta-llama/Llama-2-7b-chat-hf`](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)) in the example. Please install FastChat in advance following their installation guidance.
+## Use Open-Source Models as Backends (ex. using Ollama to set Llama 3 locally)
 
-1. Before running CAMEL, we should firstly launch FastChat server following the guidance on https://github.com/lm-sys/FastChat/blob/main/docs/openai_api.md. The instructions summarized below should be kept running **in separate processes**:
-
-```sh
-# Launch the controller
-python -m fastchat.serve.controller
-
-# Launch the model worker(s)
-python3 -m fastchat.serve.model_worker --model-path meta-llama/Llama-2-7b-chat-hf
-
-# Launch the RESTful API server
-python3 -m fastchat.serve.openai_api_server --host localhost --port 8000
-```
+- Download [Ollama](https://ollama.com/download).
+- After setting up Ollama, pull the Llama3 model by typing the following command into the terminal:
+    ```bash
+    ollama pull llama3
+    ```
+- Create a ModelFile similar the one below in your project directory.
+    ```bash
+    FROM llama3
 
-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.
+    # Set parameters
+    PARAMETER temperature 0.8
+    PARAMETER stop Result
 
-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:
+    # Sets a custom system message to specify the behavior of the chat assistant
 
-```python
-system_message = # ...
+    # Leaving it blank for now.
 
-agent_kwargs = dict(
-    model=model_type,
-    model_config=OpenSourceConfig(
-        model_path="meta-llama/Llama-2-7b-chat-hf",
-        server_url="http://localhost:8000/v1",
-    ),
-)
+    SYSTEM """ """
+    ```
+- Create a script to get the base model (llama3) and create a custom model using the ModelFile above. Save this as a .sh file:
+    ```bash
+    #!/bin/zsh
 
-agent = ChatAgent(
-    system_message,
-    **agent_kwargs,
-)
-```
+    # variables
+    model_name="llama3"
+    custom_model_name="camel-llama3"
 
-### Supported Models
+    #get the base model
+    ollama pull $model_name
 
-- LLaMA2-based models
-  - example: [meta-llama/Llama-2-7b-chat-hf](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)
-- Vicuna-based models
-  - example: [lmsys/vicuna-7b-v1.5](https://huggingface.co/lmsys/vicuna-7b-v1.5)
+    #create the model file
+    ollama create $custom_model_name -f ./Llama3ModelFile
+    ```
+- Navigate to the directory where the script and ModelFile are located and run the script. Enjoy your Llama3 model, enhanced by CAMEL's excellent agents.
+    ```python
+    from camel.agents import ChatAgent
+    from camel.messages import BaseMessage
+    from camel.models import ModelFactory
+    from camel.types import ModelPlatformType
+
+    ollama_model = ModelFactory.create(
+        model_platform=ModelPlatformType.OLLAMA,
+        model_type="llama3",
+        url="http://localhost:11434/v1",
+        model_config_dict={"temperature": 0.4},
+    )
+
+    assistant_sys_msg = BaseMessage.make_assistant_message(
+        role_name="Assistant",
+        content="You are a helpful assistant.",
+    )
+    agent = ChatAgent(assistant_sys_msg, model=ollama_model, token_limit=4096)
+
+    user_msg = BaseMessage.make_user_message(
+        role_name="User", content="Say hi to CAMEL"
+    )
+    assistant_response = agent.step(user_msg)
+    print(assistant_response.msg.content)
+    ```
 
 ## Data (Hosted on Hugging Face)
 | Dataset        | Chat format                                                                                         | Instruction format                                                                                               | Chat format (translated)                                                                   |

{camel_ai-0.1.5.1 → camel_ai-0.1.5.3}/README.md

@@ -55,6 +55,10 @@ To install the base CAMEL library:
 pip install camel-ai
 ```
 Some features require extra dependencies:
+- To install with all dependencies:
+    ```bash
+    pip install 'camel-ai[all]'
+    ```
 - To use the HuggingFace agents:
     ```bash
     pip install 'camel-ai[huggingface-agent]'
@@ -63,10 +67,6 @@ Some features require extra dependencies:
     ```bash
     pip install 'camel-ai[tools]'
     ```
-- To install with all dependencies:
-    ```bash
-    pip install 'camel-ai[all]'
-    ```
 
 ### From Source
 
@@ -81,14 +81,20 @@ git clone https://github.com/camel-ai/camel.git
 # Change directory into project directory
 cd camel
 
-# Activate camel virtual environment
+# If you didn't install peotry before
+pip install poetry  # (Optional)
+
+# We suggest using python 3.10
+poetry env use python3.10  # (Optional)
+
+# Activate CAMEL virtual environment
 poetry shell
 
-# Install camel from source
-# It takes about 90 seconds to resolve dependencies
+# Install the base CAMEL library
+# It takes about 90 seconds
 poetry install
 
-# Or if you want to use all other extra packages
+# Install CAMEL with all dependencies
 poetry install -E all  # (Optional)
 
 # Exit the virtual environment
@@ -100,16 +106,16 @@ Install `CAMEL` from source with conda and pip:
 # Create a conda virtual environment
 conda create --name camel python=3.10
 
-# Activate camel conda environment
+# Activate CAMEL conda environment
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.5.1 https://github.com/camel-ai/camel.git
+git clone -b v0.1.5.3 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel
 
-# Install camel from source
+# Install CAMEL from source
 pip install -e .
 
 # Or if you want to use all other extra packages
@@ -164,54 +170,67 @@ python examples/ai_society/role_playing.py
 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.
 
 
-## Use Open-Source Models as Backends
-
-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.
-
-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`**.
-
-Here are some instructions for enabling open-source backends, where we use the [FastChat](https://github.com/lm-sys/FastChat) and a LLaMA2-based model ([`meta-llama/Llama-2-7b-chat-hf`](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)) in the example. Please install FastChat in advance following their installation guidance.
+## Use Open-Source Models as Backends (ex. using Ollama to set Llama 3 locally)
 
-1. Before running CAMEL, we should firstly launch FastChat server following the guidance on https://github.com/lm-sys/FastChat/blob/main/docs/openai_api.md. The instructions summarized below should be kept running **in separate processes**:
-
-```sh
-# Launch the controller
-python -m fastchat.serve.controller
-
-# Launch the model worker(s)
-python3 -m fastchat.serve.model_worker --model-path meta-llama/Llama-2-7b-chat-hf
-
-# Launch the RESTful API server
-python3 -m fastchat.serve.openai_api_server --host localhost --port 8000
-```
+- Download [Ollama](https://ollama.com/download).
+- After setting up Ollama, pull the Llama3 model by typing the following command into the terminal:
+    ```bash
+    ollama pull llama3
+    ```
+- Create a ModelFile similar the one below in your project directory.
+    ```bash
+    FROM llama3
 
-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.
+    # Set parameters
+    PARAMETER temperature 0.8
+    PARAMETER stop Result
 
-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:
+    # Sets a custom system message to specify the behavior of the chat assistant
 
-```python
-system_message = # ...
+    # Leaving it blank for now.
 
-agent_kwargs = dict(
-    model=model_type,
-    model_config=OpenSourceConfig(
-        model_path="meta-llama/Llama-2-7b-chat-hf",
-        server_url="http://localhost:8000/v1",
-    ),
-)
+    SYSTEM """ """
+    ```
+- Create a script to get the base model (llama3) and create a custom model using the ModelFile above. Save this as a .sh file:
+    ```bash
+    #!/bin/zsh
 
-agent = ChatAgent(
-    system_message,
-    **agent_kwargs,
-)
-```
+    # variables
+    model_name="llama3"
+    custom_model_name="camel-llama3"
 
-### Supported Models
+    #get the base model
+    ollama pull $model_name
 
-- LLaMA2-based models
-  - example: [meta-llama/Llama-2-7b-chat-hf](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)
-- Vicuna-based models
-  - example: [lmsys/vicuna-7b-v1.5](https://huggingface.co/lmsys/vicuna-7b-v1.5)
+    #create the model file
+    ollama create $custom_model_name -f ./Llama3ModelFile
+    ```
+- Navigate to the directory where the script and ModelFile are located and run the script. Enjoy your Llama3 model, enhanced by CAMEL's excellent agents.
+    ```python
+    from camel.agents import ChatAgent
+    from camel.messages import BaseMessage
+    from camel.models import ModelFactory
+    from camel.types import ModelPlatformType
+
+    ollama_model = ModelFactory.create(
+        model_platform=ModelPlatformType.OLLAMA,
+        model_type="llama3",
+        url="http://localhost:11434/v1",
+        model_config_dict={"temperature": 0.4},
+    )
+
+    assistant_sys_msg = BaseMessage.make_assistant_message(
+        role_name="Assistant",
+        content="You are a helpful assistant.",
+    )
+    agent = ChatAgent(assistant_sys_msg, model=ollama_model, token_limit=4096)
+
+    user_msg = BaseMessage.make_user_message(
+        role_name="User", content="Say hi to CAMEL"
+    )
+    assistant_response = agent.step(user_msg)
+    print(assistant_response.msg.content)
+    ```
 
 ## Data (Hosted on Hugging Face)
 | Dataset        | Chat format                                                                                         | Instruction format                                                                                               | Chat format (translated)                                                                   |

{camel_ai-0.1.5.1 → camel_ai-0.1.5.3}/camel/agents/__init__.py

@@ -17,6 +17,7 @@ from .critic_agent import CriticAgent
 from .embodied_agent import EmbodiedAgent
 from .knowledge_graph_agent import KnowledgeGraphAgent
 from .role_assignment_agent import RoleAssignmentAgent
+from .search_agent import SearchAgent
 from .task_agent import (
     TaskCreationAgent,
     TaskPlannerAgent,
@@ -38,5 +39,6 @@ __all__ = [
     'HuggingFaceToolAgent',
     'EmbodiedAgent',
     'RoleAssignmentAgent',
+    'SearchAgent',
     'KnowledgeGraphAgent',
 ]