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: core module add link jump to cookbook (#1057)

Wendong-Fancc83c9458439
diff --git a/docs/get_started/setup.md b/docs/get_started/setup.md
index 03d07accf..62b7b574b 100644
--- a/docs/get_started/setup.md
+++ b/docs/get_started/setup.md
@@ -22,14 +22,14 @@ If you are using Command Prompt:
```bash
set OPENAI_API_KEY="your_api_key"
-# If you are using other proxy services like Azure [TODO]
+# If you are using other proxy services
# set OPENAI_API_BASE_URL="your_base_url" # (Optional)
```
Or if you are using PowerShell:
```powershell
$env:OPENAI_API_KEY="your_api_key"
-# If you are using other proxy services like Azure
+# If you are using other proxy services
$env:OPENAI_API_BASE_URL="your_base_url" # (Optional)
```
These commands on Windows will set the environment variable for the duration of that particular Command Prompt or PowerShell session only. You may use `setx` or change the system properties dialog for the change to take place in all the new sessions.
diff --git a/docs/index.rst b/docs/index.rst
index e5f178f14..c5ccb02c4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -42,6 +42,7 @@ Main Documentation
key_modules/tasks.md
key_modules/loaders.md
key_modules/storages.md
+ key_modules/society.md
key_modules/embeddings.md
key_modules/retrievers.md
key_modules/workforce.md
diff --git a/docs/key_modules/memory.md b/docs/key_modules/memory.md
index 9d1771be0..21ae1a8ed 100644
--- a/docs/key_modules/memory.md
+++ b/docs/key_modules/memory.md
@@ -1,5 +1,7 @@
# Memory
+For more detailed usage information, please refer to our cookbook: [Memory Cookbook](../cookbooks/agents_with_memory.ipynb)
+
## 1. Concept
The Memory module in CAMEL provides a flexible and powerful system for storing, retrieving, and managing information for AI agents. It enables agents to maintain context across conversations and retrieve relevant information from past interactions, enhancing the coherence and relevance of AI responses.
diff --git a/docs/key_modules/models.md b/docs/key_modules/models.md
index 82863917f..5d9e95c5c 100644
--- a/docs/key_modules/models.md
+++ b/docs/key_modules/models.md
@@ -23,6 +23,7 @@ The following table lists currently supported model platforms by CAMEL.
| Azure OpenAI | gpt-3.5-turbo | Y |
| OpenAI Compatible | Depends on the provider | ----- |
| Mistral AI | mistral-large-2 | N |
+| Mistral AI | pixtral-12b-2409 | Y |
| Mistral AI | open-mistral-nemo | N |
| Mistral AI | codestral | N |
| Mistral AI | open-mistral-7b | N |
@@ -94,8 +95,6 @@ model = OpenAICompatibilityModel(
## 4. Using On-Device Open Source Models
In the current landscape, for those seeking highly stable content generation, OpenAI’s gpt-4o-mini, gpt-4o are often recommended. However, the field is rich with many other outstanding open-source models that also yield commendable results. CAMEL can support developers to delve into integrating these open-source large language models (LLMs) to achieve project outputs based on unique input ideas.
-While proprietary models like gpt-4o-mini and gpt-4o have set high standards for content generation, open-source alternatives offer viable solutions for experimentation and practical use. These models, supported by active communities and continuous improvements, provide flexibility and cost-effectiveness for developers and researchers.
-
### 4.1 Using Ollama to Set Llama 3 Locally
1. Download [Ollama](https://ollama.com/download).
diff --git a/docs/key_modules/retrievers.md b/docs/key_modules/retrievers.md
index de2392e14..04e17b8d8 100644
--- a/docs/key_modules/retrievers.md
+++ b/docs/key_modules/retrievers.md
@@ -1,4 +1,7 @@
# Retrievers
+
+For more detailed usage information, please refer to our cookbook: [RAG Cookbook](../cookbooks/agents_with_rag.ipynb)
+
## 1. Concept
The Retrievers module is essentially a search engine. It's designed to help you find specific pieces of information by searching through large volumes of text. Imagine you have a huge library of books and you want to find where certain topics or keywords are mentioned, this module is like a librarian that helps you do just that.
diff --git a/docs/key_modules/tasks.md b/docs/key_modules/tasks.md
index 6e62973df..d4faecc12 100644
--- a/docs/key_modules/tasks.md
+++ b/docs/key_modules/tasks.md
@@ -1,5 +1,7 @@
# Task
+For more detailed usage information, please refer to our cookbook: [Task Generation Cookbook](../cookbooks/task_generation.ipynb)
+
## 1. Concept
> In the CAMEL framework, a task is a specific assignment that can be delegated to an agent and resolved by that agent. Tasks represent a higher-level concept than prompts and should be managed by other modules such as the Planner and Workforce. There are two key characteristics of a task:
> 1. A task can be collaborative, requiring multiple agents to work together.
diff --git a/docs/key_modules/tools.md b/docs/key_modules/tools.md
index 4018b7f9c..264289b29 100644
--- a/docs/key_modules/tools.md
+++ b/docs/key_modules/tools.md
@@ -1,5 +1,7 @@
# Tools
+For more detailed usage information, please refer to our cookbook: [Tools Cookbook](../cookbooks/agents_with_tools.ipynb)
+
## 1. Concept
Tools serve as interfaces that allow LLMs and Agents to interact with the world. A tool is essentially a function that has a name, a description, input parameters, and an output type. In this section, we will introduce the tools currently supported by CAMEL and explain how to define your own tools and Toolkits.
diff --git a/docs/key_modules/workforce.md b/docs/key_modules/workforce.md
index fe437ccfe..b5aac4beb 100644
--- a/docs/key_modules/workforce.md
+++ b/docs/key_modules/workforce.md
@@ -6,6 +6,8 @@
> brief view on the architecture of workforce, and how you can configure
> and utilize it to solve tasks.
+For more detailed usage information, please refer to our cookbook: [Create A Hackathon Judge Committee with Workforce](../cookbooks/workforce_judge_committee.ipynb)
+
## System Design
### Architecture