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

Doc pipline update (#2515)

Tao Sun255b8d4d3ba3
diff --git a/docs/mintlify/convert_notebook2mdx.py b/docs/mintlify/convert_notebook2mdx.py
index 6f95575ea..37a2db22e 100644
--- a/docs/mintlify/convert_notebook2mdx.py
+++ b/docs/mintlify/convert_notebook2mdx.py
@@ -260,11 +260,33 @@ def convert_md_to_mdx(
# Check if there is already front matter; if not, add it
if not content.startswith('---'):
+ title = Path(md_file).stem.replace('_', ' ').title()
front_matter = """---
title: "{title}"
---
-""".format(title=Path(md_file).stem.replace('_', ' ').title())
+""".format(title=title)
+
+ # For key_modules files, remove any H1 header that matches the title to avoid duplication
+ if 'key_modules' in str(md_file):
+ # Remove H1 header that matches the title (case-insensitive)
+ h1_pattern = r'^#\s+' + re.escape(title) + r'\s*\n'
+ content = re.sub(
+ h1_pattern, '', content, flags=re.MULTILINE | re.IGNORECASE
+ )
+
+ # Also try to match the original filename-based title
+ original_title = Path(md_file).stem.replace('_', ' ')
+ h1_pattern_original = (
+ r'^#\s+' + re.escape(original_title) + r'\s*\n'
+ )
+ content = re.sub(
+ h1_pattern_original,
+ '',
+ content,
+ flags=re.MULTILINE | re.IGNORECASE,
+ )
+
content = front_matter + content
# Write to MDX file
diff --git a/docs/mintlify/key_modules/agents.mdx b/docs/mintlify/key_modules/agents.mdx
index 4c35371ea..27e240d3b 100644
--- a/docs/mintlify/key_modules/agents.mdx
+++ b/docs/mintlify/key_modules/agents.mdx
@@ -2,8 +2,6 @@
title: "Agents"
---
-# Agents
-
## 1. Concept
Agents in CAMEL are autonomous entities capable of performing specific tasks through interaction with language models and other components. Each agent is designed with a particular role and capability, allowing them to work independently or collaboratively to achieve complex goals.
diff --git a/docs/mintlify/key_modules/datagen.mdx b/docs/mintlify/key_modules/datagen.mdx
index cf910e05f..7c688767c 100644
--- a/docs/mintlify/key_modules/datagen.mdx
+++ b/docs/mintlify/key_modules/datagen.mdx
@@ -2,8 +2,6 @@
title: "Datagen"
---
-# Data Generation
-
This document describes CAMEL's key data generation modules that enable high-quality training data creation through advanced reasoning and instruction tuning techniques. The modules include:
- Chain of Thought (CoT): Generates explicit reasoning paths
diff --git a/docs/mintlify/key_modules/embeddings.mdx b/docs/mintlify/key_modules/embeddings.mdx
index a2da05a17..9f630cc7d 100644
--- a/docs/mintlify/key_modules/embeddings.mdx
+++ b/docs/mintlify/key_modules/embeddings.mdx
@@ -2,8 +2,6 @@
title: "Embeddings"
---
-# Embeddings
-
## 1. Concept
Creating embeddings for different types of data (text, images, videos) involves transforming these inputs into a numerical form that machines can understand and process efficiently. Each type of embedding focuses on capturing the essential features of its respective data type.
diff --git a/docs/mintlify/key_modules/interpreters.mdx b/docs/mintlify/key_modules/interpreters.mdx
index 94a0018ab..583c598ad 100644
--- a/docs/mintlify/key_modules/interpreters.mdx
+++ b/docs/mintlify/key_modules/interpreters.mdx
@@ -2,8 +2,6 @@
title: "Interpreters"
---
-# Interpreters
-
## 1. Concept
Interpreters are tools that empower the agents to execute given code snippets
on local machine.
diff --git a/docs/mintlify/key_modules/loaders.mdx b/docs/mintlify/key_modules/loaders.mdx
index 9bb5c0c8e..b2d7a78fa 100644
--- a/docs/mintlify/key_modules/loaders.mdx
+++ b/docs/mintlify/key_modules/loaders.mdx
@@ -2,8 +2,6 @@
title: "Loaders"
---
-# Loaders
-
## 1. Concept
CAMEL introduced two IO modules, `Base IO` and `Unstructured IO` which are designed for handling various file types and unstructured data processing.
Additionally, four new data readers were added, `Apify Reader`,`Chunkr Reader`, `Firecrawl Reader`, and `Jina_url Reader`, which enable retrieval of external data for improved data integration and analysis.
diff --git a/docs/mintlify/key_modules/memory.mdx b/docs/mintlify/key_modules/memory.mdx
index 0840a86af..116773db6 100644
--- a/docs/mintlify/key_modules/memory.mdx
+++ b/docs/mintlify/key_modules/memory.mdx
@@ -2,8 +2,6 @@
title: "Memory"
---
-# Memory
-
For more detailed usage information, please refer to our cookbook: [Memory Cookbook](../cookbooks/advanced_features/agents_with_memory.ipynb)
## 1. Concept
diff --git a/docs/mintlify/key_modules/messages.mdx b/docs/mintlify/key_modules/messages.mdx
index 5393ef8ce..67dfc3248 100644
--- a/docs/mintlify/key_modules/messages.mdx
+++ b/docs/mintlify/key_modules/messages.mdx
@@ -2,8 +2,6 @@
title: "Messages"
---
-# Message
-
## 1. Concept
The `BaseMessage` class is the base class for message objects used in the CAMEL chat system. It is designed to provide a consistent structure for the messages in the system and allow for easy conversion between different message types.
diff --git a/docs/mintlify/key_modules/models.mdx b/docs/mintlify/key_modules/models.mdx
index 5bbfe94d8..34a8a2cba 100644
--- a/docs/mintlify/key_modules/models.mdx
+++ b/docs/mintlify/key_modules/models.mdx
@@ -2,8 +2,6 @@
title: "Models"
---
-# Models
-
## 1. Concept
The model is the brain of the intelligent agent, responsible for intelligent agent, processing all input and output data to execute tasks such as text analysis, image recognition, and complex reasoning. With customizable interfaces and multiple integration options, CAMEL AI enables rapid development with leading LLMs.
diff --git a/docs/mintlify/key_modules/prompts.mdx b/docs/mintlify/key_modules/prompts.mdx
index 9313181e5..67b15aac3 100644
--- a/docs/mintlify/key_modules/prompts.mdx
+++ b/docs/mintlify/key_modules/prompts.mdx
@@ -2,8 +2,6 @@
title: "Prompts"
---
-# Prompt
-
## 1. Concept
The prompt module guides AI models to produce accurate, contextually relevant and personalized outputs. It includes various prompt templates and dictionaries designed for different tasks such as role descriptions, code generation, evaluation, text embedding, misalignment tasks, object recognition and so on. You can also create your own prompt to tailor your own AI agent.
diff --git a/docs/mintlify/key_modules/retrievers.mdx b/docs/mintlify/key_modules/retrievers.mdx
index fc43d3522..ba7342779 100644
--- a/docs/mintlify/key_modules/retrievers.mdx
+++ b/docs/mintlify/key_modules/retrievers.mdx
@@ -2,8 +2,6 @@
title: "Retrievers"
---
-# Retrievers
-
For more detailed usage information, please refer to our cookbook: [RAG Cookbook](../cookbooks/advanced_features/agents_with_rag.ipynb)
## 1. Concept
diff --git a/docs/mintlify/key_modules/runtimes.mdx b/docs/mintlify/key_modules/runtimes.mdx
index 6f96ac608..f4b01a443 100644
--- a/docs/mintlify/key_modules/runtimes.mdx
+++ b/docs/mintlify/key_modules/runtimes.mdx
@@ -2,8 +2,6 @@
title: "Runtimes"
---
-# Runtime
-
## 1. Concept
The runtime module in CAMEL allows functions and tools to be executed in
controlled environments, enabling the safe and isolated execution of code.
diff --git a/docs/mintlify/key_modules/society.mdx b/docs/mintlify/key_modules/society.mdx
index 55c2f3d1b..db54d26c9 100644
--- a/docs/mintlify/key_modules/society.mdx
+++ b/docs/mintlify/key_modules/society.mdx
@@ -2,7 +2,6 @@
title: "Society"
---
-# Society
## 1. Concept
The society module is one of the core modules of CAMEL. By simulating the information exchange process, this module studies the social behaviors among agents.
diff --git a/docs/mintlify/key_modules/storages.mdx b/docs/mintlify/key_modules/storages.mdx
index 36a8f1cab..c09006f59 100644
--- a/docs/mintlify/key_modules/storages.mdx
+++ b/docs/mintlify/key_modules/storages.mdx
@@ -2,7 +2,6 @@
title: "Storages"
---
-# Storages
## 1. Concept
The Storage module is a comprehensive framework designed for handling various types of data storage mechanisms. It is composed of abstract base classes and concrete implementations, catering to both key-value storage and vector storage systems.
@@ -257,7 +256,7 @@ from camel.storages.vectordb_storages import (
"""
Before running this example, you need to setup an OceanBase instance:
-(Option 1): OceanBase Community Edition:
+(Option 1): OceanBase Community Edition (OCE):
1. Download and install OCE from the official website:
https://www.oceanbase.com/docs/oceanbase-database
2. Start the OceanBase server and create a database user
@@ -353,7 +352,7 @@ Adding vectors in batches...
Vector count after adding batch: 1000
Querying similar vectors...
Result 1:
- ID: f33f008d-688a-468a-9a2d-e005d27ad9d8
+ ID: f33f008d-688a-468a-9a2d-e005d27ad9d9
Payload: {'idx': 496, 'batch': 'example'}
Similarity: 0.9847431876706196
Result 2:
diff --git a/docs/mintlify/key_modules/tasks.mdx b/docs/mintlify/key_modules/tasks.mdx
index d5290374e..297e67cb5 100644
--- a/docs/mintlify/key_modules/tasks.mdx
+++ b/docs/mintlify/key_modules/tasks.mdx
@@ -2,8 +2,6 @@
title: "Tasks"
---
-# Task
-
For more detailed usage information, please refer to our cookbook: [Task Generation Cookbook](../cookbooks/multi_agent_society/task_generation.ipynb)
## 1. Concept
diff --git a/docs/mintlify/key_modules/tools.mdx b/docs/mintlify/key_modules/tools.mdx
index fa280e0c1..aa77d3de5 100644
--- a/docs/mintlify/key_modules/tools.mdx
+++ b/docs/mintlify/key_modules/tools.mdx
@@ -2,8 +2,6 @@
title: "Tools"
---
-# Tools
-
For more detailed usage information, please refer to our cookbook: [Tools Cookbook](../cookbooks/advanced_features/agents_with_tools.ipynb)
## 1. Concept
diff --git a/docs/mintlify/key_modules/workforce.mdx b/docs/mintlify/key_modules/workforce.mdx
index a03d172df..853d28600 100644
--- a/docs/mintlify/key_modules/workforce.mdx
+++ b/docs/mintlify/key_modules/workforce.mdx
@@ -2,8 +2,6 @@
title: "Workforce"
---
-# Workforce
-
> Workforce is a system where multiple agents work together to solve tasks.
> By using Workforce, users can quickly set up a multi-agent task solving
> system with customized configurations. In this section, we will give a