camel-ai 0.2.10__py3-none-any.whl → 0.2.12__py3-none-any.whl

camel/models/anthropic_model.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Literal, Optional, Union
 
 from camel.configs import ANTHROPIC_API_PARAMS, AnthropicConfig
 from camel.messages import OpenAIMessage
@@ -94,19 +94,29 @@ class AnthropicModel(BaseModelBackend):
                 tokenization style.
         """
         if not self._token_counter:
-            self._token_counter = AnthropicTokenCounter()
+            self._token_counter = AnthropicTokenCounter(self.model_type)
         return self._token_counter
 
-    def count_tokens_from_prompt(self, prompt: str) -> int:
+    @dependencies_required('anthropic')
+    def count_tokens_from_prompt(
+        self, prompt: str, role: Literal["user", "assistant"]
+    ) -> int:
         r"""Count the number of tokens from a prompt.
 
         Args:
             prompt (str): The prompt string.
+            role (Literal["user", "assistant"]): The role of the message
+                sender, either "user" or "assistant".
 
         Returns:
             int: The number of tokens in the prompt.
         """
-        return self.client.count_tokens(prompt)
+        from anthropic.types.beta import BetaMessageParam
+
+        return self.client.beta.messages.count_tokens(
+            messages=[BetaMessageParam(content=prompt, role=role)],
+            model=self.model_type,
+        ).input_tokens
 
     @api_keys_required("ANTHROPIC_API_KEY")
     def run(

camel/models/base_model.py

@@ -21,6 +21,7 @@ from camel.types import (
     ChatCompletion,
     ChatCompletionChunk,
     ModelType,
+    ParsedChatCompletion,
     UnifiedModelType,
 )
 from camel.utils import BaseTokenCounter
@@ -114,6 +115,33 @@ class BaseModelBackend(ABC):
         """
         return self.token_counter.count_tokens_from_messages(messages)
 
+    def _to_chat_completion(
+        self, response: ParsedChatCompletion
+    ) -> ChatCompletion:
+        if len(response.choices) > 1:
+            print("Warning: Multiple response choices detected")
+
+        choice = dict(
+            index=response.choices[0].index,
+            message={
+                "role": response.choices[0].message.role,
+                "content": response.choices[0].message.content,
+                "tool_calls": response.choices[0].message.tool_calls,
+                "parsed": response.choices[0].message.parsed,
+            },
+            finish_reason=response.choices[0].finish_reason,
+        )
+
+        obj = ChatCompletion.construct(
+            id=response.id,
+            choices=[choice],
+            created=response.created,
+            model=response.model,
+            object="chat.completion",
+            usage=response.usage,
+        )
+        return obj
+
     @property
     def token_limit(self) -> int:
         r"""Returns the maximum token limit for a given model.

camel/models/groq_model.py

@@ -63,7 +63,7 @@ class GroqModel(BaseModelBackend):
             model_config_dict = GroqConfig().as_dict()
         api_key = api_key or os.environ.get("GROQ_API_KEY")
         url = url or os.environ.get(
-            "GROQ_API_BASE_URL" or "https://api.groq.com/openai/v1"
+            "GROQ_API_BASE_URL", "https://api.groq.com/openai/v1"
         )
         super().__init__(
             model_type, model_config_dict, api_key, url, token_counter

camel/models/model_factory.py

@@ -22,12 +22,14 @@ from camel.models.gemini_model import GeminiModel
 from camel.models.groq_model import GroqModel
 from camel.models.litellm_model import LiteLLMModel
 from camel.models.mistral_model import MistralModel
+from camel.models.nvidia_model import NvidiaModel
 from camel.models.ollama_model import OllamaModel
 from camel.models.openai_compatible_model import OpenAICompatibleModel
 from camel.models.openai_model import OpenAIModel
 from camel.models.qwen_model import QwenModel
 from camel.models.reka_model import RekaModel
 from camel.models.samba_model import SambaModel
+from camel.models.sglang_model import SGLangModel
 from camel.models.stub_model import StubModel
 from camel.models.togetherai_model import TogetherAIModel
 from camel.models.vllm_model import VLLMModel
@@ -85,6 +87,8 @@ class ModelFactory:
             model_class = OllamaModel
         elif model_platform.is_vllm:
             model_class = VLLMModel
+        elif model_platform.is_sglang:
+            model_class = SGLangModel
         elif model_platform.is_openai_compatible_model:
             model_class = OpenAICompatibleModel
         elif model_platform.is_samba:
@@ -93,6 +97,8 @@ class ModelFactory:
             model_class = TogetherAIModel
         elif model_platform.is_litellm:
             model_class = LiteLLMModel
+        elif model_platform.is_nvidia:
+            model_class = NvidiaModel
 
         elif model_platform.is_openai and model_type.is_openai:
             model_class = OpenAIModel

camel/models/model_manager.py

@@ -0,0 +1,212 @@
+# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+
+import logging
+from itertools import cycle
+from random import choice
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    List,
+    Union,
+)
+
+from openai import Stream
+
+from camel.messages import OpenAIMessage
+from camel.models.base_model import BaseModelBackend
+from camel.types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    UnifiedModelType,
+)
+from camel.utils import BaseTokenCounter
+
+logger = logging.getLogger(__name__)
+
+
+class ModelProcessingError(Exception):
+    r"""Raised when an error occurs during model processing."""
+
+    pass
+
+
+class ModelManager:
+    r"""ModelManager choosing a model from provided list.
+    Models are picked according to defined strategy.
+
+    Args:
+        models(Union[BaseModelBackend, List[BaseModelBackend]]):
+            model backend or list of model backends
+            (e.g., model instances, APIs)
+        scheduling_strategy (str): name of function that defines how
+            to select the next model. (default: :str:`round_robin`)
+    """
+
+    def __init__(
+        self,
+        models: Union[BaseModelBackend, List[BaseModelBackend]],
+        scheduling_strategy: str = "round_robin",
+    ):
+        if isinstance(models, list):
+            self.models = models
+        else:
+            self.models = [models]
+        self.models_cycle = cycle(self.models)
+        self.current_model = self.models[0]
+
+        # Set the scheduling strategy; default is round-robin
+        try:
+            self.scheduling_strategy = getattr(self, scheduling_strategy)
+        except AttributeError:
+            logger.warning(
+                f"Provided strategy: {scheduling_strategy} is not implemented."
+                f"Using default 'round robin'"
+            )
+            self.scheduling_strategy = self.round_robin
+
+    @property
+    def model_type(self) -> UnifiedModelType:
+        r"""Return type of the current model.
+
+        Returns:
+            Union[ModelType, str]: Current model type.
+        """
+        return self.current_model.model_type
+
+    @property
+    def model_config_dict(self) -> Dict[str, Any]:
+        r"""Return model_config_dict of the current model.
+
+        Returns:
+            Dict[str, Any]: Config dictionary of the current model.
+        """
+        return self.current_model.model_config_dict
+
+    @model_config_dict.setter
+    def model_config_dict(self, model_config_dict: Dict[str, Any]):
+        r"""Set model_config_dict to the current model.
+
+        Args:
+            model_config_dict (Dict[str, Any]): Config dictionary to be set at
+                current model.
+        """
+        self.current_model.model_config_dict = model_config_dict
+
+    @property
+    def current_model_index(self) -> int:
+        r"""Return the index of current model in self.models list.
+
+        Returns:
+            int: index of current model in given list of models.
+        """
+        return self.models.index(self.current_model)
+
+    @property
+    def token_limit(self):
+        r"""Returns the maximum token limit for current model.
+
+        This method retrieves the maximum token limit either from the
+        `model_config_dict` or from the model's default token limit.
+
+        Returns:
+            int: The maximum token limit for the given model.
+        """
+        return self.current_model.token_limit
+
+    @property
+    def token_counter(self) -> BaseTokenCounter:
+        r"""Return token_counter of the current model.
+
+        Returns:
+            BaseTokenCounter: The token counter following the model's
+                tokenization style.
+        """
+        return self.current_model.token_counter
+
+    def add_strategy(self, name: str, strategy_fn: Callable):
+        r"""Add a scheduling strategy method provided by user in case when none
+            of existent strategies fits.
+            When custom strategy is provided, it will be set as
+            "self.scheduling_strategy" attribute.
+
+        Args:
+            name (str): The name of the strategy.
+            strategy_fn (Callable): The scheduling strategy function.
+        """
+        if not callable(strategy_fn):
+            raise ValueError("strategy_fn must be a callable function.")
+        setattr(self, name, strategy_fn.__get__(self))
+        self.scheduling_strategy = getattr(self, name)
+        logger.info(f"Custom strategy '{name}' added.")
+
+    # Strategies
+    def round_robin(self) -> BaseModelBackend:
+        r"""Return models one by one in simple round-robin fashion.
+
+        Returns:
+             BaseModelBackend for processing incoming messages.
+        """
+        return next(self.models_cycle)
+
+    def always_first(self) -> BaseModelBackend:
+        r"""Always return the first model from self.models.
+
+        Returns:
+            BaseModelBackend for processing incoming messages.
+        """
+        return self.models[0]
+
+    def random_model(self) -> BaseModelBackend:
+        r"""Return random model from self.models list.
+
+        Returns:
+             BaseModelBackend for processing incoming messages.
+        """
+        return choice(self.models)
+
+    def run(
+        self, messages: List[OpenAIMessage]
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        r"""Process a list of messages by selecting a model based on
+            the scheduling strategy.
+            Sends the entire list of messages to the selected model,
+            and returns a single response.
+
+        Args:
+            messages (List[OpenAIMessage]): Message list with the chat
+                history in OpenAI API format.
+
+        Returns:
+            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+                `ChatCompletion` in the non-stream mode, or
+                `Stream[ChatCompletionChunk]` in the stream mode.
+        """
+        self.current_model = self.scheduling_strategy()
+
+        # Pass all messages to the selected model and get the response
+        try:
+            response = self.current_model.run(messages)
+        except Exception as exc:
+            logger.error(f"Error processing with model: {self.current_model}")
+            if self.scheduling_strategy == self.always_first:
+                self.scheduling_strategy = self.round_robin
+                logger.warning(
+                    "The scheduling strategy has been changed to 'round_robin'"
+                )
+                # Skip already used one
+                self.current_model = self.scheduling_strategy()
+            raise exc
+        return response

camel/models/nvidia_model.py

@@ -0,0 +1,141 @@
+# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+
+import os
+from typing import Any, Dict, List, Optional, Union
+
+from openai import OpenAI, Stream
+from openai.types.chat import (
+    ChatCompletion,
+    ChatCompletionChunk,
+)
+
+from camel.configs import NVIDIA_API_PARAMS, NvidiaConfig
+from camel.messages import OpenAIMessage
+from camel.models import BaseModelBackend
+from camel.types import ModelType
+from camel.utils import BaseTokenCounter, OpenAITokenCounter, api_keys_required
+
+
+class NvidiaModel(BaseModelBackend):
+    r"""NVIDIA API in a unified BaseModelBackend interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created, one of NVIDIA series.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into:obj:`openai.ChatCompletion.create()`. If
+            :obj:`None`, :obj:`NvidiaConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the NVIDIA service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the NVIDIA service.
+            (default: :obj:`None`)
+        token_counter (Optional[BaseTokenCounter], optional): Token counter to
+            use for the model. If not provided, :obj:`OpenAITokenCounter(
+            ModelType.GPT_4)` will be used.
+            (default: :obj:`None`)
+    """
+
+    def __init__(
+        self,
+        model_type: Union[ModelType, str],
+        model_config_dict: Optional[Dict[str, Any]] = None,
+        api_key: Optional[str] = None,
+        url: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
+    ) -> None:
+        if model_config_dict is None:
+            model_config_dict = NvidiaConfig().as_dict()
+        api_key = api_key or os.environ.get("NVIDIA_API_KEY")
+        url = url or os.environ.get(
+            "NVIDIA_API_BASE_URL", "https://integrate.api.nvidia.com/v1"
+        )
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
+        self._client = OpenAI(
+            timeout=60,
+            max_retries=3,
+            api_key=self._api_key,
+            base_url=self._url,
+        )
+
+    @api_keys_required("NVIDIA_API_KEY")
+    def run(
+        self,
+        messages: List[OpenAIMessage],
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        r"""Runs inference of NVIDIA chat completion.
+
+        Args:
+            messages (List[OpenAIMessage]): Message list with the chat history
+                in OpenAI API format.
+
+        Returns:
+            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+                `ChatCompletion` in the non-stream mode, or
+                `Stream[ChatCompletionChunk]` in the stream mode.
+        """
+
+        # Remove tool-related parameters if no tools are specified
+        config = dict(self.model_config_dict)
+        if not config.get('tools'):  # None or empty list
+            config.pop('tools', None)
+            config.pop('tool_choice', None)
+
+        response = self._client.chat.completions.create(
+            messages=messages,
+            model=self.model_type,
+            **config,
+        )
+        return response
+
+    @property
+    def token_counter(self) -> BaseTokenCounter:
+        r"""Initialize the token counter for the model backend.
+
+        Returns:
+            OpenAITokenCounter: The token counter following the model's
+                tokenization style.
+        """
+
+        if not self._token_counter:
+            self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
+        return self._token_counter
+
+    def check_model_config(self):
+        r"""Check whether the model configuration contains any
+        unexpected arguments to NVIDIA API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to NVIDIA API.
+        """
+        for param in self.model_config_dict:
+            if param not in NVIDIA_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into NVIDIA model backend."
+                )
+
+    @property
+    def stream(self) -> bool:
+        r"""Returns whether the model is in stream mode, which sends partial
+        results each time.
+
+        Returns:
+            bool: Whether the model is in stream mode.
+        """
+        return self.model_config_dict.get('stream', False)

camel/models/ollama_model.py

@@ -134,6 +134,18 @@ class OllamaModel(BaseModelBackend):
                 `ChatCompletion` in the non-stream mode, or
                 `Stream[ChatCompletionChunk]` in the stream mode.
         """
+        if self.model_config_dict.get("response_format"):
+            # stream is not supported in beta.chat.completions.parse
+            if "stream" in self.model_config_dict:
+                del self.model_config_dict["stream"]
+
+            response = self._client.beta.chat.completions.parse(
+                messages=messages,
+                model=self.model_type,
+                **self.model_config_dict,
+            )
+
+            return self._to_chat_completion(response)
 
         response = self._client.chat.completions.create(
             messages=messages,

camel/models/openai_model.py

@@ -24,7 +24,6 @@ from camel.types import (
     ChatCompletion,
     ChatCompletionChunk,
     ModelType,
-    ParsedChatCompletion,
 )
 from camel.utils import (
     BaseTokenCounter,
@@ -148,30 +147,6 @@ class OpenAIModel(BaseModelBackend):
         )
         return response
 
-    def _to_chat_completion(
-        self, response: "ParsedChatCompletion"
-    ) -> ChatCompletion:
-        # TODO: Handle n > 1 or warn consumers it's not supported
-        choice = dict(
-            index=response.choices[0].index,
-            message={
-                "role": response.choices[0].message.role,
-                "content": response.choices[0].message.content,
-                "tool_calls": response.choices[0].message.tool_calls,
-            },
-            finish_reason=response.choices[0].finish_reason,
-        )
-
-        obj = ChatCompletion.construct(
-            id=response.id,
-            choices=[choice],
-            created=response.created,
-            model=response.model,
-            object="chat.completion",
-            usage=response.usage,
-        )
-        return obj
-
     def check_model_config(self):
         r"""Check whether the model configuration contains any
         unexpected arguments to OpenAI API.

camel/models/reward/__init__.py

@@ -0,0 +1,22 @@
+# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+from .base_reward_model import BaseRewardModel
+from .evaluator import Evaluator
+from .nemotron_model import NemotronRewardModel
+
+__all__ = [
+    'BaseRewardModel',
+    'NemotronRewardModel',
+    'Evaluator',
+]

camel/models/reward/base_reward_model.py

@@ -0,0 +1,58 @@
+# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+from abc import ABC, abstractmethod
+from typing import Dict, List, Optional, Union
+
+from camel.types import ModelType
+
+
+class BaseRewardModel(ABC):
+    r"""Abstract base class for reward models. Reward models are used to
+    evaluate messages and return scores based on different criteria.
+
+    Subclasses should implement the 'evaluate' and 'get_scores_types' methods.
+    """
+
+    def __init__(
+        self,
+        model_type: Union[ModelType, str],
+        api_key: Optional[str] = None,
+        url: Optional[str] = None,
+    ) -> None:
+        self.model_type = model_type
+        self.api_key = api_key
+        self.url = url
+
+    @abstractmethod
+    def evaluate(self, messages: List[Dict[str, str]]) -> Dict[str, float]:
+        r"""Evaluate the messages and return scores based on different
+        criteria.
+
+        Args:
+            messages (List[Dict[str, str]]): A list of messages where each
+                message is a dictionary with 'role' and 'content'.
+
+        Returns:
+            Dict[str, float]: A dictionary mapping score types to their values.
+        """
+        pass
+
+    @abstractmethod
+    def get_scores_types(self) -> List[str]:
+        r"""Get the list of score types that the reward model can return.
+
+        Returns:
+            List[str]: A list of score types that the reward model can return.
+        """
+        pass

camel/models/reward/evaluator.py

@@ -0,0 +1,63 @@
+# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+from typing import Dict, List
+
+from camel.models.reward import BaseRewardModel
+
+
+class Evaluator:
+    r"""Evaluator class to evaluate messages using a reward model and filter
+    data based on the scores.
+
+    Args:
+        reward_model (BaseRewardModel): A reward model to evaluate messages.
+    """
+
+    def __init__(self, reward_model: BaseRewardModel):
+        self.reward_model = reward_model
+
+    def evaluate(self, messages: List[Dict[str, str]]) -> Dict[str, float]:
+        r"""Evaluate the messages using the reward model.
+
+        Args:
+            messages (List[Dict[str, str]]): A list of messages where each
+                message is a dictionary with 'role' and 'content'.
+
+        Returns:
+            Dict[str, float]: A dictionary mapping score types to their values.
+        """
+        scores = self.reward_model.evaluate(messages)
+        return scores
+
+    def filter_data(
+        self, messages: List[Dict[str, str]], thresholds: Dict[str, float]
+    ) -> bool:
+        r"""Filter messages based on the scores.
+
+        Args:
+            messages (List[Dict[str, str]]): A list of messages where each
+                message is a dictionary with 'role' and 'content'.
+            thresholds (Dict[str, float]): A dictionary mapping score types to
+                their values.
+
+        Returns:
+            bool: A boolean indicating whether the messages pass the filter.
+        """
+        scores = self.evaluate(messages)
+        for score_type, threshold in thresholds.items():
+            if score_type not in scores:
+                raise ValueError(f"Score type {score_type} not found.")
+            if scores.get(score_type, 0) < threshold:
+                return False
+        return True