camel-ai 0.2.3__py3-none-any.whl → 0.2.3a0__py3-none-any.whl

camel/utils/token_counting.py

@@ -20,15 +20,10 @@ 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.types import (
-    ModelType,
-    OpenAIImageType,
-    OpenAIVisionDetailType,
-    UnifiedModelType,
-)
-from camel.utils import dependencies_required
+from camel.types import ModelType, OpenAIImageType, OpenAIVisionDetailType
 
 if TYPE_CHECKING:
     from mistral_common.protocol.instruct.request import (  # type:ignore[import-not-found]
@@ -45,6 +40,145 @@ SQUARE_TOKENS = 170
 EXTRA_TOKENS = 85
 
 
+def messages_to_prompt(messages: List[OpenAIMessage], model: ModelType) -> str:
+    r"""Parse the message list into a single prompt following model-specific
+    formats.
+
+    Args:
+        messages (List[OpenAIMessage]): Message list with the chat history
+            in OpenAI API format.
+        model (ModelType): Model type for which messages will be parsed.
+
+    Returns:
+        str: A single prompt summarizing all the messages.
+    """
+    system_message = messages[0]["content"]
+
+    ret: str
+    if model in [
+        ModelType.LLAMA_2,
+        ModelType.LLAMA_3,
+        ModelType.GROQ_LLAMA_3_8B,
+        ModelType.GROQ_LLAMA_3_70B,
+    ]:
+        # reference: https://github.com/facebookresearch/llama/blob/cfc3fc8c1968d390eb830e65c63865e980873a06/llama/generation.py#L212
+        seps = [" ", " </s><s>"]
+        role_map = {"user": "[INST]", "assistant": "[/INST]"}
+
+        system_prompt = f"[INST] <<SYS>>\n{system_message}\n<</SYS>>\n\n"
+        ret = ""
+        for i, msg in enumerate(messages[1:]):
+            role = role_map[msg["role"]]
+            content = msg["content"]
+            if content:
+                if not isinstance(content, str):
+                    raise ValueError(
+                        "Currently multimodal context is not "
+                        "supported by the token counter."
+                    )
+                if i == 0:
+                    ret += system_prompt + content
+                else:
+                    ret += role + " " + content + seps[i % 2]
+            else:
+                ret += role
+        return ret
+    elif model in [ModelType.VICUNA, ModelType.VICUNA_16K]:
+        seps = [" ", "</s>"]
+        role_map = {"user": "USER", "assistant": "ASSISTANT"}
+
+        system_prompt = f"{system_message}"
+        ret = system_prompt + seps[0]
+        for i, msg in enumerate(messages[1:]):
+            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."
+                )
+            if content:
+                ret += role + ": " + content + seps[i % 2]
+            else:
+                ret += role + ":"
+        return ret
+    elif model == ModelType.GLM_4_OPEN_SOURCE:
+        system_prompt = f"[gMASK]<sop><|system|>\n{system_message}"
+        ret = system_prompt
+        for msg in messages[1:]:
+            role = msg["role"]
+            content = msg["content"]
+            if not isinstance(content, str):
+                raise ValueError(
+                    "Currently multimodal context is not "
+                    "supported by the token counter."
+                )
+            if content:
+                ret += "<|" + role + "|>" + "\n" + content
+            else:
+                ret += "<|" + role + "|>" + "\n"
+        return ret
+    elif model == ModelType.QWEN_2:
+        system_prompt = f"<|im_start|>system\n{system_message}<|im_end|>"
+        ret = system_prompt + "\n"
+        for msg in messages[1:]:
+            role = msg["role"]
+            content = msg["content"]
+            if not isinstance(content, str):
+                raise ValueError(
+                    "Currently multimodal context is not "
+                    "supported by the token counter."
+                )
+            if content:
+                ret += (
+                    '<|im_start|>'
+                    + role
+                    + '\n'
+                    + content
+                    + '<|im_end|>'
+                    + '\n'
+                )
+            else:
+                ret += '<|im_start|>' + role + '\n'
+        return ret
+    elif model == ModelType.GROQ_MIXTRAL_8_7B:
+        # Mistral/Mixtral format
+        system_prompt = f"<s>[INST] {system_message} [/INST]\n"
+        ret = system_prompt
+
+        for msg in messages[1:]:
+            if msg["role"] == "user":
+                ret += f"[INST] {msg['content']} [/INST]\n"
+            elif msg["role"] == "assistant":
+                ret += f"{msg['content']}</s>\n"
+
+            if not isinstance(msg['content'], str):
+                raise ValueError(
+                    "Currently multimodal context is not "
+                    "supported by the token counter."
+                )
+
+        return ret.strip()
+    elif model in [ModelType.GROQ_GEMMA_7B_IT, ModelType.GROQ_GEMMA_2_9B_IT]:
+        # Gemma format
+        ret = f"<bos>{system_message}\n"
+        for msg in messages:
+            if msg["role"] == "user":
+                ret += f"Human: {msg['content']}\n"
+            elif msg["role"] == "assistant":
+                ret += f"Assistant: {msg['content']}\n"
+
+            if not isinstance(msg['content'], str):
+                raise ValueError(
+                    "Currently multimodal context is not supported by the token counter."
+                )
+
+        ret += "<eos>"
+        return ret
+    else:
+        raise ValueError(f"Invalid model type: {model}")
+
+
 def get_model_encoding(value_for_tiktoken: str):
     r"""Get model encoding from tiktoken.
 
@@ -87,15 +221,67 @@ class BaseTokenCounter(ABC):
         pass
 
 
+class OpenSourceTokenCounter(BaseTokenCounter):
+    def __init__(self, model_type: ModelType, model_path: str):
+        r"""Constructor for the token counter for open-source models.
+
+        Args:
+            model_type (ModelType): Model type for which tokens will be
+                counted.
+            model_path (str): The path to the model files, where the tokenizer
+                model should be located.
+        """
+
+        # Use a fast Rust-based tokenizer if it is supported for a given model.
+        # 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,
+                use_fast=True,
+            )
+        except TypeError:
+            tokenizer = AutoTokenizer.from_pretrained(
+                model_path,
+                use_fast=False,
+            )
+        except Exception:
+            raise ValueError(
+                f"Invalid `model_path` ({model_path}) is provided. "
+                "Tokenizer loading failed."
+            )
+
+        self.tokenizer = tokenizer
+        self.model_type = model_type
+
+    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)
+        input_ids = self.tokenizer(prompt).input_ids
+
+        return len(input_ids)
+
+
 class OpenAITokenCounter(BaseTokenCounter):
-    def __init__(self, model: UnifiedModelType):
+    def __init__(self, model: ModelType):
         r"""Constructor for the token counter for OpenAI models.
 
         Args:
-            model (UnifiedModelType): 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
+        self.model_type = model
 
         self.tokens_per_message: int
         self.tokens_per_name: int
@@ -218,11 +404,15 @@ class OpenAITokenCounter(BaseTokenCounter):
 
 
 class AnthropicTokenCounter(BaseTokenCounter):
-    @dependencies_required('anthropic')
-    def __init__(self):
-        r"""Constructor for the token counter for Anthropic models."""
-        from anthropic import Anthropic
+    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()
 
@@ -245,16 +435,12 @@ class AnthropicTokenCounter(BaseTokenCounter):
 
 
 class GeminiTokenCounter(BaseTokenCounter):
-    def __init__(self, model_type: UnifiedModelType):
-        r"""Constructor for the token counter for Gemini models.
-
-        Args:
-            model_type (UnifiedModelType): Model type for which tokens will be
-                counted.
-        """
+    def __init__(self, model_type: ModelType):
+        r"""Constructor for the token counter for Gemini models."""
         import google.generativeai as genai
 
-        self._client = genai.GenerativeModel(model_type)
+        self.model_type = model_type
+        self._client = genai.GenerativeModel(self.model_type.value)
 
     def count_tokens_from_messages(self, messages: List[OpenAIMessage]) -> int:
         r"""Count number of tokens in the provided message list using
@@ -282,13 +468,12 @@ class GeminiTokenCounter(BaseTokenCounter):
         return self._client.count_tokens(converted_messages).total_tokens
 
 
-class LiteLLMTokenCounter(BaseTokenCounter):
-    def __init__(self, model_type: UnifiedModelType):
+class LiteLLMTokenCounter:
+    def __init__(self, model_type: str):
         r"""Constructor for the token counter for LiteLLM models.
 
         Args:
-            model_type (UnifiedModelType): Model type for which tokens will be
-                counted.
+            model_type (str): Model type for which tokens will be counted.
         """
         self.model_type = model_type
         self._token_counter = None
@@ -353,10 +538,7 @@ class MistralTokenCounter(BaseTokenCounter):
         model_name = (
             "codestral-22b"
             if self.model_type
-            in {
-                ModelType.MISTRAL_CODESTRAL,
-                ModelType.MISTRAL_CODESTRAL_MAMBA,
-            }
+            in {ModelType.MISTRAL_CODESTRAL, ModelType.MISTRAL_CODESTRAL_MAMBA}
             else self.model_type.value
         )
 

camel/workforce/role_playing_worker.py

@@ -172,7 +172,7 @@ class RolePlayingWorker(Worker):
             role_name="User",
             content=prompt,
         )
-        response = self.summarize_agent.step(req, response_format=TaskResult)
+        response = self.summarize_agent.step(req, output_schema=TaskResult)
         result_dict = ast.literal_eval(response.msg.content)
         task_result = TaskResult(**result_dict)
         task.result = task_result.content

camel/workforce/single_agent_worker.py

@@ -77,7 +77,7 @@ class SingleAgentWorker(Worker):
             content=prompt,
         )
         try:
-            response = self.worker.step(req, response_format=TaskResult)
+            response = self.worker.step(req, output_schema=TaskResult)
         except Exception as e:
             print(
                 f"{Fore.RED}Error occurred while processing task {task.id}:"

camel/workforce/task_channel.py

@@ -21,13 +21,12 @@ from camel.tasks import Task
 class PacketStatus(Enum):
     r"""The status of a packet. The packet can be in one of the following
     states:
-
     - ``SENT``: The packet has been sent to a worker.
     - ``RETURNED``: The packet has been returned by the worker, meaning that
-      the status of the task inside has been updated.
+            the status of the task inside has been updated.
     - ``ARCHIVED``: The packet has been archived, meaning that the content of
-      the task inside will not be changed. The task is considered
-      as a dependency.
+            the task inside will not be changed. The task is considered
+            as a dependency.
     """
 
     SENT = "SENT"

camel/workforce/workforce.py

@@ -287,7 +287,7 @@ class Workforce(BaseNode):
         )
 
         response = self.coordinator_agent.step(
-            req, response_format=TaskAssignResult
+            req, output_schema=TaskAssignResult
         )
         result_dict = ast.literal_eval(response.msg.content)
         task_assign_result = TaskAssignResult(**result_dict)
@@ -319,7 +319,7 @@ class Workforce(BaseNode):
             role_name="User",
             content=prompt,
         )
-        response = self.coordinator_agent.step(req, response_format=WorkerConf)
+        response = self.coordinator_agent.step(req, output_schema=WorkerConf)
         result_dict = ast.literal_eval(response.msg.content)
         new_node_conf = WorkerConf(**result_dict)
 
@@ -364,8 +364,8 @@ class Workforce(BaseNode):
         ).as_dict()
 
         model = ModelFactory.create(
-            model_platform=ModelPlatformType.DEFAULT,
-            model_type=ModelType.DEFAULT,
+            model_platform=ModelPlatformType.OPENAI,
+            model_type=ModelType.GPT_4O,
             model_config_dict=model_config_dict,
         )
 

{camel_ai-0.2.3.dist-info → camel_ai-0.2.3a0.dist-info}/METADATA

@@ -1,17 +1,16 @@
 Metadata-Version: 2.1
 Name: camel-ai
-Version: 0.2.3
+Version: 0.2.3a0
 Summary: Communicative Agents for AI Society Study
 Home-page: https://www.camel-ai.org/
 License: Apache-2.0
 Keywords: communicative-ai,ai-societies,artificial-intelligence,deep-learning,multi-agent-systems,cooperative-ai,natural-language-processing,large-language-models
 Author: CAMEL-AI.org
-Requires-Python: >=3.10,<3.13
+Requires-Python: >=3.10.0,<3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: all
 Provides-Extra: encoders
 Provides-Extra: graph-storages
@@ -28,10 +27,7 @@ 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: agentops (>=0.3.6,<0.4.0) ; extra == "tools" or extra == "all"
-Requires-Dist: anthropic (>=0.29.0,<0.30.0) ; extra == "model-platforms" or extra == "all"
-Requires-Dist: arxiv (>=2.1.3,<3.0.0) ; extra == "tools" or extra == "all"
-Requires-Dist: arxiv2text (>=0.1.14,<0.2.0) ; extra == "tools" or extra == "all"
-Requires-Dist: asknews (>=0.7.43,<0.8.0) ; extra == "tools" or extra == "all"
+Requires-Dist: anthropic (>=0.29.0,<0.30.0)
 Requires-Dist: azure-storage-blob (>=12.21.0,<13.0.0) ; extra == "object-storages" or extra == "all"
 Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "tools" or extra == "all"
 Requires-Dist: botocore (>=1.35.3,<2.0.0) ; extra == "object-storages" or extra == "all"
@@ -50,12 +46,13 @@ Requires-Dist: firecrawl-py (>=1.0.0,<2.0.0) ; extra == "tools" or extra == "all
 Requires-Dist: google-cloud-storage (>=2.18.0,<3.0.0) ; extra == "object-storages" or extra == "all"
 Requires-Dist: google-generativeai (>=0.6.0,<0.7.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: googlemaps (>=4.10.0,<5.0.0) ; extra == "tools" or extra == "all"
+Requires-Dist: groq (>=0.5.0,<0.6.0)
 Requires-Dist: imageio[pyav] (>=2.34.2,<3.0.0) ; extra == "tools" or extra == "all"
-Requires-Dist: ipykernel (>=6.0.0,<7.0.0) ; extra == "tools" or extra == "all"
+Requires-Dist: ipykernel (>=6.0.0,<7.0.0)
 Requires-Dist: jsonschema (>=4,<5)
 Requires-Dist: jupyter_client (>=8.6.2,<9.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: litellm (>=1.38.1,<2.0.0) ; extra == "model-platforms" or extra == "all"
-Requires-Dist: mistralai (>=1.1.0,<2.0.0) ; extra == "model-platforms" or extra == "all"
+Requires-Dist: mistralai (>=1.0.0,<2.0.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: mock (>=5,<6) ; extra == "test"
 Requires-Dist: nebula3-python (==3.8.2) ; extra == "rag" or extra == "graph-storages" or extra == "all"
 Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "rag" or extra == "graph-storages" or extra == "all"
@@ -67,7 +64,6 @@ Requires-Dist: openapi-spec-validator (>=0.7.1,<0.8.0) ; extra == "tools" or ext
 Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: pandoc
 Requires-Dist: pathlib (>=1.0.1,<2.0.0)
-Requires-Dist: pdfplumber (>=0.11.0,<0.12.0) ; extra == "tools" or extra == "all"
 Requires-Dist: pillow (>=10.2.0,<11.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: prance (>=23.6.21.0,<24.0.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: praw (>=7.7.1,<8.0.0) ; extra == "tools" or extra == "all"
@@ -85,18 +81,15 @@ Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0) ; extra == "rag" or extra == "retrieve
 Requires-Dist: redis (>=5.0.6,<6.0.0) ; extra == "kv-stroages" or extra == "all"
 Requires-Dist: reka-api (>=3.0.8,<4.0.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: requests_oauthlib (>=1.3.1,<2.0.0) ; extra == "tools" or extra == "all"
-Requires-Dist: scholarly[tor] (==1.7.11) ; extra == "tools" or extra == "all"
 Requires-Dist: sentence-transformers (>=3.0.1,<4.0.0) ; extra == "rag" or extra == "encoders" or extra == "all"
 Requires-Dist: sentencepiece (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
-Requires-Dist: slack-bolt (>=1.20.1,<2.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: slack-sdk (>=3.27.2,<4.0.0) ; extra == "tools" or extra == "all"
 Requires-Dist: soundfile (>=0,<1) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: textblob (>=0.18.0.post0,<0.19.0) ; extra == "tools" or extra == "all"
 Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
-Requires-Dist: torch (==2.1.0) ; (platform_system == "Darwin" and platform_machine != "arm64") and (extra == "huggingface-agent" or extra == "all")
-Requires-Dist: torch (>=2,<3) ; (platform_system != "Darwin" or platform_machine == "arm64") and (extra == "huggingface-agent" or extra == "all")
+Requires-Dist: torch (>=2,<3) ; extra == "huggingface-agent" or extra == "all"
 Requires-Dist: transformers (>=4,<5) ; extra == "huggingface-agent" or extra == "all"
-Requires-Dist: unstructured[all-docs] (>=0.14,<0.15) ; extra == "rag" or extra == "tools" or extra == "all"
+Requires-Dist: unstructured[all-docs] (>=0.10,<0.11) ; extra == "rag" or extra == "tools" or extra == "all"
 Requires-Dist: wikipedia (>=1,<2) ; extra == "search-tools" or extra == "tools" or extra == "all"
 Requires-Dist: wolframalpha (>=5.0.0,<6.0.0) ; extra == "search-tools" or extra == "tools" or extra == "all"
 Project-URL: Documentation, https://docs.camel-ai.org
@@ -112,13 +105,14 @@ Description-Content-Type: text/markdown
 
 ______________________________________________________________________
 
-# CAMEL: Finding the Scaling Laws of Agents
+# 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> |
@@ -132,14 +126,16 @@ ______________________________________________________________________
 </p>
 
 <p align="center">
-  <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo_light.png' width=800>
+  <img src='https://raw.githubusercontent.com/camel-ai/camel/master/misc/primary_logo.png' width=800>
 </p>
 
+## Overview
+The rapid advancement of conversational and chat-based language models has led to remarkable progress in complex task-solving. However, their success heavily relies on human input to guide the conversation, which can be challenging and time-consuming. This paper explores the potential of building scalable techniques to facilitate autonomous cooperation among communicative agents and provide insight into their "cognitive" processes. To address the challenges of achieving autonomous cooperation, we propose a novel communicative agent framework named *role-playing*. Our approach involves using *inception prompting* to guide chat agents toward task completion while maintaining consistency with human intentions. We showcase how role-playing can be used to generate conversational data for studying the behaviors and capabilities of chat agents, providing a valuable resource for investigating conversational language models. Our contributions include introducing a novel communicative agent framework, offering a scalable approach for studying the cooperative behaviors and capabilities of multi-agent systems, and open-sourcing our library to support research on communicative agents and beyond. The GitHub repository of this project is made publicly available on: [https://github.com/camel-ai/camel](https://github.com/camel-ai/camel).
 
 ## Community
-🐫 CAMEL is an open-source community dedicated to finding the scaling laws of 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.
+🐫 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 ([*Discord*](https://discord.camel-ai.org/), [*WeChat*](https://ghli.org/camel/wechat.png) or [*Slack*](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ)) in pushing the boundaries of finding the scaling laws of agents.
+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.
@@ -175,7 +171,7 @@ Some features require extra dependencies:
 Install `CAMEL` from source with poetry (Recommended):
 ```sh
 # Make sure your python version is later than 3.10
-# You can use pyenv to manage multiple python versions in your system
+# You can use pyenv to manage multiple python verisons in your sytstem
 
 # Clone github repo
 git clone https://github.com/camel-ai/camel.git
@@ -183,7 +179,7 @@ git clone https://github.com/camel-ai/camel.git
 # Change directory into project directory
 cd camel
 
-# If you didn't install poetry before
+# If you didn't install peotry before
 pip install poetry  # (Optional)
 
 # We suggest using python 3.10
@@ -221,7 +217,7 @@ conda create --name camel python=3.10
 conda activate camel
 
 # Clone github repo
-git clone -b v0.2.3 https://github.com/camel-ai/camel.git
+git clone -b v0.2.2 https://github.com/camel-ai/camel.git
 
 # Change directory into project directory
 cd camel
@@ -292,7 +288,35 @@ Please note that the environment variable is session-specific. If you open a new
     ```bash
     ollama pull llama3
     ```
-- Run the script. Enjoy your Llama3 model, enhanced by CAMEL's excellent agents.
+- Create a ModelFile similar the one below in your project directory.
+    ```bash
+    FROM llama3
+
+    # Set parameters
+    PARAMETER temperature 0.8
+    PARAMETER stop Result
+
+    # Sets a custom system message to specify the behavior of the chat assistant
+
+    # Leaving it blank for now.
+
+    SYSTEM """ """
+    ```
+- Create a script to get the base model (llama3) and create a custom model using the ModelFile above. Save this as a .sh file:
+    ```bash
+    #!/bin/zsh
+
+    # variables
+    model_name="llama3"
+    custom_model_name="camel-llama3"
+
+    #get the base model
+    ollama pull $model_name
+
+    #create the model file
+    ollama create $custom_model_name -f ./Llama3ModelFile
+    ```
+- Navigate to the directory where the script and ModelFile are located and run the script. Enjoy your Llama3 model, enhanced by CAMEL's excellent agents.
     ```python
     from camel.agents import ChatAgent
     from camel.messages import BaseMessage
@@ -302,6 +326,7 @@ Please note that the environment variable is session-specific. If you open a new
     ollama_model = ModelFactory.create(
         model_platform=ModelPlatformType.OLLAMA,
         model_type="llama3",
+        url="http://localhost:11434/v1",
         model_config_dict={"temperature": 0.4},
     )
 
@@ -388,7 +413,7 @@ We implemented amazing research ideas from other works for you to build, compare
   year={2023}
 }
 ```
-## Acknowledgment
+## 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 initial logo of our project.
@@ -397,14 +422,16 @@ We would also like to thank Haya Hammoud for designing the initial logo of our p
 
 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.
+
 ## Contributing to CAMEL 🐫
 We appreciate your interest in contributing to our open-source initiative. We provide a document of [contributing guidelines](https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md) which outlines the steps for contributing to CAMEL. Please refer to this guide to ensure smooth collaboration and successful contributions. 🤝🚀
 
 ## Contact
 For more information please contact camel.ai.team@gmail.com.
 
-[python-image]: https://img.shields.io/badge/Python-3.10%2C%203.11%2C%203.12-brightgreen.svg
-[python-url]: https://www.python.org/
+[python-image]: https://img.shields.io/badge/Python-3.10%2B-brightgreen.svg
+[python-url]: https://docs.python.org/3.10/
 [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
@@ -413,6 +440,8 @@ For more information please contact camel.ai.team@gmail.com.
 [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
@@ -420,7 +449,7 @@ For more information please contact camel.ai.team@gmail.com.
 [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.camel-ai.org/
+[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