feat: add data collector for dataset generation

camel/data_collector/__init__.py

@@ -0,0 +1,18 @@
+# =========== 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. ===========
+from .alpaca_collector import AlpacaDataCollector
+from .base import BaseDataCollector
+from .sharegpt_collector import ShareGPTDataCollector
+
+__all__ = ["BaseDataCollector", "AlpacaDataCollector", "ShareGPTDataCollector"]

camel/data_collector/alpaca_collector.py

@@ -0,0 +1,71 @@
+# =========== 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. ===========
+from typing import Dict, List, Optional, Self, Union
+
+from camel.agents.chat_agent import ChatAgent
+from camel.data_collector.base import BaseDataCollector
+from camel.messages.base import BaseMessage
+
+
+class AlpacaDataCollector(BaseDataCollector):
+    def __init__(self):
+        super().__init__()
+        self.system_message: Optional[BaseMessage] = None
+        self.agent_name: Optional[str] = None
+
+    def inject(
+        self,
+        agent: Union[List[ChatAgent], ChatAgent],
+        name: Optional[Union[str, List[Optional[str]]]] = None,
+    ) -> Self:
+        r"""Inject an agent into the data collector.
+
+        Args:
+            agent (Union[List[ChatAgent], ChatAgent]):
+                The agent to inject.
+            name (Optional[Union[str, List[Optional[str]]]], optional):
+                The name of the agent. Defaults to None.
+        """
+        if len(self.agents) > 1:
+            raise ValueError("AlpacaDataCollector only supports one agent")
+        if isinstance(agent, list):
+            if len(agent) != 1:
+                raise ValueError("AlpacaDataCollector only supports one agent")
+            agent = agent[0]
+        if isinstance(name, list):
+            name = name[0]
+        self.agent_name = name or agent.role_name
+        self.system_message = agent._system_message
+        self._inject(agent, name)
+        return self
+
+    def convert(self) -> Dict[str, str]:
+        r"""Convert the collected data into a dictionary."""
+        if self.agent_name is None:
+            raise ValueError("No agent injected")
+        if history := self.history.get(self.agent_name):
+            if len(history) != 2:
+                raise ValueError(
+                    "AlpacaDataCollector only supports one message"
+                )
+            data = dict(
+                instructions=self.system_message.content
+                if self.system_message
+                else "",
+                input=history[0][2].content,
+                output=history[1][2].content,
+            )
+            self.data.append(data)
+            return data
+        raise ValueError("No data collected")

camel/data_collector/base.py

@@ -0,0 +1,159 @@
+# =========== 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. ===========
+from abc import ABC, abstractmethod
+from collections import defaultdict
+from typing import Any, Dict, List, Optional, Self, Tuple, Union
+
+from camel.agents.base import BaseAgent
+from camel.agents.chat_agent import ChatAgent
+from camel.messages.base import BaseMessage
+from camel.responses.agent_responses import ChatAgentResponse
+from camel.types.enums import OpenAIBackendRole
+
+
+class BaseDataCollector(ABC):
+    r"""Base class for data collectors."""
+
+    def __init__(self):
+        self.history: Dict[
+            str, List[Tuple[int, OpenAIBackendRole, BaseMessage]]
+        ] = defaultdict(list)
+        self._recording = False
+        self.agents: List[Tuple[str, BaseAgent]] = []
+        self._id = 0
+        self.data: List[Dict[str, Any]] = []
+
+    def step(
+        self,
+        message: Union[BaseMessage, ChatAgentResponse],
+        role: OpenAIBackendRole,
+        name: Optional[str] = None,
+    ) -> Self:
+        r"""Record a message.
+
+        Args:
+            message (Union[BaseMessage, ChatAgentResponse]):
+                The message to record.
+            role (OpenAIBackendRole): The role of the message.
+            name (Optional[str], optional):
+                The name of the agent. Defaults to None.
+        """
+        if name is None:
+            if len(self.agents) > 1:
+                raise ValueError(
+                    "DataCollector has multiple agents, "
+                    "please specify the agent name"
+                )
+            name = self.agents[0][0]
+        if isinstance(message, ChatAgentResponse):
+            if len(message.msgs) != 1:
+                raise ValueError("Only supports one message in response")
+            message = message.msgs[0]
+        self.history[name].append((self._id, role, message))
+        self._id += 1
+        return self
+
+    def _inject(self, agent: ChatAgent, name: Optional[str] = None) -> Self:
+        r"""Inject an agent.
+
+        Args:
+            agent (ChatAgent): The agent to inject.
+            name (Optional[str], optional):
+                The name of the agent. Defaults to None.
+        """
+        name = name or agent.role_name
+        if not name:
+            name = f"{agent.__class__.__name__}_{len(self.agents)}"
+        if name in [n for n, _ in self.agents]:
+            raise ValueError(f"Name {name} already exists")
+
+        self.agents.append((name, agent))
+
+        ori_update_memory = agent.update_memory
+
+        def update_memory(
+            message: BaseMessage, role: OpenAIBackendRole
+        ) -> None:
+            if self._recording:
+                self.history[name].append((self._id, role, message))
+                self._id += 1
+            return ori_update_memory(message, role)
+
+        agent.update_memory = update_memory  # type: ignore[method-assign]
+
+        return self
+
+    def inject(
+        self,
+        agent: Union[List[ChatAgent], ChatAgent],
+        name: Optional[Union[str, List[Optional[str]]]] = None,
+    ) -> Self:
+        r"""Inject agents.
+
+        Args:
+            agent (Union[List[ChatAgent], ChatAgent]):
+                The agent(s) to inject.
+            name (Optional[Union[str, List[Optional[str]]], optional):
+                The name(s) of the agent(s). Defaults to None.
+        """
+        if not isinstance(agent, list):
+            agent = [agent]
+        if name is None:
+            name = [None] * len(agent)
+        elif not isinstance(name, list):
+            name = [name]
+        for a, n in zip(agent, name):
+            self._inject(a, n)
+        return self
+
+    def start(self) -> Self:
+        r"""Start recording."""
+        self._recording = True
+        return self
+
+    def stop(self) -> Self:
+        r"""Stop recording."""
+        self._recording = False
+        return self
+
+    @property
+    def recording(self) -> bool:
+        r"""Whether the collector is recording."""
+        return self._recording
+
+    def reset(self, reset_agents: bool = True):
+        r"""Reset the collector.
+
+        Args:
+            reset_agents (bool, optional):
+                Whether to reset the agents. Defaults to True.
+        """
+        self.history = defaultdict(list)
+        self._id = 0
+        if reset_agents:
+            for _, agent in self.agents:
+                agent.reset()
+
+    @abstractmethod
+    def convert(self) -> Any:
+        r"""Convert the collected data."""
+        pass
+
+    def save(self, path: str):
+        r"""Save the collected data.
+
+        Args:
+            path (str): The path to save the data.
+        """
+        raise NotImplementedError

camel/data_collector/sharegpt_collector.py

@@ -0,0 +1,103 @@
+# =========== 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 json
+from typing import Any, Dict, List, Optional, Self, Union
+
+from camel.agents.chat_agent import ChatAgent
+from camel.data_collector.base import BaseDataCollector
+from camel.messages.base import BaseMessage
+from camel.messages.func_message import FunctionCallingMessage
+from camel.toolkits.function_tool import FunctionTool
+from camel.types.enums import OpenAIBackendRole
+
+
+class ShareGPTDataCollector(BaseDataCollector):
+    def __init__(self):
+        super().__init__()
+        self.system_message: Optional[BaseMessage] = None
+        self.agent_name: Optional[str] = None
+        self.tools: List[FunctionTool] = []
+
+    def inject(
+        self,
+        agent: Union[List[ChatAgent], ChatAgent],
+        name: Optional[Union[str, List[Optional[str]]]] = None,
+    ) -> Self:
+        r"""Inject an agent into the data collector."""
+        if len(self.agents) > 1:
+            raise ValueError("ShareGPTDataCollector only supports one agent")
+        if isinstance(agent, list):
+            if len(agent) != 1:
+                raise ValueError(
+                    "ShareGPTDataCollector only supports one agent"
+                )
+            agent = agent[0]
+        if isinstance(name, list):
+            name = name[0]
+
+        self.agent_name = name or agent.role_name
+        self.system_message = agent._system_message
+        self.tools = list(agent.tool_dict.values())
+
+        self._inject(agent, name)
+        return self
+
+    def convert(self) -> Dict[str, Any]:
+        r"""Convert the collected data into a dictionary."""
+        if self.agent_name is None:
+            raise ValueError("No agent injected")
+        if history := self.history.get(self.agent_name):
+            data = dict(
+                system=self.system_message.content
+                if self.system_message
+                else "",
+                tools=json.dumps(
+                    [
+                        t.get_openai_tool_schema()["function"]
+                        for t in self.tools
+                    ]
+                ),
+                conversations=[],
+            )
+            conversations: List[Any] = []
+            for _, role, message in history:
+                if role == OpenAIBackendRole.USER:
+                    conversations.append(
+                        {"from": "human", "value": message.content}
+                    )
+                elif role == OpenAIBackendRole.ASSISTANT:
+                    if isinstance(message, FunctionCallingMessage):
+                        tmp = dict(
+                            name=message.func_name,
+                            arguments=message.args,
+                        )
+                        conversations.append(
+                            {"from": "function_call", "value": json.dumps(tmp)}
+                        )
+                    else:
+                        conversations.append(
+                            {"from": "gpt", "value": message.content}
+                        )
+                elif role == OpenAIBackendRole.FUNCTION:
+                    conversations.append(
+                        {
+                            "from": "observation",
+                            "value": json.dumps(message.result),  # type: ignore[attr-defined]
+                        }
+                    )
+            data["conversations"] = conversations
+
+            self.data.append(data)
+            return data
+        raise ValueError("No data collected")