rearrange example docs

om-ai-lab · Dec 4, 2024 · 5aa80b5 · 5aa80b5
1 parent 23ca7b9
commit 5aa80b5
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -175,18 +175,17 @@ For a deeper comprehension of OmAgent, let us elucidate key terms:
 ## Examples
 We provide exemplary projects to demonstrate the construction of intelligent agents using OmAgent. You can find a comprehensive list in the [examples](./examples/) directory. Here is the reference sequence:
 
-1. [step1_simpleVQA](./examples/step1_simpleVQA) illustrates the creation of a simple multimodal VQA agent with OmAgent. Detailed tutorial can be found [here](docs/examples/simple_qa.md).
+1. [step1_simpleVQA](./examples/step1_simpleVQA) illustrates the creation of a simple multimodal VQA agent with OmAgent. 
 
-2. [step2_outfit_with_switch](./examples/step2_outfit_with_switch) demonstrates how to build an agent with switch-case branches using OmAgent. Detailed tutorial can be found [here](docs/examples/outfit_with_switch.md).
+2. [step2_outfit_with_switch](./examples/step2_outfit_with_switch) demonstrates how to build an agent with switch-case branches using OmAgent. 
 
-3. [step3_outfit_with_loop](./examples/step3_outfit_with_loop) shows the construction of an agent incorporating loops using OmAgent. Detailed tutorial can be found [here](docs/examples/outfit_with_loop.md).
+3. [step3_outfit_with_loop](./examples/step3_outfit_with_loop) shows the construction of an agent incorporating loops using OmAgent. 
 
-4. [step4_outfit_with_ltm](./examples/step4_outfit_with_ltm) exemplifies using OmAgent to create an agent equipped with long-term memory. Detailed tutorial can be found [here](docs/examples/outfit_with_ltm.md).
+4. [step4_outfit_with_ltm](./examples/step4_outfit_with_ltm) exemplifies using OmAgent to create an agent equipped with long-term memory. 
 
-5. [dnc_loop](./examples/general_dnc) demonstrates the development of an agent utilizing the DnC algorithm to tackle complex problems. Detailed tutorial can be found [here](docs/examples/DnC.md).
-
-6. [video_understanding](./examples/video_understanding) showcases the creation of a video understanding agent for interpreting video content using OmAgent. Detailed tutorial can be found [here](docs/examples/video_understanding.md).
+5. [dnc_loop](./examples/general_dnc) demonstrates the development of an agent utilizing the DnC algorithm to tackle complex problems. 
 
+6. [video_understanding](./examples/video_understanding) showcases the creation of a video understanding agent for interpreting video content using OmAgent. 
 
 ## API Documentation
 The API documentation is available [here](https://om-ai-lab.github.io/OmAgentDocs/).

diff --git a/README_ZH.md b/README_ZH.md
@@ -156,12 +156,12 @@ OmAgent的设计架构遵循三项基本原则：
 ### 示例项目
 
 我们提供了一些示例项目来展示如何使用OmAgent构建智能智能体程序。您可以在 [examples](./examples/) 目录中找到完整的示例列表。以下是参考顺序：
-1. [step1_simpleVQA](./examples/step1_simpleVQA) 展示了如何使用OmAgent构建一个简单的多模态VQA智能体。[文档](docs/examples/simple_qa.md)  
-2. [step2_outfit_with_switch](./examples/step2_outfit_with_switch) 展示了如何使用OmAgent构建一个带有switch-case分支的智能体。[文档](docs/examples/outfit_with_switch.md)  
-3. [step3_outfit_with_loop](./examples/step3_outfit_with_loop) 展示了如何使用OmAgent构建一个带有循环的智能体。[文档](docs/examples/outfit_with_loop.md)  
-4. [step4_outfit_with_ltm](./examples/step4_outfit_with_ltm) 展示了如何使用OmAgent构建一个带有长期记忆的智能体。[文档](docs/examples/outfit_with_ltm.md)  
-5. [dnc_loop](./examples/dnc_loop) 展示了如何使用OmAgent构建一个使用DnC算法的智能体，用于解决通用性的复杂问题。[文档](docs/examples/dnc_loop.md)  
-6. [video_understanding](./examples/video_understanding) 展示了如何使用OmAgent构建一个视频理解智能体，用于理解视频内容。[文档](docs/examples/video_understanding.md)  
+1. [step1_simpleVQA](./examples/step1_simpleVQA) 展示了如何使用OmAgent构建一个简单的多模态VQA智能体。
+2. [step2_outfit_with_switch](./examples/step2_outfit_with_switch) 展示了如何使用OmAgent构建一个带有switch-case分支的智能体。md)  
+3. [step3_outfit_with_loop](./examples/step3_outfit_with_loop) 展示了如何使用OmAgent构建一个带有循环的智能体。
+4. [step4_outfit_with_ltm](./examples/step4_outfit_with_ltm) 展示了如何使用OmAgent构建一个带有长期记忆的智能体。
+5. [dnc_loop](./examples/dnc_loop) 展示了如何使用OmAgent构建一个使用DnC算法的智能体，用于解决通用性的复杂问题。
+6. [video_understanding](./examples/video_understanding) 展示了如何使用OmAgent构建一个视频理解智能体，用于理解视频内容。
 
 
 ## API 文档

diff --git a/docs/examples/DnC.md → examples/general_dnc/README.md b/docs/examples/DnC.md → examples/general_dnc/README.md
@@ -58,7 +58,7 @@ This example implements a general divide-and-conquer workflow that consists of f
 
 ### This whole workflow is looked like the following diagram:
 
-![DnC Workflow](../images/general_dnc_workflow_diagram.png)
+![DnC Workflow](./docs/images/general_dnc_workflow_diagram.png)
 
 ## Prerequisites
 

diff --git a/docs/images/general_dnc_workflow_diagram.png → ...s/images/general_dnc_workflow_diagram.png b/docs/images/general_dnc_workflow_diagram.png → ...s/images/general_dnc_workflow_diagram.png
diff --git a/docs/examples/simple_qa.md → examples/step1_simpleVQA/README.md b/docs/examples/simple_qa.md → examples/step1_simpleVQA/README.md
diff --git a/docs/examples/outfit_with_switch.md → examples/step2_outfit_with_switch/README.md b/docs/examples/outfit_with_switch.md → examples/step2_outfit_with_switch/README.md
diff --git a/docs/examples/outfit_with_loop.md → examples/step3_outfit_with_loop/README.md b/docs/examples/outfit_with_loop.md → examples/step3_outfit_with_loop/README.md
diff --git a/docs/examples/outfit_with_ltm.md → examples/step4_outfit_with_ltm/README.md b/docs/examples/outfit_with_ltm.md → examples/step4_outfit_with_ltm/README.md
diff --git a/docs/examples/video_understanding.md → examples/video_understanding/README.md b/docs/examples/video_understanding.md → examples/video_understanding/README.md
@@ -31,7 +31,7 @@ The system uses Redis for state management, Milvus for long-tern memory storage
 
 ### This whole workflow is looked like the following diagram:
 
-![Video Understanding Workflow](../images/video_understanding_workflow_diagram.png)
+![Video Understanding Workflow](./docs/images/video_understanding_workflow_diagram.png)
 
 ## Prerequisites
 

diff --git a/.../video_understanding_workflow_diagram.png → .../video_understanding_workflow_diagram.png b/.../video_understanding_workflow_diagram.png → .../video_understanding_workflow_diagram.png