Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Refactor code and add unit tests and examples (#9)

Guohao Lib3edd0748c5d
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 9e6cd3285..a6e959b8d 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -15,10 +15,6 @@
"--based_on_style=pep8",
"--split_before_named_assigns=False"
],
- "isort.args": [
- "--skip",
- "__init__.py"
- ],
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.sortImports": true,
diff --git a/camel/__init__.py b/camel/__init__.py
new file mode 100644
index 000000000..2fff0e88c
--- /dev/null
+++ b/camel/__init__.py
@@ -0,0 +1,22 @@
+from .agent import ChatAgent, TaskSpecifyAgent
+from .configs import ChatGPTConfig
+from .generator import (RoleNameGenerator, SystemMessageGenerator,
+ TaskPromptGenerator)
+from .typing import ModeType, RoleType
+from .utils import get_model_token_limit, num_tokens_from_messages
+
+__version__ = '0.0.1'
+
+__all__ = [
+ '__version__',
+ 'get_model_token_limit',
+ 'num_tokens_from_messages',
+ 'RoleType',
+ 'ModeType',
+ 'ChatGPTConfig',
+ 'ChatAgent',
+ 'TaskSpecifyAgent',
+ 'SystemMessageGenerator',
+ 'RoleNameGenerator',
+ 'TaskPromptGenerator',
+]
diff --git a/camel/chat_agent.py b/camel/agent.py
similarity index 73%
rename from camel/chat_agent.py
rename to camel/agent.py
index c96abe16e..7e8d333b7 100644
--- a/camel/chat_agent.py
+++ b/camel/agent.py
@@ -1,12 +1,14 @@
from typing import Any, Dict, List, Optional, Tuple
import openai
-from camel_typing import (ChatMessage, MessageType, ModeType, RoleType,
- SystemMessage, UserChatMessage)
-from camel_utils import get_model_token_limit, num_tokens_from_messages
-from configs import ChatGPTConfig
from tenacity import retry, stop_after_attempt, wait_fixed
+from camel.configs import ChatGPTConfig
+from camel.message import (ChatMessage, MessageType, SystemMessage,
+ UserChatMessage)
+from camel.typing import ModeType, RoleType
+from camel.utils import get_model_token_limit, num_tokens_from_messages
+
class ChatAgent:
@@ -137,44 +139,3 @@ class TaskSpecifyAgent(ChatAgent):
raise RuntimeError("Task specification failed.")
else:
return specified_task_msg.content
-
-
-if __name__ == "__main__":
- # test_chat_agent.py::test_chat_agent
- from configs import SystemMessageGenerator
- chat_gpt_args = ChatGPTConfig()
- system_message = SystemMessageGenerator(with_task=False).from_role(
- "doctor", RoleType.ASSISTANT)
- assistant = ChatAgent(
- system_message,
- ModeType.GPT_3_5_TURBO,
- chat_gpt_args,
- )
-
- assert str(assistant) == (
- "ChatAgent(doctor, RoleType.ASSISTANT, ModeType.GPT_3_5_TURBO)")
-
- assistant.reset()
- messages, terminated, info = assistant.step(
- ChatMessage("patient", RoleType.USER, "user", "Hello!"))
-
- assert terminated is False
- assert messages != []
- print(info)
-
- assistant.reset()
- messages, terminated, info = assistant.step(
- ChatMessage("patient", RoleType.USER, "user", "Hello!" * 4096))
-
- assert terminated is True
- assert messages == []
- print(info)
-
- # test_chat_agent.py::test_task_specify_agent
- original_task_prompt = "Developing custom game mods or plugins"
- print(f"Original task prompt:\n{original_task_prompt}\n")
- task_specify_agent = TaskSpecifyAgent(
- ModeType.GPT_3_5_TURBO, model_config=ChatGPTConfig(temperature=1.4))
- specified_task_prompt = task_specify_agent.specify_task(
- original_task_prompt)
- print(f"Specified task prompt:\n{specified_task_prompt}\n")
diff --git a/camel/configs.py b/camel/configs.py
index 33dad4842..c9694d84b 100644
--- a/camel/configs.py
+++ b/camel/configs.py
@@ -1,8 +1,5 @@
from dataclasses import dataclass, field
-from typing import Dict, Generator, List, Optional, Sequence, Tuple, Union
-
-from camel_typing import (AssistantSystemMessage, RoleType, SystemMessage,
- SystemMessageType, UserSystemMessage)
+from typing import Dict, Optional, Sequence, Union
@dataclass
@@ -17,220 +14,3 @@ class ChatGPTConfig:
frequency_penalty: float = 0.0
logit_bias: Dict = field(default_factory=dict)
user: str = ""
-
-
-class SystemMessageGenerator:
-
- def __init__(
- self,
- with_task: bool = True,
- assistant_role_names_path: str = "data/assistant_roles.txt",
- user_role_names_path: str = "data/user_roles.txt",
- assistant_prompt_path: str = "prompts/assistant_prompt.txt",
- user_prompt_path: str = "prompts/user_prompt.txt",
- assistant_prompt_with_task_path:
- str = "prompts/assistant_prompt_with_task.txt",
- user_task_prompt_with_task_path:
- str = "prompts/user_prompt_with_task.txt",
- ) -> None:
- self.with_task = with_task
-
- with open(assistant_role_names_path, "r") as f:
- self.assistant_role_names: List[str] = f.read().splitlines()
-
- with open(user_role_names_path, "r") as f:
- self.user_role_names: List[str] = f.read().splitlines()
-
- if not self.with_task:
- with open(assistant_prompt_path, "r") as f:
- self.assistant_prompt: str = f.read()
-
- with open(user_prompt_path, "r") as f:
- self.user_prompt: str = f.read()
- else:
- with open(assistant_prompt_with_task_path, "r") as f:
- self.assistant_prompt: str = f.read()
-
- with open(user_task_prompt_with_task_path, "r") as f:
- self.user_prompt: str = f.read()
-
- def from_role(
- self,
- role_name: str = "",
- role_type: RoleType = RoleType.DEFAULT,
- role_prompt: Optional[str] = None,
- task_prompt: Optional[str] = None,
- ) -> SystemMessageType:
- """Generate a system message from a role name and role type."""
- if task_prompt is not None:
- assert self.with_task, "Please set with `with_task=True`."
- if role_type == RoleType.ASSISTANT:
- role_prompt = role_prompt or self.assistant_prompt
- new_role_prompt = role_prompt.replace("<ASSISTANT_ROLE>",
- role_name)
- assert new_role_prompt != role_prompt
-
- if self.with_task:
- new_role_prompt = new_role_prompt.replace(
- "<TASK>",
- task_prompt,
- )
-
- return AssistantSystemMessage(role_name=role_name,
- content=new_role_prompt)
-
- if role_type == RoleType.USER:
- role_prompt = role_prompt or self.user_prompt
- new_role_prompt = role_prompt.replace("<USER_ROLE>", role_name)
- assert new_role_prompt != role_prompt
-
- if self.with_task:
- new_role_prompt = new_role_prompt.replace(
- "<TASK>",
- task_prompt,
- )
-
- return UserSystemMessage(role_name=role_name,
- content=new_role_prompt)
-
- if role_type == RoleType.DEFAULT:
- new_role_prompt = role_prompt or "You are a helpful assistant."
- if task_prompt is not None:
- new_role_prompt = new_role_prompt.replace(
- "<TASK>", task_prompt)
- return SystemMessage(role_type=role_type, role_name=role_name,
- content=new_role_prompt)
-
- def from_roles(
- self,
- roles: List[Tuple[RoleType, str]],
- assistant_prompt: Optional[str] = None,
- user_prompt: Optional[str] = None,
- task_prompt: Optional[str] = None,
- ) -> List[SystemMessageType]:
- if task_prompt is not None:
- assert self.with_task, "Please set with `with_task=True`."
- assistant_prompt = assistant_prompt or self.assistant_prompt
- user_prompt = user_prompt or self.user_prompt
- role_prompts = [assistant_prompt, user_prompt]
- assert len(roles) == 2, "Only support 1 assistant and 1 user."
- assert RoleType.ASSISTANT in [role_type for _, role_type in roles
- ], "Must have 1 assistant."
- assert RoleType.USER in [role_type for _, role_type in roles
- ], "Must have 1 user."
-
- for i, role_prompt in enumerate(role_prompts):
- for role_name, role_type in roles:
- role_prompt = self.from_role(role_name, role_type, role_prompt,
- task_prompt).content
- role_prompts[i] = role_prompt
-
- for role_name, role_type in roles:
- if role_type == RoleType.ASSISTANT:
- assistant_role_name = role_name
- if role_type == RoleType.USER:
- user_role_name = role_name
-
- assistant_system_message = AssistantSystemMessage(
- role_name=assistant_role_name,
- content=role_prompts[0],
- )
- user_system_message = UserSystemMessage(
- role_name=user_role_name,
- content=role_prompts[1],
- )
-
- system_messages: List[SystemMessageType] = []
- for _, role_type in roles:
- system_messages.append(assistant_system_message if role_type ==
- RoleType.ASSISTANT else user_system_message)
-
- return system_messages
-
- # TODO: support task generator as input.
- def from_role_files(
- self) -> Generator[List[SystemMessageType], None, None]:
- for assistant_role_name in self.assistant_role_names:
- for user_role_name in self.user_role_names:
- yield self.from_roles(
- roles=[(assistant_role_name, RoleType.ASSISTANT),
- (user_role_name, RoleType.USER)], )
-
-
-class RoleNameGenerator:
-
- def __init__(self,
- assistant_role_names_path: str = "data/assistant_roles.txt",
- user_role_names_path: str = "data/user_roles.txt") -> None:
-
- with open(assistant_role_names_path, "r") as f:
- self.assistant_role_names: List[str] = f.read().splitlines()
-
- with open(user_role_names_path, "r") as f:
- self.user_role_names: List[str] = f.read().splitlines()
-
- def from_role_files(self) -> Generator[Tuple, None, None]:
- for assistant_role_name in self.assistant_role_names:
- for user_role_name in self.user_role_names:
- yield (assistant_role_name, user_role_name)
-
-
-class TaskPromptGenerator:
-
- def __init__(
- self,
- generate_tasks_prompt_path: str = "prompts/generate_tasks.txt",
- ) -> None:
-
- with open(generate_tasks_prompt_path, "r") as f:
- self.generate_tasks_prompt: str = f.read()
-
- def from_role_files(
- self, assistant_role_names_path: str = "data/assistant_roles.txt",
- user_role_names_path: str = "data/user_roles.txt"
- ) -> Generator[str, None, None]:
- roles_generator = RoleNameGenerator(
- assistant_role_names_path, user_role_names_path).from_role_files()
- for role_1, role_2 in roles_generator:
- yield (self.generate_tasks_prompt.replace("<ROLE_1>",
- role_1).replace(
- "<ROLE_2>", role_2))
-
- def from_role_generator(
- self, role_generator: Generator[Tuple, None, None]
- ) -> Generator[str, None, None]:
- for role_1, role_2 in role_generator:
- yield (self.generate_tasks_prompt.replace("<ROLE_1>",
- role_1).replace(
- "<ROLE_2>", role_2))
-
-
-if __name__ == "__main__":
- sys_msg_generator = SystemMessageGenerator(with_task=False)
- sys_msg_generator.from_role(role_name="doctor",
- role_type=RoleType.ASSISTANT)
- sys_msg_generator.from_role(role_name="doctor", role_type=RoleType.USER)
-
- sys_msg_generator.from_roles(
- roles=[("doctor", RoleType.USER), ("chatbot", RoleType.ASSISTANT)])
-
- generator = sys_msg_generator.from_role_files()
- sys_msg_1 = next(generator)
- sys_msg_2 = next(generator)
- assert sys_msg_1 != sys_msg_2
-
- sys_msg_generator = SystemMessageGenerator(with_task=True)
- sys_msg_generator.from_roles(
- roles=[("doctor", RoleType.USER), ("chatbot", RoleType.ASSISTANT)],
- task_prompt="Analyze a patient's medical report")
-
- role_name_generator = RoleNameGenerator().from_role_files()
- role_tuple = next(role_name_generator)
- assert isinstance(role_tuple, tuple)
-
- task_tuple = next(
- TaskPromptGenerator().from_role_generator(role_name_generator))
- assert isinstance(task_tuple, str)
-
- task_tuple = next(TaskPromptGenerator().from_role_files())
- assert isinstance(task_tuple, str)
diff --git a/camel/generator.py b/camel/generator.py
new file mode 100644
index 000000000..806c4e625
--- /dev/null
+++ b/camel/generator.py
@@ -0,0 +1,190 @@
+from typing import Generator, List, Optional, Tuple
+
+from camel.message import (AssistantSystemMessage, RoleType, SystemMessage,
+ SystemMessageType, UserSystemMessage)
+
+
+class SystemMessageGenerator:
+
+ def __init__(
+ self,
+ with_task: bool = True,
+ assistant_role_names_path: str = "data/assistant_roles.txt",
+ user_role_names_path: str = "data/user_roles.txt",
+ assistant_prompt_path: str = "prompts/assistant_prompt.txt",
+ user_prompt_path: str = "prompts/user_prompt.txt",
+ assistant_prompt_with_task_path:
+ str = "prompts/assistant_prompt_with_task.txt",
+ user_task_prompt_with_task_path:
+ str = "prompts/user_prompt_with_task.txt",
+ ) -> None:
+ self.with_task = with_task
+
+ with open(assistant_role_names_path, "r") as f:
+ self.assistant_role_names: List[str] = f.read().splitlines()
+
+ with open(user_role_names_path, "r") as f:
+ self.user_role_names: List[str] = f.read().splitlines()
+
+ if not self.with_task:
+ with open(assistant_prompt_path, "r") as f:
+ self.assistant_prompt: str = f.read()
+
+ with open(user_prompt_path, "r") as f:
+ self.user_prompt: str = f.read()
+ else:
+ with open(assistant_prompt_with_task_path, "r") as f:
+ self.assistant_prompt: str = f.read()
+
+ with open(user_task_prompt_with_task_path, "r") as f:
+ self.user_prompt: str = f.read()
+
+ def from_role(
+ self,
+ role_name: str = "",
+ role_type: RoleType = RoleType.DEFAULT,
+ role_prompt: Optional[str] = None,
+ task_prompt: Optional[str] = None,
+ ) -> SystemMessageType:
+ """Generate a system message from a role name and role type."""
+ if task_prompt is not None:
+ assert self.with_task, "Please set with `with_task=True`."
+ if role_type == RoleType.ASSISTANT:
+ role_prompt = role_prompt or self.assistant_prompt
+ new_role_prompt = role_prompt.replace("<ASSISTANT_ROLE>",
+ role_name)
+ assert new_role_prompt != role_prompt
+
+ if self.with_task:
+ new_role_prompt = new_role_prompt.replace(
+ "<TASK>",
+ task_prompt,
+ )
+
+ return AssistantSystemMessage(role_name=role_name,
+ content=new_role_prompt)
+
+ if role_type == RoleType.USER:
+ role_prompt = role_prompt or self.user_prompt
+ new_role_prompt = role_prompt.replace("<USER_ROLE>", role_name)
+ assert new_role_prompt != role_prompt
+
+ if self.with_task:
+ new_role_prompt = new_role_prompt.replace(
+ "<TASK>",
+ task_prompt,
+ )
+
+ return UserSystemMessage(role_name=role_name,
+ content=new_role_prompt)
+
+ if role_type == RoleType.DEFAULT:
+ new_role_prompt = role_prompt or "You are a helpful assistant."
+ if task_prompt is not None:
+ new_role_prompt = new_role_prompt.replace(
+ "<TASK>", task_prompt)
+ return SystemMessage(role_type=role_type, role_name=role_name,
+ content=new_role_prompt)
+
+ def from_roles(
+ self,
+ roles: List[Tuple[RoleType, str]],
+ assistant_prompt: Optional[str] = None,
+ user_prompt: Optional[str] = None,
+ task_prompt: Optional[str] = None,
+ ) -> List[SystemMessageType]:
+ if task_prompt is not None:
+ assert self.with_task, "Please set with `with_task=True`."
+ assistant_prompt = assistant_prompt or self.assistant_prompt
+ user_prompt = user_prompt or self.user_prompt
+ role_prompts = [assistant_prompt, user_prompt]
+ assert len(roles) == 2, "Only support 1 assistant and 1 user."
+ assert RoleType.ASSISTANT in [role_type for _, role_type in roles
+ ], "Must have 1 assistant."
+ assert RoleType.USER in [role_type for _, role_type in roles
+ ], "Must have 1 user."
+
+ for i, role_prompt in enumerate(role_prompts):
+ for role_name, role_type in roles:
+ role_prompt = self.from_role(role_name, role_type, role_prompt,
+ task_prompt).content
+ role_prompts[i] = role_prompt
+
+ for role_name, role_type in roles:
+ if role_type == RoleType.ASSISTANT:
+ assistant_role_name = role_name
+ if role_type == RoleType.USER:
+ user_role_name = role_name
+
+ assistant_system_message = AssistantSystemMessage(
+ role_name=assistant_role_name,
+ content=role_prompts[0],
+ )
+ user_system_message = UserSystemMessage(
+ role_name=user_role_name,
+ content=role_prompts[1],
+ )
+
+ system_messages: List[SystemMessageType] = []
+ for _, role_type in roles:
+ system_messages.append(assistant_system_message if role_type ==
+ RoleType.ASSISTANT else user_system_message)
+
+ return system_messages
+
+ # TODO: support task generator as input.
+ def from_role_files(
+ self) -> Generator[List[SystemMessageType], None, None]:
+ for assistant_role_name in self.assistant_role_names:
+ for user_role_name in self.user_role_names:
+ yield self.from_roles(
+ roles=[(assistant_role_name, RoleType.ASSISTANT),
+ (user_role_name, RoleType.USER)], )
+
+
+class RoleNameGenerator:
+
+ def __init__(self,
+ assistant_role_names_path: str = "data/assistant_roles.txt",
+ user_role_names_path: str = "data/user_roles.txt") -> None:
+
+ with open(assistant_role_names_path, "r") as f:
+ self.assistant_role_names: List[str] = f.read().splitlines()
+
+ with open(user_role_names_path, "r") as f:
+ self.user_role_names: List[str] = f.read().splitlines()
+
+ def from_role_files(self) -> Generator[Tuple, None, None]:
+ for assistant_role_name in self.assistant_role_names:
+ for user_role_name in self.user_role_names:
+ yield (assistant_role_name, user_role_name)
+
+
+class TaskPromptGenerator:
+
+ def __init__(
+ self,
+ generate_tasks_prompt_path: str = "prompts/generate_tasks.txt",
+ ) -> None:
+
+ with open(generate_tasks_prompt_path, "r") as f:
+ self.generate_tasks_prompt: str = f.read()
+
+ def from_role_files(
+ self, assistant_role_names_path: str = "data/assistant_roles.txt",
+ user_role_names_path: str = "data/user_roles.txt"
+ ) -> Generator[str, None, None]:
+ roles_generator = RoleNameGenerator(
+ assistant_role_names_path, user_role_names_path).from_role_files()
+ for role_1, role_2 in roles_generator:
+ yield (self.generate_tasks_prompt.replace("<ROLE_1>",
+ role_1).replace(
+ "<ROLE_2>", role_2))
+
+ def from_role_generator(
+ self, role_generator: Generator[Tuple, None, None]
+ ) -> Generator[str, None, None]:
+ for role_1, role_2 in role_generator:
+ yield (self.generate_tasks_prompt.replace("<ROLE_1>",
+ role_1).replace(
+ "<ROLE_2>", role_2))
diff --git a/camel/camel_typing.py b/camel/message.py
similarity index 94%
rename from camel/camel_typing.py
rename to camel/message.py
index 085736eb0..da430e2f9 100644
--- a/camel/camel_typing.py
+++ b/camel/message.py
@@ -1,7 +1,8 @@
from dataclasses import dataclass
-from enum import Enum
from typing import Dict, Optional, Union
+from .typing import RoleType
+
OpenAISystemMessage = Dict[str, str]
OpenAIAssistantMessage = Dict[str, str]
OpenAIUserMessage = Dict[str, str]
@@ -9,16 +10,6 @@ OpenAIChatMessage = Union[OpenAIUserMessage, OpenAIAssistantMessage]
OpenAIMessage = Union[OpenAISystemMessage, OpenAIChatMessage]
-class RoleType(Enum):
- ASSISTANT = "assistant"
- USER = "user"
- DEFAULT = "default"
-
-
-class ModeType(Enum):
- GPT_3_5_TURBO = "gpt-3.5-turbo"
-
-
@dataclass
class BaseMessage:
role_name: str
diff --git a/camel/typing.py b/camel/typing.py
new file mode 100644
index 000000000..189c3f7c1
--- /dev/null
+++ b/camel/typing.py
@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class RoleType(Enum):
+ ASSISTANT = "assistant"
+ USER = "user"
+ DEFAULT = "default"
+
+
+class ModeType(Enum):
+ GPT_3_5_TURBO = "gpt-3.5-turbo"
+
+
+__all__ = ['RoleType', 'ModeType']
diff --git a/camel/camel_utils.py b/camel/utils.py
similarity index 94%
rename from camel/camel_utils.py
rename to camel/utils.py
index 9aa4fe05a..258989785 100644
--- a/camel/camel_utils.py
+++ b/camel/utils.py
@@ -1,7 +1,9 @@
from typing import List
import tiktoken
-from camel_typing import ModeType, OpenAIMessage
+
+from camel.message import OpenAIMessage
+from camel.typing import ModeType
def num_tokens_from_messages(messages: List[OpenAIMessage], model: ModeType):
diff --git a/camel/role_playing.py b/examples/role_playing.py
similarity index 87%
rename from camel/role_playing.py
rename to examples/role_playing.py
index 42495aeb1..5c429f25f 100644
--- a/camel/role_playing.py
+++ b/examples/role_playing.py
@@ -1,10 +1,11 @@
from typing import List, Tuple
-from camel_typing import (AssistantChatMessage, AssistantSystemMessage,
- ChatMessage, ModeType, RoleType, UserChatMessage,
- UserSystemMessage)
-from chat_agent import ChatAgent, TaskSpecifyAgent
-from configs import ChatGPTConfig, SystemMessageGenerator
+from camel.agent import ChatAgent, TaskSpecifyAgent
+from camel.configs import ChatGPTConfig
+from camel.generator import SystemMessageGenerator
+from camel.message import (AssistantChatMessage, AssistantSystemMessage,
+ ChatMessage, UserChatMessage, UserSystemMessage)
+from camel.typing import ModeType, RoleType
def init_chat(
diff --git a/camel/task_generator.py b/examples/task_generation.py
similarity index 86%
rename from camel/task_generator.py
rename to examples/task_generation.py
index 4e913c2d3..9aa71a61b 100644
--- a/camel/task_generator.py
+++ b/examples/task_generation.py
@@ -1,10 +1,10 @@
import multiprocessing
import os
-from camel_typing import ModeType, RoleType
-from chat_agent import ChatAgent
-from configs import (RoleNameGenerator, SystemMessageGenerator,
- TaskPromptGenerator)
+from camel.agent import ChatAgent
+from camel.generator import (RoleNameGenerator, SystemMessageGenerator,
+ TaskPromptGenerator)
+from camel.typing import ModeType, RoleType
def generate_tasks(role_name: str, task_generator_prompt: str,
@@ -37,7 +37,7 @@ def main() -> None:
role_names_generator = RoleNameGenerator().from_role_files()
task_generator_prompt_generator = TaskPromptGenerator().from_role_files()
- pool = multiprocessing.Pool()
+ pool = multiprocessing.Pool(processes=1)
for task_generator_prompt, role_name in zip(
task_generator_prompt_generator, role_names_generator):
if not os.path.exists(f"./tasks/{'_'.join(role_name)}.txt"):
diff --git a/install_env.sh b/install_env.sh
index a4eea5435..3a7ceb487 100644
--- a/install_env.sh
+++ b/install_env.sh
@@ -2,4 +2,5 @@ conda create --name camel python=3.10
conda activate camel
conda install pytorch torchvision torchaudio pytorch-cuda=11.7 -c pytorch -c nvidia
pip install -r requirements.txt
-pre-commit install
\ No newline at end of file
+pre-commit install
+pip install -e .
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
index bf5816828..bcb4e1adf 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,5 @@
+setuptools
+build
numpy
openai
tenacity
@@ -5,4 +7,5 @@ tiktoken
yapf
isort
flake8
-pre-commit
\ No newline at end of file
+pre-commit
+pytest
\ No newline at end of file
diff --git a/setup.py b/setup.py
new file mode 100644
index 000000000..e6ce765ea
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,26 @@
+from setuptools import find_packages, setup
+
+__version__ = '0.0.1'
+
+install_requires = [
+ 'numpy',
+ 'openai',
+ 'tenacity',
+ 'tiktoken',
+]
+
+full_requires = []
+test_requires = []
+dev_requires = []
+
+setup(
+ name='camel',
+ version=__version__,
+ install_requires=install_requires,
+ extras_require={
+ 'full': full_requires,
+ 'test': test_requires,
+ 'dev': dev_requires,
+ },
+ packages=find_packages(),
+)
diff --git a/test/test_chat_agent.py b/test/test_chat_agent.py
new file mode 100644
index 000000000..53f0cc953
--- /dev/null
+++ b/test/test_chat_agent.py
@@ -0,0 +1,49 @@
+import os
+
+from camel.agent import ChatAgent, TaskSpecifyAgent
+from camel.configs import ChatGPTConfig
+from camel.generator import SystemMessageGenerator
+from camel.message import ChatMessage
+from camel.typing import ModeType, RoleType
+
+assert os.environ.get("OPENAI_API_KEY") is not None, "Missing OPENAI_API_KEY"
+
+
+def test_chat_agent():
+ chat_gpt_args = ChatGPTConfig()
+ system_message = SystemMessageGenerator(with_task=False).from_role(
+ "doctor", RoleType.ASSISTANT)
+ assistant = ChatAgent(
+ system_message,
+ ModeType.GPT_3_5_TURBO,
+ chat_gpt_args,
+ )
+
+ assert str(assistant) == (
+ "ChatAgent(doctor, RoleType.ASSISTANT, ModeType.GPT_3_5_TURBO)")
+
+ assistant.reset()
+ messages, terminated, info = assistant.step(
+ ChatMessage("patient", RoleType.USER, "user", "Hello!"))
+
+ assert terminated is False
+ assert messages != []
+ assert info['id'] is not None
+
+ assistant.reset()
+ messages, terminated, info = assistant.step(
+ ChatMessage("patient", RoleType.USER, "user", "Hello!" * 4096))
+
+ assert terminated is True
+ assert messages == []
+ assert info['finish_reasons'][0] == "max_tokens_exceeded"
+
+
+def test_task_specify_agent():
+ original_task_prompt = "Developing custom game mods or plugins"
+ print(f"Original task prompt:\n{original_task_prompt}\n")
+ task_specify_agent = TaskSpecifyAgent(
+ ModeType.GPT_3_5_TURBO, model_config=ChatGPTConfig(temperature=1.4))
+ specified_task_prompt = task_specify_agent.specify_task(
+ original_task_prompt)
+ print(f"Specified task prompt:\n{specified_task_prompt}\n")
diff --git a/test/test_generator.py b/test/test_generator.py
new file mode 100644
index 000000000..e2865c4d9
--- /dev/null
+++ b/test/test_generator.py
@@ -0,0 +1,39 @@
+from camel.generator import (RoleNameGenerator, SystemMessageGenerator,
+ TaskPromptGenerator)
+from camel.typing import RoleType
+
+
+def test_system_message_generator():
+ sys_msg_generator = SystemMessageGenerator(with_task=False)
+ sys_msg_generator.from_role(role_name="doctor",
+ role_type=RoleType.ASSISTANT)
+ sys_msg_generator.from_role(role_name="doctor", role_type=RoleType.USER)
+
+ sys_msg_generator.from_roles(
+ roles=[("doctor", RoleType.USER), ("chatbot", RoleType.ASSISTANT)])
+
+ generator = sys_msg_generator.from_role_files()
+ sys_msg_1 = next(generator)
+ sys_msg_2 = next(generator)
+ assert sys_msg_1 != sys_msg_2
+
+ sys_msg_generator = SystemMessageGenerator(with_task=True)
+ sys_msg_generator.from_roles(
+ roles=[("doctor", RoleType.USER), ("chatbot", RoleType.ASSISTANT)],
+ task_prompt="Analyze a patient's medical report")
+
+
+def test_role_name_generator():
+ role_name_generator = RoleNameGenerator().from_role_files()
+ role_tuple = next(role_name_generator)
+ assert isinstance(role_tuple, tuple)
+
+
+def test_task_prompt_generator():
+ role_name_generator = RoleNameGenerator().from_role_files()
+ task_tuple = next(
+ TaskPromptGenerator().from_role_generator(role_name_generator))
+ assert isinstance(task_tuple, str)
+
+ task_tuple = next(TaskPromptGenerator().from_role_files())
+ assert isinstance(task_tuple, str)