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

docs: Fix the indentation and list all key modules (#2510)

Sarthak Bhardwaj2998f3256db2
diff --git a/docs/key_modules/agents.md b/docs/key_modules/agents.md
index 5ea267a1b..4b9138f0e 100644
--- a/docs/key_modules/agents.md
+++ b/docs/key_modules/agents.md
@@ -1,5 +1,3 @@
-# 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/key_modules/datagen.md b/docs/key_modules/datagen.md
index f695205f8..1c8276b04 100644
--- a/docs/key_modules/datagen.md
+++ b/docs/key_modules/datagen.md
@@ -1,5 +1,3 @@
-# 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/key_modules/embeddings.md b/docs/key_modules/embeddings.md
index c70278b71..67bc17528 100644
--- a/docs/key_modules/embeddings.md
+++ b/docs/key_modules/embeddings.md
@@ -1,5 +1,3 @@
-# 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/key_modules/interpreters.md b/docs/key_modules/interpreters.md
index 6efc6b896..a3d6d5cd2 100644
--- a/docs/key_modules/interpreters.md
+++ b/docs/key_modules/interpreters.md
@@ -1,5 +1,3 @@
-# Interpreters
-
## 1. Concept
Interpreters are tools that empower the agents to execute given code snippets
on local machine.
diff --git a/docs/key_modules/loaders.md b/docs/key_modules/loaders.md
index 33a98fee6..eb7630cf0 100644
--- a/docs/key_modules/loaders.md
+++ b/docs/key_modules/loaders.md
@@ -1,5 +1,3 @@
-# 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/key_modules/memory.md b/docs/key_modules/memory.md
index 4a33a505e..83289d13a 100644
--- a/docs/key_modules/memory.md
+++ b/docs/key_modules/memory.md
@@ -1,5 +1,3 @@
-# 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/key_modules/messages.md b/docs/key_modules/messages.md
index dddbadb1c..65c4aea76 100644
--- a/docs/key_modules/messages.md
+++ b/docs/key_modules/messages.md
@@ -1,5 +1,3 @@
-# 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/key_modules/models.md b/docs/key_modules/models.md
index f1c41a7f0..35bfe88c5 100644
--- a/docs/key_modules/models.md
+++ b/docs/key_modules/models.md
@@ -1,5 +1,3 @@
-# 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/key_modules/prompts.md b/docs/key_modules/prompts.md
index c596da075..3f58470b8 100644
--- a/docs/key_modules/prompts.md
+++ b/docs/key_modules/prompts.md
@@ -1,5 +1,3 @@
-# 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/key_modules/retrievers.md b/docs/key_modules/retrievers.md
index 4c567a642..3eb32827f 100644
--- a/docs/key_modules/retrievers.md
+++ b/docs/key_modules/retrievers.md
@@ -1,5 +1,3 @@
-# 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/key_modules/runtimes.md b/docs/key_modules/runtimes.md
index e4ed74c29..5dab6f305 100644
--- a/docs/key_modules/runtimes.md
+++ b/docs/key_modules/runtimes.md
@@ -1,5 +1,3 @@
-# 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/key_modules/society.md b/docs/key_modules/society.md
index eac5aa772..b48cbf02c 100644
--- a/docs/key_modules/society.md
+++ b/docs/key_modules/society.md
@@ -1,4 +1,3 @@
-# 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/key_modules/storages.md b/docs/key_modules/storages.md
index b966042b3..d16ef851b 100644
--- a/docs/key_modules/storages.md
+++ b/docs/key_modules/storages.md
@@ -1,4 +1,3 @@
-# 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.
diff --git a/docs/key_modules/tasks.md b/docs/key_modules/tasks.md
index 0ad7ed819..cb4b5afb9 100644
--- a/docs/key_modules/tasks.md
+++ b/docs/key_modules/tasks.md
@@ -1,5 +1,3 @@
-# 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/key_modules/tools.md b/docs/key_modules/tools.md
index 8f6d0e1b3..8436ee68a 100644
--- a/docs/key_modules/tools.md
+++ b/docs/key_modules/tools.md
@@ -1,5 +1,3 @@
-# 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/key_modules/workforce.md b/docs/key_modules/workforce.md
index 54ecb441d..2e49b2603 100644
--- a/docs/key_modules/workforce.md
+++ b/docs/key_modules/workforce.md
@@ -1,5 +1,3 @@
-# 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
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 45a8cefc5..9efdc8e93 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -53,6 +53,11 @@
{
"group": "Key Modules",
"pages": [
+ "key_modules/agents",
+ "key_modules/datagen",
+ "key_modules/interpreters",
+ "key_modules/runtimes",
+ "key_modules/society",
"key_modules/models",
"key_modules/messages",
"key_modules/memory",