Skip to content

Commit cc83c94

Browse files
authored
docs: core module add link jump to cookbook (#1057)
1 parent 00a0020 commit cc83c94

File tree

8 files changed

+15
-4
lines changed

8 files changed

+15
-4
lines changed

docs/get_started/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ If you are using Command Prompt:
2222
```bash
2323
set OPENAI_API_KEY="your_api_key"
2424

25-
# If you are using other proxy services like Azure [TODO]
25+
# If you are using other proxy services
2626
# set OPENAI_API_BASE_URL="your_base_url" # (Optional)
2727
```
2828
Or if you are using PowerShell:
2929
```powershell
3030
$env:OPENAI_API_KEY="your_api_key"
3131
32-
# If you are using other proxy services like Azure
32+
# If you are using other proxy services
3333
$env:OPENAI_API_BASE_URL="your_base_url" # (Optional)
3434
```
3535
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.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Main Documentation
4242
key_modules/tasks.md
4343
key_modules/loaders.md
4444
key_modules/storages.md
45+
key_modules/society.md
4546
key_modules/embeddings.md
4647
key_modules/retrievers.md
4748
key_modules/workforce.md

docs/key_modules/memory.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Memory
22

3+
For more detailed usage information, please refer to our cookbook: [Memory Cookbook](../cookbooks/agents_with_memory.ipynb)
4+
35
## 1. Concept
46
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.
57

docs/key_modules/models.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The following table lists currently supported model platforms by CAMEL.
2323
| Azure OpenAI | gpt-3.5-turbo | Y |
2424
| OpenAI Compatible | Depends on the provider | ----- |
2525
| Mistral AI | mistral-large-2 | N |
26+
| Mistral AI | pixtral-12b-2409 | Y |
2627
| Mistral AI | open-mistral-nemo | N |
2728
| Mistral AI | codestral | N |
2829
| Mistral AI | open-mistral-7b | N |
@@ -94,8 +95,6 @@ model = OpenAICompatibilityModel(
9495
## 4. Using On-Device Open Source Models
9596
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.
9697

97-
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.
98-
9998
### 4.1 Using Ollama to Set Llama 3 Locally
10099

101100
1. Download [Ollama](https://ollama.com/download).

docs/key_modules/retrievers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Retrievers
2+
3+
For more detailed usage information, please refer to our cookbook: [RAG Cookbook](../cookbooks/agents_with_rag.ipynb)
4+
25
## 1. Concept
36
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.
47

docs/key_modules/tasks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Task
22

3+
For more detailed usage information, please refer to our cookbook: [Task Generation Cookbook](../cookbooks/task_generation.ipynb)
4+
35
## 1. Concept
46
> 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:
57
> 1. A task can be collaborative, requiring multiple agents to work together.

docs/key_modules/tools.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Tools
22

3+
For more detailed usage information, please refer to our cookbook: [Tools Cookbook](../cookbooks/agents_with_tools.ipynb)
4+
35
## 1. Concept
46
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.
57

docs/key_modules/workforce.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
> brief view on the architecture of workforce, and how you can configure
77
> and utilize it to solve tasks.
88
9+
For more detailed usage information, please refer to our cookbook: [Create A Hackathon Judge Committee with Workforce](../cookbooks/workforce_judge_committee.ipynb)
10+
911
## System Design
1012

1113
### Architecture

0 commit comments

Comments
 (0)