camel-ai 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

camel/utils/token_counting.py

@@ -11,11 +11,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+
+from __future__ import annotations
+
+import base64
 from abc import ABC, abstractmethod
-from typing import List
+from io import BytesIO
+from math import ceil
+from typing import TYPE_CHECKING, List, Optional
+
+from anthropic import Anthropic
+from PIL import Image
 
-from camel.messages import OpenAIMessage
-from camel.types import ModelType
+from camel.types import ModelType, OpenAIImageDetailType, OpenAIImageType
+
+if TYPE_CHECKING:
+    from camel.messages import OpenAIMessage
+
+LOW_DETAIL_TOKENS = 85
+FIT_SQUARE_PIXELS = 2048
+SHORTEST_SIDE_PIXELS = 768
+SQUARE_PIXELS = 512
+SQUARE_TOKENS = 170
+EXTRA_TOKENS = 85
 
 
 def messages_to_prompt(messages: List[OpenAIMessage], model: ModelType) -> str:
@@ -45,8 +63,10 @@ def messages_to_prompt(messages: List[OpenAIMessage], model: ModelType) -> str:
             content = msg["content"]
             if content:
                 if not isinstance(content, str):
-                    raise ValueError("Currently multimodal context is not "
-                                     "supported by the token counter.")
+                    raise ValueError(
+                        "Currently multimodal context is not "
+                        "supported by the token counter."
+                    )
                 if i == 0:
                     ret += system_prompt + content
                 else:
@@ -64,8 +84,10 @@ def messages_to_prompt(messages: List[OpenAIMessage], model: ModelType) -> str:
             role = role_map[msg["role"]]
             content = msg["content"]
             if not isinstance(content, str):
-                raise ValueError("Currently multimodal context is not "
-                                 "supported by the token counter.")
+                raise ValueError(
+                    "Currently multimodal context is not "
+                    "supported by the token counter."
+                )
             if content:
                 ret += role + ": " + content + seps[i % 2]
             else:
@@ -85,6 +107,7 @@ def get_model_encoding(value_for_tiktoken: str):
         tiktoken.Encoding: Model encoding.
     """
     import tiktoken
+
     try:
         encoding = tiktoken.encoding_for_model(value_for_tiktoken)
     except KeyError:
@@ -111,7 +134,6 @@ class BaseTokenCounter(ABC):
 
 
 class OpenSourceTokenCounter(BaseTokenCounter):
-
     def __init__(self, model_type: ModelType, model_path: str):
         r"""Constructor for the token counter for open-source models.
 
@@ -126,6 +148,7 @@ class OpenSourceTokenCounter(BaseTokenCounter):
         # If a fast tokenizer is not available for a given model,
         # a normal Python-based tokenizer is returned instead.
         from transformers import AutoTokenizer
+
         try:
             tokenizer = AutoTokenizer.from_pretrained(
                 model_path,
@@ -136,10 +159,11 @@ class OpenSourceTokenCounter(BaseTokenCounter):
                 model_path,
                 use_fast=False,
             )
-        except:
+        except Exception:
             raise ValueError(
                 f"Invalid `model_path` ({model_path}) is provided. "
-                "Tokenizer loading failed.")
+                "Tokenizer loading failed."
+            )
 
         self.tokenizer = tokenizer
         self.model_type = model_type
@@ -162,13 +186,11 @@ class OpenSourceTokenCounter(BaseTokenCounter):
 
 
 class OpenAITokenCounter(BaseTokenCounter):
-
     def __init__(self, model: ModelType):
         r"""Constructor for the token counter for OpenAI models.
 
         Args:
-            model_type (ModelType): Model type for which tokens will be
-                counted.
+            model (ModelType): Model type for which tokens will be counted.
         """
         self.model: str = model.value_for_tiktoken
 
@@ -192,7 +214,8 @@ class OpenAITokenCounter(BaseTokenCounter):
                 "for information on how messages are converted to tokens. "
                 "See https://platform.openai.com/docs/models/gpt-4"
                 "or https://platform.openai.com/docs/models/gpt-3-5"
-                "for information about openai chat models.")
+                "for information about openai chat models."
+            )
 
         self.encoding = get_model_encoding(self.model)
 
@@ -211,10 +234,107 @@ class OpenAITokenCounter(BaseTokenCounter):
         for message in messages:
             num_tokens += self.tokens_per_message
             for key, value in message.items():
-                num_tokens += len(self.encoding.encode(str(value)))
+                if not isinstance(value, list):
+                    num_tokens += len(self.encoding.encode(str(value)))
+                else:
+                    for item in value:
+                        if item["type"] == "text":
+                            num_tokens += len(
+                                self.encoding.encode(str(item["text"]))
+                            )
+                        elif item["type"] == "image_url":
+                            image_str: str = item["image_url"]["url"]
+                            detail = item["image_url"]["detail"]
+                            image_prefix_format = "data:image/{};base64,"
+                            image_prefix: Optional[str] = None
+                            for image_type in list(OpenAIImageType):
+                                # Find the correct image format
+                                image_prefix = image_prefix_format.format(
+                                    image_type.value
+                                )
+                                if image_prefix in image_str:
+                                    break
+                            assert isinstance(image_prefix, str)
+                            encoded_image = image_str.split(image_prefix)[1]
+                            image_bytes = BytesIO(
+                                base64.b64decode(encoded_image)
+                            )
+                            image = Image.open(image_bytes)
+                            num_tokens += count_tokens_from_image(
+                                image, OpenAIImageDetailType(detail)
+                            )
                 if key == "name":
                     num_tokens += self.tokens_per_name
 
         # every reply is primed with <|start|>assistant<|message|>
         num_tokens += 3
         return num_tokens
+
+
+class AnthropicTokenCounter(BaseTokenCounter):
+    def __init__(self, model_type: ModelType):
+        r"""Constructor for the token counter for Anthropic models.
+
+        Args:
+            model_type (ModelType): Model type for which tokens will be
+                counted.
+        """
+
+        self.model_type = model_type
+        self.client = Anthropic()
+        self.tokenizer = self.client.get_tokenizer()
+
+    def count_tokens_from_messages(self, messages: List[OpenAIMessage]) -> int:
+        r"""Count number of tokens in the provided message list using
+        loaded tokenizer specific for this type of model.
+
+        Args:
+            messages (List[OpenAIMessage]): Message list with the chat history
+                in OpenAI API format.
+
+        Returns:
+            int: Number of tokens in the messages.
+        """
+        prompt = messages_to_prompt(messages, self.model_type)
+
+        return self.client.count_tokens(prompt)
+
+
+def count_tokens_from_image(
+    image: Image.Image, detail: OpenAIImageDetailType
+) -> int:
+    r"""Count image tokens for OpenAI vision model. An :obj:`"auto"`
+    resolution model will be treated as :obj:`"high"`. All images with
+    :obj:`"low"` detail cost 85 tokens each. Images with :obj:`"high"` detail
+    are first scaled to fit within a 2048 x 2048 square, maintaining their
+    aspect ratio. Then, they are scaled such that the shortest side of the
+    image is 768px long. Finally, we count how many 512px squares the image
+    consists of. Each of those squares costs 170 tokens. Another 85 tokens are
+    always added to the final total. For more details please refer to `OpenAI
+    vision docs <https://platform.openai.com/docs/guides/vision>`_
+
+    Args:
+        image (PIL.Image.Image): Image to count number of tokens.
+        detail (OpenAIImageDetailType): Image detail type to count
+            number of tokens.
+
+    Returns:
+        int: Number of tokens for the image given a detail type.
+    """
+    if detail == OpenAIImageDetailType.LOW:
+        return LOW_DETAIL_TOKENS
+
+    width, height = image.size
+    if width > FIT_SQUARE_PIXELS or height > FIT_SQUARE_PIXELS:
+        scaling_factor = max(width, height) / FIT_SQUARE_PIXELS
+        width = int(width / scaling_factor)
+        height = int(height / scaling_factor)
+
+    scaling_factor = min(width, height) / SHORTEST_SIDE_PIXELS
+    scaled_width = int(width / scaling_factor)
+    scaled_height = int(height / scaling_factor)
+
+    h = ceil(scaled_height / SQUARE_PIXELS)
+    w = ceil(scaled_width / SQUARE_PIXELS)
+    total = EXTRA_TOKENS + SQUARE_TOKENS * h * w
+    return total

{camel_ai-0.1.1.dist-info → camel_ai-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: camel-ai
-Version: 0.1.1
+Version: 0.1.3
 Summary: Communicative Agents for AI Society Study
 Home-page: https://www.camel-ai.org/
 License: Apache-2.0
@@ -13,74 +13,71 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: all
+Provides-Extra: encoders
+Provides-Extra: graph-storages
 Provides-Extra: huggingface-agent
+Provides-Extra: retrievers
 Provides-Extra: test
 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: argilla (>=1.19.0,<2.0.0) ; extra == "tools" or extra == "all"
+Requires-Dist: anthropic (>=0.21.3,<0.22.0)
 Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "tools" or extra == "all"
 Requires-Dist: colorama (>=0,<1)
 Requires-Dist: datasets (>=2,<3) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: diffusers (>=0,<1) ; extra == "huggingface-agent" 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: googlemaps (>=4.10.0,<5.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: jsonschema (>=4,<5)
 Requires-Dist: mock (>=5,<6) ; extra == "test"
+Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "graph-storages" or extra == "all"
 Requires-Dist: numpy (>=1,<2)
 Requires-Dist: openai (>=1.2.3,<2.0.0)
 Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
+Requires-Dist: pathlib (>=1.0.1,<2.0.0)
 Requires-Dist: protobuf (>=4,<5)
+Requires-Dist: pydantic (>=1.9,<3)
+Requires-Dist: pymilvus (>=2.4.0,<3.0.0) ; extra == "vector-databases" or extra == "all"
 Requires-Dist: pyowm (>=3.3.0,<4.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: pytest (>=7,<8) ; 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: 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: sentencepiece (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: soundfile (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: tiktoken (>=0,<1)
 Requires-Dist: torch (>=1,<2) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: transformers (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
-Requires-Dist: unstructured (>=0.10.30,<0.11.0) ; extra == "tools" 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"
+Requires-Dist: wolframalpha (>=5.0.0,<6.0.0) ; extra == "tools" or extra == "all"
 Project-URL: Documentation, https://docs.camel-ai.org
 Project-URL: Repository, https://github.com/camel-ai/camel
 Description-Content-Type: text/markdown
 
-<div style="left">
-  <a href="https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing" target="_blank">
-    <img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />
-  </a>
-  <a href="https://huggingface.co/camel-ai" target="_blank">
-    <img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white" />
-  </a>
-  <a href="https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA" target="_blank">
-      <img alt="Slack" src="https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack" />
-  </a>
-  <a href="https://discord.gg/CNcNpquyDc" target="_blank">
-    <img alt="Discord" src="https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da" />
-  </a>
-  <a href="https://ghli.org/camel/wechat.png" target="_blank">
-    <img alt="Discord" src="https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white" />
-  </a>
-  <a href="https://twitter.com/CamelAIOrg" target="_blank">
-    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter" />
-  </a>
-</div>
-
-# CAMEL: Communicative Agents for “Mind” Exploration of Large Scale Language Model Society
-
-<div align="center">
-
-  <a>![Python 3.9+](https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg)</a>
-  <a href="https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml">![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/camel-ai/camel/pytest_package.yml?label=tests&logo=github)</a>
-  <a href="https://camel-ai.github.io/camel/">
-    ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/camel-ai/camel/documentation.yaml?label=docs&logo=github)
-  </a>
-  <a href="https://github.com/camel-ai/camel/stargazers" target="_blank">
-  <img alt="GitHub Repo Stars" src="https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen" />
-  </a>
-  <a href="https://github.com/camel-ai/camel/blob/master/licenses/LICENSE">![License](https://img.shields.io/github/license/camel-ai/camel?label=license&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMi43NSAyLjc1YS43NS43NSAwIDAwLTEuNSAwVjQuNUg5LjI3NmExLjc1IDEuNzUgMCAwMC0uOTg1LjMwM0w2LjU5NiA1Ljk1N0EuMjUuMjUgMCAwMTYuNDU1IDZIMi4zNTNhLjc1Ljc1IDAgMTAwIDEuNUgzLjkzTC41NjMgMTUuMThhLjc2Mi43NjIgMCAwMC4yMS44OGMuMDguMDY0LjE2MS4xMjUuMzA5LjIyMS4xODYuMTIxLjQ1Mi4yNzguNzkyLjQzMy42OC4zMTEgMS42NjIuNjIgMi44NzYuNjJhNi45MTkgNi45MTkgMCAwMDIuODc2LS42MmMuMzQtLjE1NS42MDYtLjMxMi43OTItLjQzMy4xNS0uMDk3LjIzLS4xNTguMzEtLjIyM2EuNzUuNzUgMCAwMC4yMDktLjg3OEw1LjU2OSA3LjVoLjg4NmMuMzUxIDAgLjY5NC0uMTA2Ljk4NC0uMzAzbDEuNjk2LTEuMTU0QS4yNS4yNSAwIDAxOS4yNzUgNmgxLjk3NXYxNC41SDYuNzYzYS43NS43NSAwIDAwMCAxLjVoMTAuNDc0YS43NS43NSAwIDAwMC0xLjVIMTIuNzVWNmgxLjk3NGMuMDUgMCAuMS4wMTUuMTQuMDQzbDEuNjk3IDEuMTU0Yy4yOS4xOTcuNjMzLjMwMy45ODQuMzAzaC44ODZsLTMuMzY4IDcuNjhhLjc1Ljc1IDAgMDAuMjMuODk2Yy4wMTIuMDA5IDAgMCAuMDAyIDBhMy4xNTQgMy4xNTQgMCAwMC4zMS4yMDZjLjE4NS4xMTIuNDUuMjU2Ljc5LjRhNy4zNDMgNy4zNDMgMCAwMDIuODU1LjU2OCA3LjM0MyA3LjM0MyAwIDAwMi44NTYtLjU2OWMuMzM4LS4xNDMuNjA0LS4yODcuNzktLjM5OWEzLjUgMy41IDAgMDAuMzEtLjIwNi43NS43NSAwIDAwLjIzLS44OTZMMjAuMDcgNy41aDEuNTc4YS43NS43NSAwIDAwMC0xLjVoLTQuMTAyYS4yNS4yNSAwIDAxLS4xNC0uMDQzbC0xLjY5Ny0xLjE1NGExLjc1IDEuNzUgMCAwMC0uOTg0LS4zMDNIMTIuNzVWMi43NXpNMi4xOTMgMTUuMTk4YTUuNDE4IDUuNDE4IDAgMDAyLjU1Ny42MzUgNS40MTggNS40MTggMCAwMDIuNTU3LS42MzVMNC43NSA5LjM2OGwtMi41NTcgNS44M3ptMTQuNTEtLjAyNGMuMDgyLjA0LjE3NC4wODMuMjc1LjEyNi41My4yMjMgMS4zMDUuNDUgMi4yNzIuNDVhNS44NDYgNS44NDYgMCAwMDIuNTQ3LS41NzZMMTkuMjUgOS4zNjdsLTIuNTQ3IDUuODA3eiI+PC9wYXRoPjwvc3ZnPgo=)</a>
-</div>
+[![Colab][colab-image]][colab-url]
+[![Hugging Face][huggingface-image]][huggingface-url]
+[![Slack][slack-image]][slack-url]
+[![Discord][discord-image]][discord-url]
+[![Wechat][wechat-image]][wechat-url]
+[![Twitter][twitter-image]][twitter-url]
+
+______________________________________________________________________
+
+# CAMEL: Communicative Agents for “Mind” Exploration of Large Language Model Society
+
+[![Python Version][python-image]][python-url]
+[![PyTest Status][pytest-image]][pytest-url]
+[![Documentation][docs-image]][docs-url]
+[![Star][star-image]][star-url]
+[![Package License][package-license-image]][package-license-url]
+[![Data License][data-license-image]][data-license-url]
 
 <p align="center">
-   <a href="https://github.com/camel-ai/camel#community">Community</a> |
+  <a href="https://github.com/camel-ai/camel#community">Community</a> |
   <a href="https://github.com/camel-ai/camel#installation">Installation</a> |
   <a href="https://camel-ai.github.io/camel/">Documentation</a> |
   <a href="https://github.com/camel-ai/camel/tree/HEAD/examples">Examples</a> |
@@ -91,7 +88,7 @@ Description-Content-Type: text/markdown
 </p>
 
 <p align="center">
-  <img src='./misc/logo.png' width=800>
+  <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png' width=800>
 </p>
 
 ## Overview
@@ -100,28 +97,46 @@ The rapid advancement of conversational and chat-based language models has led t
 ## Community
 🐫 CAMEL is an open-source library designed for the study of autonomous and communicative agents. We believe that studying these agents on a large scale offers valuable insights into their behaviors, capabilities, and potential risks. To facilitate research in this field, we implement and support various types of agents, tasks, prompts, models, and simulated environments.
 
-Join us ([*Slack*](https://join.slack.com/t/camel-kwr1314/shared_invite/zt-1vy8u9lbo-ZQmhIAyWSEfSwLCl2r2eKA), [*Discord*](https://discord.gg/CNcNpquyDc) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of building AI Societiy.
+Join us ([*Slack*](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ), [*Discord*](https://discord.gg/CNcNpquyDc) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of building AI Society.
 
 ## Try it yourself
 We provide a [![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing) demo showcasing a conversation between two ChatGPT agents playing roles as a python programmer and a stock trader collaborating on developing a trading bot for stock market.
 
 <p align="center">
-  <img src='./misc/framework.png' width=800>
+  <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/framework.png' width=800>
 </p>
 
-## Documentation
+## Installation
 
-[CAMEL package documentation pages](https://camel-ai.github.io/camel/)
+### From PyPI
 
-## Installation
+To install the base CAMEL library:
+```bash
+pip install camel-ai
+```
+Some features require extra dependencies:
+- To use the HuggingFace agents:
+    ```bash
+    pip install 'camel-ai[huggingface-agent]'
+    ```
+- To enable RAG or use agent memory:
+    ```bash
+    pip install 'camel-ai[tools]'
+    ```
+- To install with all dependencies:
+    ```bash
+    pip install 'camel-ai[all]'
+    ```
+
+### From Source
 
 Install `CAMEL` from source with poetry (Recommended):
 ```sh
+# Make sure your python version is later than 3.9
+# You can use pyenv to manage multiple python verisons in your sytstem
+
 # Clone github repo
-# For the latest code:
 git clone https://github.com/camel-ai/camel.git
-# Or for the stable code:
-git clone -b v0.1.0 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel
@@ -133,10 +148,8 @@ poetry shell
 # It takes about 90 seconds to resolve dependencies
 poetry install
 
-# Or if you want to use "huggingface agent"
-poetry install -E huggingface-agent # (Optional)
-
-# do something with camel
+# Or if you want to use all other extra packages
+poetry install -E all  # (Optional)
 
 # Exit the virtual environment
 exit
@@ -151,7 +164,7 @@ conda create --name camel python=3.10
 conda activate camel
 
 # Clone github repo
-git clone -b v0.1.0 https://github.com/camel-ai/camel.git
+git clone -b v0.1.3 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel
@@ -159,13 +172,19 @@ cd camel
 # Install camel from source
 pip install -e .
 
-# Or if you want to use "huggingface agent"
-pip install -e .[huggingface-agent] # (Optional)
+# Or if you want to use all other extra packages
+pip install -e .[all] # (Optional)
 ```
+
+## Documentation
+
+[CAMEL package documentation pages](https://camel-ai.github.io/camel/).
+
 ## Example
-You can find a list of tasks for different set of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link)
 
-Run the `role_playing.py` script
+You can find a list of tasks for different sets of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link).
+
+As an example, to run the `role_playing.py` script:
 
 First, you need to add your OpenAI API key to system environment variables. The method to do this depends on your operating system and the shell you're using.
 
@@ -191,7 +210,6 @@ set OPENAI_API_BASE_URL=<inert your OpenAI API BASE URL>  #(Should you utilize a
 # Export your OpenAI API key
 $env:OPENAI_API_KEY="<insert your OpenAI API key>"
 $env:OPENAI_API_BASE_URL="<inert your OpenAI API BASE URL>"  #(Should you utilize an OpenAI proxy service, kindly specify this)
-
 ```
 
 Replace `<insert your OpenAI API key>` with your actual OpenAI API key in each case. Make sure there are no spaces around the `=` sign.
@@ -208,7 +226,7 @@ Please note that the environment variable is session-specific. If you open a new
 
 ## Use Open-Source Models as Backends
 
-The basic workflow of using an open-sourced model as the backend is based on an external server running LLM inference service, e.g. during the development we chose [FastChat](https://github.com/lm-sys/FastChat) to run the service. 
+The basic workflow of using an open-sourced model as the backend is based on an external server running LLM inference service, e.g. during the development we chose [FastChat](https://github.com/lm-sys/FastChat) to run the service.
 
 We do not fix the choice of server to decouple the implementation of any specific LLM inference server with CAMEL (indicating the server needs to be deployed by the user himself). But the server to be deployed must satisfy that **it supports OpenAI-compatible APIs, especially the method `openai.ChatCompletion.create`**.
 
@@ -227,7 +245,7 @@ python3 -m fastchat.serve.model_worker --model-path meta-llama/Llama-2-7b-chat-h
 python3 -m fastchat.serve.openai_api_server --host localhost --port 8000
 ```
 
-2. After observing the controller successfully receiving the heart beat signal from the worker, the server should be ready for use at http://localhost:8000/v1. 
+2. After observing the controller successfully receiving the heart beat signal from the worker, the server should be ready for use at http://localhost:8000/v1.
 
 3. Then we can try on running `role_playing_with_open_source_model.py`, where each agent in this example is initialized with specifying the `model_path` and `server_url`, similar to the example code below:
 
@@ -256,21 +274,21 @@ agent = ChatAgent(
   - example: [lmsys/vicuna-7b-v1.5](https://huggingface.co/lmsys/vicuna-7b-v1.5)
 
 ## Data (Hosted on Hugging Face)
-| Dataset | Chat format | Instruction format | Chat format (translated) |
-| -- | -- | -- | -- |
+| Dataset        | Chat format                                                                                         | Instruction format                                                                                               | Chat format (translated)                                                                   |
+|----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
 | **AI Society** | [Chat format](https://huggingface.co/datasets/camel-ai/ai_society/blob/main/ai_society_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/ai_society/blob/main/ai_society_instructions.json) | [Chat format (translated)](https://huggingface.co/datasets/camel-ai/ai_society_translated) |
-| **Code** | [Chat format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_instructions.json) | x |
-| **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x|
-| **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x |
-| **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x |
-| **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x |
+| **Code**       | [Chat format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_chat.tar.gz)             | [Instruction format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_instructions.json)             | x                                                                                          |
+| **Math**       | [Chat format](https://huggingface.co/datasets/camel-ai/math)                                        | x                                                                                                                | x                                                                                          |
+| **Physics**    | [Chat format](https://huggingface.co/datasets/camel-ai/physics)                                     | x                                                                                                                | x                                                                                          |
+| **Chemistry**  | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry)                                   | x                                                                                                                | x                                                                                          |
+| **Biology**    | [Chat format](https://huggingface.co/datasets/camel-ai/biology)                                     | x                                                                                                                | x                                                                                          |
 
 ## Visualizations of Instructions and Tasks
 
-| Dataset | Instructions | Tasks |
-| -- | -- | -- |
-| **AI Society** | [Instructions](https://atlas.nomic.ai/map/3a559a06-87d0-4476-a879-962656242452/db961915-b254-48e8-8e5c-917f827b74c6) | [Tasks](https://atlas.nomic.ai/map/cb96f41b-a6fd-4fe4-ac40-08e101714483/ae06156c-a572-46e9-8345-ebe18586d02b) |
-| **Code** | [Instructions](https://atlas.nomic.ai/map/902d6ccb-0bbb-4294-83a8-1c7d2dae03c8/ace2e146-e49f-41db-a1f4-25a2c4be2457) | [Tasks](https://atlas.nomic.ai/map/efc38617-9180-490a-8630-43a05b35d22d/2576addf-a133-45d5-89a9-6b067b6652dd) |
+| Dataset          | Instructions                                                                                                         | Tasks                                                                                                         |
+|------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
+| **AI Society**   | [Instructions](https://atlas.nomic.ai/map/3a559a06-87d0-4476-a879-962656242452/db961915-b254-48e8-8e5c-917f827b74c6) | [Tasks](https://atlas.nomic.ai/map/cb96f41b-a6fd-4fe4-ac40-08e101714483/ae06156c-a572-46e9-8345-ebe18586d02b) |
+| **Code**         | [Instructions](https://atlas.nomic.ai/map/902d6ccb-0bbb-4294-83a8-1c7d2dae03c8/ace2e146-e49f-41db-a1f4-25a2c4be2457) | [Tasks](https://atlas.nomic.ai/map/efc38617-9180-490a-8630-43a05b35d22d/2576addf-a133-45d5-89a9-6b067b6652dd) |
 | **Misalignment** | [Instructions](https://atlas.nomic.ai/map/5c491035-a26e-4a05-9593-82ffb2c3ab40/2bd98896-894e-4807-9ed8-a203ccb14d5e) | [Tasks](https://atlas.nomic.ai/map/abc357dd-9c04-4913-9541-63e259d7ac1f/825139a4-af66-427c-9d0e-f36b5492ab3f) |
 
 ## Implemented Research Ideas from Other Works
@@ -293,12 +311,10 @@ We implemented amazing research ideas from other works for you to build, compare
 ## Acknowledgement
 Special thanks to [Nomic AI](https://home.nomic.ai/) for giving us extended access to their data set exploration tool (Atlas).
 
-We would also like to thank Haya Hammoud for designing the logo of our project.
+We would also like to thank Haya Hammoud for designing the initial logo of our project.
 
 ## License
 
-The intended purpose and licensing of CAMEL is solely for research use.
-
 The source code is licensed under Apache 2.0.
 
 The datasets are licensed under CC BY NC 4.0, which permits only non-commercial usage. It is advised that any models trained using the dataset should not be utilized for anything other than research purposes.
@@ -309,3 +325,29 @@ We appreciate your interest in contributing to our open-source initiative. We pr
 ## Contact
 For more information please contact camel.ai.team@gmail.com.
 
+[python-image]: https://img.shields.io/badge/Python-3.9%2B-brightgreen.svg
+[python-url]: https://docs.python.org/3.9/
+[pytest-image]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml/badge.svg
+[pytest-url]: https://github.com/camel-ai/camel/actions/workflows/pytest_package.yml
+[docs-image]: https://img.shields.io/badge/Documentation-grey.svg?logo=github
+[docs-url]: https://camel-ai.github.io/camel/index.html
+[star-image]: https://img.shields.io/github/stars/camel-ai/camel?label=stars&logo=github&color=brightgreen
+[star-url]: https://github.com/camel-ai/camel/stargazers
+[package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
+[package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE
+[data-license-image]: https://img.shields.io/badge/License-CC_BY--NC_4.0-lightgrey.svg
+[data-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/DATA_LICENSE
+
+[colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
+[colab-image]: https://colab.research.google.com/assets/colab-badge.svg
+[huggingface-url]: https://huggingface.co/camel-ai
+[huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white
+[slack-url]: https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ
+[slack-image]: https://img.shields.io/badge/Slack-CAMEL--AI-blueviolet?logo=slack
+[discord-url]: https://discord.gg/CNcNpquyDc
+[discord-image]: https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da
+[wechat-url]: https://ghli.org/camel/wechat.png
+[wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white
+[twitter-url]: https://twitter.com/CamelAIOrg
+[twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter
+