camel-ai 0.1.5.3__py3-none-any.whl → 0.1.5.5__py3-none-any.whl

camel/toolkits/github_toolkit.py

@@ -18,8 +18,8 @@ from datetime import datetime, timedelta
 from typing import List, Optional
 
 from camel.functions import OpenAIFunction
-
-from .base import BaseToolkit
+from camel.toolkits.base import BaseToolkit
+from camel.utils import dependencies_required
 
 
 @dataclass
@@ -130,6 +130,7 @@ class GithubToolkit(BaseToolkit):
             `get_github_access_token` method.
     """
 
+    @dependencies_required('github')
     def __init__(
         self, repo_name: str, access_token: Optional[str] = None
     ) -> None:
@@ -144,13 +145,8 @@ class GithubToolkit(BaseToolkit):
         if access_token is None:
             access_token = self.get_github_access_token()
 
-        try:
-            from github import Auth, Github
-        except ImportError:
-            raise ImportError(
-                "Please install `github` first. You can install it by running "
-                "`pip install pygithub`."
-            )
+        from github import Auth, Github
+
         self.github = Github(auth=Auth.Token(access_token))
         self.repo = self.github.get_repo(repo_name)
 

camel/types/enums.py

@@ -30,15 +30,19 @@ class ModelType(Enum):
     GPT_4_TURBO = "gpt-4-turbo"
     GPT_4O = "gpt-4o"
     GLM_4 = "glm-4"
+    GLM_4_OPEN_SOURCE = "glm-4-open-source"
     GLM_4V = 'glm-4v'
     GLM_3_TURBO = "glm-3-turbo"
 
     STUB = "stub"
 
     LLAMA_2 = "llama-2"
+    LLAMA_3 = "llama-3"
     VICUNA = "vicuna"
     VICUNA_16K = "vicuna-16k"
 
+    QWEN_2 = "qwen-2"
+
     # Legacy anthropic models
     # NOTE: anthropic lagecy models only Claude 2.1 has system prompt support
     CLAUDE_2_1 = "claude-2.1"
@@ -49,6 +53,7 @@ class ModelType(Enum):
     CLAUDE_3_OPUS = "claude-3-opus-20240229"
     CLAUDE_3_SONNET = "claude-3-sonnet-20240229"
     CLAUDE_3_HAIKU = "claude-3-haiku-20240307"
+    CLAUDE_3_5_SONNET = "claude-3-5-sonnet-20240620"
 
     # Nvidia models
     NEMOTRON_4_REWARD = "nvidia/nemotron-4-340b-reward"
@@ -86,6 +91,9 @@ class ModelType(Enum):
         r"""Returns whether this type of models is open-source."""
         return self in {
             ModelType.LLAMA_2,
+            ModelType.LLAMA_3,
+            ModelType.QWEN_2,
+            ModelType.GLM_4_OPEN_SOURCE,
             ModelType.VICUNA,
             ModelType.VICUNA_16K,
         }
@@ -104,6 +112,7 @@ class ModelType(Enum):
             ModelType.CLAUDE_3_OPUS,
             ModelType.CLAUDE_3_SONNET,
             ModelType.CLAUDE_3_HAIKU,
+            ModelType.CLAUDE_3_5_SONNET,
         }
 
     @property
@@ -133,7 +142,7 @@ class ModelType(Enum):
             return 128000
         elif self is ModelType.GPT_4O:
             return 128000
-        elif self == ModelType.GLM_4:
+        elif self == ModelType.GLM_4_OPEN_SOURCE:
             return 8192
         elif self == ModelType.GLM_3_TURBO:
             return 8192
@@ -143,6 +152,12 @@ class ModelType(Enum):
             return 4096
         elif self is ModelType.LLAMA_2:
             return 4096
+        elif self is ModelType.LLAMA_3:
+            return 8192
+        elif self is ModelType.QWEN_2:
+            return 128000
+        elif self is ModelType.GLM_4:
+            return 8192
         elif self is ModelType.VICUNA:
             # reference: https://lmsys.org/blog/2023-03-30-vicuna/
             return 2048
@@ -155,6 +170,7 @@ class ModelType(Enum):
             ModelType.CLAUDE_3_OPUS,
             ModelType.CLAUDE_3_SONNET,
             ModelType.CLAUDE_3_HAIKU,
+            ModelType.CLAUDE_3_5_SONNET,
         }:
             return 200_000
         elif self is ModelType.NEMOTRON_4_REWARD:
@@ -181,40 +197,46 @@ class ModelType(Enum):
                 self.value in model_name.lower()
                 or "llama2" in model_name.lower()
             )
+        elif self is ModelType.LLAMA_3:
+            return (
+                self.value in model_name.lower()
+                or "llama3" in model_name.lower()
+            )
+        elif self is ModelType.QWEN_2:
+            return (
+                self.value in model_name.lower()
+                or "qwen2" in model_name.lower()
+            )
+        elif self is ModelType.GLM_4_OPEN_SOURCE:
+            return (
+                'glm-4' in model_name.lower() or "glm4" in model_name.lower()
+            )
         else:
             return self.value in model_name.lower()
 
 
 class EmbeddingModelType(Enum):
-    ADA_2 = "text-embedding-ada-002"
-    ADA_1 = "text-embedding-ada-001"
-    BABBAGE_1 = "text-embedding-babbage-001"
-    CURIE_1 = "text-embedding-curie-001"
-    DAVINCI_1 = "text-embedding-davinci-001"
+    TEXT_EMBEDDING_ADA_2 = "text-embedding-ada-002"
+    TEXT_EMBEDDING_3_SMALL = "text-embedding-3-small"
+    TEXT_EMBEDDING_3_LARGE = "text-embedding-3-large"
 
     @property
     def is_openai(self) -> bool:
         r"""Returns whether this type of models is an OpenAI-released model."""
         return self in {
-            EmbeddingModelType.ADA_2,
-            EmbeddingModelType.ADA_1,
-            EmbeddingModelType.BABBAGE_1,
-            EmbeddingModelType.CURIE_1,
-            EmbeddingModelType.DAVINCI_1,
+            EmbeddingModelType.TEXT_EMBEDDING_ADA_2,
+            EmbeddingModelType.TEXT_EMBEDDING_3_SMALL,
+            EmbeddingModelType.TEXT_EMBEDDING_3_LARGE,
         }
 
     @property
     def output_dim(self) -> int:
-        if self is EmbeddingModelType.ADA_2:
+        if self is EmbeddingModelType.TEXT_EMBEDDING_ADA_2:
             return 1536
-        elif self is EmbeddingModelType.ADA_1:
-            return 1024
-        elif self is EmbeddingModelType.BABBAGE_1:
-            return 2048
-        elif self is EmbeddingModelType.CURIE_1:
-            return 4096
-        elif self is EmbeddingModelType.DAVINCI_1:
-            return 12288
+        elif self is EmbeddingModelType.TEXT_EMBEDDING_3_SMALL:
+            return 1536
+        elif self is EmbeddingModelType.TEXT_EMBEDDING_3_LARGE:
+            return 3072
         else:
             raise ValueError(f"Unknown model type {self}.")
 
@@ -379,3 +401,10 @@ class VoiceType(Enum):
             VoiceType.NOVA,
             VoiceType.SHIMMER,
         }
+
+
+class JinaReturnFormat(Enum):
+    DEFAULT = None
+    MARKDOWN = "markdown"
+    HTML = "html"
+    TEXT = "text"

camel/utils/__init__.py

@@ -23,7 +23,7 @@ from .commons import (
     get_prompt_template_key_words,
     get_system_information,
     get_task_list,
-    model_api_key_required,
+    is_docker_running,
     print_text_animated,
     text_extract_from_web,
     to_pascal,
@@ -39,7 +39,6 @@ from .token_counting import (
 )
 
 __all__ = [
-    'model_api_key_required',
     'print_text_animated',
     'get_prompt_template_key_words',
     'get_first_int',
@@ -60,4 +59,5 @@ __all__ = [
     'create_chunks',
     'dependencies_required',
     'api_keys_required',
+    'is_docker_running',
 ]

camel/utils/async_func.py

@@ -0,0 +1,42 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+import asyncio
+from copy import deepcopy
+
+from camel.functions.openai_function import OpenAIFunction
+
+
+def sync_funcs_to_async(funcs: list[OpenAIFunction]) -> list[OpenAIFunction]:
+    r"""Convert a list of Python synchronous functions to Python
+    asynchronous functions.
+
+    Args:
+        funcs (list[OpenAIFunction]): List of Python synchronous
+            functions in the :obj:`OpenAIFunction` format.
+
+    Returns:
+        list[OpenAIFunction]: List of Python asynchronous functions
+            in the :obj:`OpenAIFunction` format.
+    """
+    async_funcs = []
+    for func in funcs:
+        sync_func = func.func
+
+        def async_callable(*args, **kwargs):
+            return asyncio.to_thread(sync_func, *args, **kwargs)  # noqa: B023
+
+        async_funcs.append(
+            OpenAIFunction(async_callable, deepcopy(func.openai_tool_schema))
+        )
+    return async_funcs

camel/utils/commons.py

@@ -16,6 +16,7 @@ import os
 import platform
 import re
 import socket
+import subprocess
 import time
 import zipfile
 from functools import wraps
@@ -30,48 +31,6 @@ from camel.types import TaskType
 F = TypeVar('F', bound=Callable[..., Any])
 
 
-def model_api_key_required(func: F) -> F:
-    r"""Decorator that checks if the API key is available either as an
-    environment variable or passed directly for a model.
-
-    Args:
-        func (callable): The function to be wrapped.
-
-    Returns:
-        callable: The decorated function.
-
-    Raises:
-        ValueError: If the API key is not found, either as an environment
-            variable or directly passed.
-
-    Note:
-        Supported model type: `OpenAI` and `Anthropic`.
-    """
-
-    @wraps(func)
-    def wrapper(self, *args, **kwargs):
-        if self.model_type.is_openai:
-            if not self._api_key and 'OPENAI_API_KEY' not in os.environ:
-                raise ValueError('OpenAI API key not found.')
-            return func(self, *args, **kwargs)
-        elif self.model_type.is_zhipuai:
-            if 'ZHIPUAI_API_KEY' not in os.environ:
-                raise ValueError('ZhiPuAI API key not found.')
-            return func(self, *args, **kwargs)
-        elif self.model_type.is_anthropic:
-            if not self._api_key and 'ANTHROPIC_API_KEY' not in os.environ:
-                raise ValueError('Anthropic API key not found.')
-            return func(self, *args, **kwargs)
-        elif self.model_type.is_nvidia:
-            if not self._api_key and 'NVIDIA_API_KEY' not in os.environ:
-                raise ValueError('NVIDIA API key not found.')
-            return func(self, *args, **kwargs)
-        else:
-            raise ValueError('Unsupported model type.')
-
-    return cast(F, wrapper)
-
-
 def print_text_animated(text, delay: float = 0.02, end: str = ""):
     r"""Prints the given text with an animated effect.
 
@@ -260,7 +219,7 @@ def is_module_available(module_name: str) -> bool:
 
 def api_keys_required(*required_keys: str) -> Callable[[F], F]:
     r"""A decorator to check if the required API keys are
-    present in the environment variables.
+    presented in the environment variables or as an instance attribute.
 
     Args:
         required_keys (str): The required API keys to be checked.
@@ -271,7 +230,7 @@ def api_keys_required(*required_keys: str) -> Callable[[F], F]:
 
     Raises:
         ValueError: If any of the required API keys are missing in the
-            environment variables.
+            environment variables and the instance attribute.
 
     Example:
         ::
@@ -283,13 +242,18 @@ def api_keys_required(*required_keys: str) -> Callable[[F], F]:
 
     def decorator(func: F) -> F:
         @wraps(func)
-        def wrapper(*args: Any, **kwargs: Any) -> Any:
-            missing_keys = [k for k in required_keys if k not in os.environ]
-            if missing_keys:
+        def wrapper(self, *args: Any, **kwargs: Any) -> Any:
+            missing_environment_keys = [
+                k for k in required_keys if k not in os.environ
+            ]
+            if (
+                not getattr(self, '_api_key', None)
+                and missing_environment_keys
+            ):
                 raise ValueError(
-                    f"Missing API keys: {', '.join(missing_keys)}"
+                    f"Missing API keys: {', '.join(missing_environment_keys)}"
                 )
-            return func(*args, **kwargs)
+            return func(self, *args, **kwargs)
 
         return cast(F, wrapper)
 
@@ -400,3 +364,21 @@ def create_chunks(text: str, n: int) -> List[str]:
         chunks.append(text[i:j])
         i = j
     return chunks
+
+
+def is_docker_running() -> bool:
+    r"""Check if the Docker daemon is running.
+
+    Returns:
+        bool: True if the Docker daemon is running, False otherwise.
+    """
+    try:
+        result = subprocess.run(
+            ["docker", "info"],
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+        return result.returncode == 0
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        return False

camel/utils/token_counting.py

@@ -51,7 +51,7 @@ def messages_to_prompt(messages: List[OpenAIMessage], model: ModelType) -> str:
     system_message = messages[0]["content"]
 
     ret: str
-    if model == ModelType.LLAMA_2:
+    if model == ModelType.LLAMA_2 or model == ModelType.LLAMA_3:
         # reference: https://github.com/facebookresearch/llama/blob/cfc3fc8c1968d390eb830e65c63865e980873a06/llama/generation.py#L212
         seps = [" ", " </s><s>"]
         role_map = {"user": "[INST]", "assistant": "[/INST]"}
@@ -93,6 +93,45 @@ def messages_to_prompt(messages: List[OpenAIMessage], model: ModelType) -> str:
             else:
                 ret += role + ":"
         return ret
+    elif model == ModelType.GLM_4_OPEN_SOURCE:
+        system_prompt = f"[gMASK]<sop><|system|>\n{system_message}"
+        ret = system_prompt
+        for msg in messages[1:]:
+            role = msg["role"]
+            content = msg["content"]
+            if not isinstance(content, str):
+                raise ValueError(
+                    "Currently multimodal context is not "
+                    "supported by the token counter."
+                )
+            if content:
+                ret += "<|" + role + "|>" + "\n" + content
+            else:
+                ret += "<|" + role + "|>" + "\n"
+        return ret
+    elif model == ModelType.QWEN_2:
+        system_prompt = f"<|im_start|>system\n{system_message}<|im_end|>"
+        ret = system_prompt + "\n"
+        for msg in messages[1:]:
+            role = msg["role"]
+            content = msg["content"]
+            if not isinstance(content, str):
+                raise ValueError(
+                    "Currently multimodal context is not "
+                    "supported by the token counter."
+                )
+            if content:
+                ret += (
+                    '<|im_start|>'
+                    + role
+                    + '\n'
+                    + content
+                    + '<|im_end|>'
+                    + '\n'
+                )
+            else:
+                ret += '<|im_start|>' + role + '\n'
+        return ret
     else:
         raise ValueError(f"Invalid model type: {model}")
 

{camel_ai-0.1.5.3.dist-info → camel_ai-0.1.5.5.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: camel-ai
-Version: 0.1.5.3
+Version: 0.1.5.5
 Summary: Communicative Agents for AI Society Study
 Home-page: https://www.camel-ai.org/
 License: Apache-2.0
 Keywords: communicative-ai,ai-societies,artificial-intelligence,deep-learning,multi-agent-systems,cooperative-ai,natural-language-processing,large-language-models
 Author: CAMEL-AI.org
-Requires-Python: >=3.8.1,<3.12
+Requires-Python: >=3.9.0,<3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -16,6 +16,7 @@ Provides-Extra: all
 Provides-Extra: encoders
 Provides-Extra: graph-storages
 Provides-Extra: huggingface-agent
+Provides-Extra: kv-stroages
 Provides-Extra: model-platforms
 Provides-Extra: retrievers
 Provides-Extra: test
@@ -23,7 +24,7 @@ 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.28.0,<0.29.0)
+Requires-Dist: anthropic (>=0.29.0,<0.30.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)
@@ -31,13 +32,15 @@ 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: docker (>=7.1.0,<8.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: imageio[pyav] (>=2.34.2,<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: milvus-lite (>=2.4.0,<=2.4.7)
 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"
@@ -59,13 +62,14 @@ 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: redis (>=5.0.6,<6.0.0) ; extra == "kv-stroages" or extra == "all"
 Requires-Dist: requests_oauthlib (>=1.3.1,<2.0.0) ; extra == "tools" or extra == "all"
-Requires-Dist: sentence-transformers (>=2.2.2,<3.0.0) ; extra == "encoders" or extra == "all"
+Requires-Dist: sentence-transformers (>=3.0.1,<4.0.0) ; extra == "encoders" or extra == "all"
 Requires-Dist: sentencepiece (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: slack-sdk (>=3.27.2,<4.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: soundfile (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
-Requires-Dist: torch (>=1,<2) ; extra == "huggingface-agent" or extra == "all"
+Requires-Dist: torch (>=2,<3) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: transformers (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: unstructured[all-docs] (>=0.10.30,<0.11.0) ; extra == "tools" or extra == "all"
 Requires-Dist: wikipedia (>=1,<2) ; extra == "tools" or extra == "all"
@@ -180,13 +184,13 @@ exit
 Install `CAMEL` from source with conda and pip:
 ```sh
 # Create a conda virtual environment
-conda create --name camel python=3.10
+conda create --name camel python=3.9
 
 # Activate CAMEL conda environment
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.5.3 https://github.com/camel-ai/camel.git
+git clone -b v0.1.5.5 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel
@@ -198,6 +202,10 @@ pip install -e .
 pip install -e .[all] # (Optional)
 ```
 
+### From Docker
+
+Detailed guidance can be find [here](https://github.com/camel-ai/camel/blob/master/.container/README.md)
+
 ## Documentation
 
 [CAMEL package documentation pages](https://camel-ai.github.io/camel/).