Created models subpackage

camel/agents/chat_agent.py

@@ -180,7 +180,7 @@ def step(
         info: Dict[str, Any]
 
         if num_tokens < self.model_token_limit:
-            response = self.model_backend.run(messages=openai_messages)
+            response = self.model_backend.run(openai_messages)
             if not isinstance(response, dict):
                 raise RuntimeError("OpenAI returned unexpected struct")
             output_messages = [

camel/model_backend.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 from abc import ABC, abstractmethod
-from typing import Any, Dict
+from typing import Any, Dict, List, Optional
 
 from camel.typing import ModelType
 
@@ -22,9 +22,13 @@ class ModelBackend(ABC):
     May be OpenAI API, a local LLM, a stub for unit tests, etc."""
 
     @abstractmethod
-    def run(self, *args, **kwargs) -> Dict[str, Any]:
+    def run(self, messages: List[Dict]) -> Dict[str, Any]:
         r"""Runs the query to the backend model.
 
+        Args:
+            messages (List[Dict]): message list with the chat history
+                in OpenAI API format.
+
         Raises:
             RuntimeError: if the return value from OpenAI API
             is not a dict that is expected.
@@ -39,14 +43,30 @@ class OpenAIModel(ModelBackend):
     r"""OpenAI API in a unified ModelBackend interface."""
 
     def __init__(self, model_type: ModelType, model_config_dict: Dict) -> None:
+        r"""Constructor for OpenAI backend.
+
+        Args:
+            model_type (ModelType): Model for which a backend is created,
+                one of GPT_* series.
+            model_config_dict (Dict): a dictionary that will be fed into
+                openai.ChatCompletion.create().
+        """
         super().__init__()
         self.model_type = model_type
         self.model_config_dict = model_config_dict
 
-    def run(self, *args, **kwargs) -> Dict[str, Any]:
+    def run(self, messages: List[Dict]) -> Dict[str, Any]:
+        r"""Run inference of OpenAI chat completion.
+
+        Args:
+            messages (List[Dict]): message list with the chat history
+                in OpenAI API format.
 
+        Returns:
+            Dict[str, Any]: Response in the OpenAI API format.
+        """
         import openai
-        response = openai.ChatCompletion.create(*args, **kwargs,
+        response = openai.ChatCompletion.create(messages=messages,
                                                 model=self.model_type.value,
                                                 **self.model_config_dict)
         if not isinstance(response, Dict):
@@ -58,9 +78,16 @@ class StubModel(ModelBackend):
     r"""A dummy model used for unit tests."""
 
     def __init__(self, *args, **kwargs) -> None:
+        r"""All arguments are unused for the dummy model."""
         super().__init__()
 
-    def run(self, *args, **kwargs) -> Dict[str, Any]:
+    def run(self, messages: List[Dict]) -> Dict[str, Any]:
+        r"""Run fake inference by returning a fixed string.
+        All arguments are unused for the dummy model.
+
+        Returns:
+            Dict[str, Any]: Response in the OpenAI API format.
+        """
         ARBITRARY_STRING = "Lorem Ipsum"
 
         return dict(
@@ -81,9 +108,24 @@ class ModelFactory:
     """
 
     @staticmethod
-    def create(model_type: ModelType, model_config_dict: Dict) -> ModelBackend:
+    def create(model_type: Optional[ModelType],
+               model_config_dict: Dict) -> ModelBackend:
+        r"""Creates an instance of `ModelBackend` of the specified type.
+
+        Args:
+            model_type (ModelType): Model for which a backend is created.
+            model_config_dict (Dict): a dictionary that will be fed into
+                the backend constructor.
+
+        Raises:
+            ValueError: If there is not backend for the model.
+
+        Returns:
+            ModelBackend: The initialized backend.
+        """
         default_model_type = ModelType.GPT_3_5_TURBO
 
+        model_class: Any
         if model_type in {
                 ModelType.GPT_3_5_TURBO, ModelType.GPT_4, ModelType.GPT_4_32k,
                 None

examples/test/test_ai_society_example.py

@@ -20,7 +20,3 @@
 @pytest.mark.slow
 def test_ai_society_role_playing_example():
     examples.ai_society.role_playing.main(ModelType.STUB)
-
-
-if __name__ == "__main__":
-    pytest.main()

test/test_model_backend.py

@@ -45,7 +45,7 @@ def test_openai_model(model):
                         'Do not add anything else.')
         },
     ]
-    response = model_inst.run(messages=messages)
+    response = model_inst.run(messages)
     assert isinstance(response, dict)
     assert 'id' in response
     assert isinstance(response['id'], str)