From 112ed18575872c1f30afad2ef0a22224ddb9ff90 Mon Sep 17 00:00:00 2001
From: fly2tomato <xuju5220@gmail.com>
Date: Wed, 17 Jan 2024 19:38:15 +0800
Subject: [PATCH] [Doc]: update introduction of OpenAOE (#605)

---
 chat/openaoe.md       | 18 +++++++++---------
 chat/openaoe_zh_cn.md | 18 +++++++++---------
 2 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/chat/openaoe.md b/chat/openaoe.md
index 056e59e..aec3861 100644
--- a/chat/openaoe.md
+++ b/chat/openaoe.md
@@ -28,19 +28,19 @@ openaoe -f /path/to/your/config-template.yaml
 There are two ways to get the OpenAOE docker image by:
 1. pull the OpenAOE docker image
 ```shell
-docker pull openaoe:latest
+docker pull opensealion/openaoe:latest
 ```
 
 2. or build a docker image
 ```shell
 git clone https://github.com/internlm/OpenAOE
-cd open-aoe
+cd OpenAOE
 docker build . -f docker/Dockerfile -t openaoe:latest
 ```
 
 #### **Start**
 ```shell
-docker run -p 10099:10099 -v /path/to/your/config-template.yaml:/app/config-template.yaml --name OpenAOE openaoe:latest
+docker run -p 10099:10099 -v /path/to/your/config-template.yaml:/app/config.yaml --name OpenAOE opensealion/openaoe:latest
 ```
 
 ### Run by source code
@@ -51,7 +51,7 @@ git clone https://github.com/internlm/OpenAOE
 ```
 2. [_optional_] build the frontend project when the frontend codes are changed
 ```shell
-cd open-aoe/openaoe/frontend
+cd OpenAOE/openaoe/frontend
 npm install
 npm run build
 ```
@@ -59,13 +59,13 @@ npm run build
 
 #### **Start**
 ```shell
-cd open-aoe/openaoe
-pip install -r backend/requirements.txt
-python -m main -f /path/to/your/config-template.yaml
+cd OpenAOE
+pip install -r openaoe/backend/requirements.txt
+python -m openaoe.main -f /path/to/your/config-template.yaml
 ```
 
 > [!TIP]
-> `/path/to/your/config.yaml` is the configuration file loaded by OpenAOE at startup,
+> `/path/to/your/config-tempalte.yaml` is the configuration file loaded by OpenAOE at startup,
 > which contains the relevant configuration information for the LLMs,
 > including: API URLs, AKSKs, Tokens, etc.
-> A template configuration yaml file can be found in `openaoe/backend/config/config.yaml`.
+> A template configuration yaml file can be found in `openaoe/backend/config/config-template.yaml`.
diff --git a/chat/openaoe_zh_cn.md b/chat/openaoe_zh_cn.md
index 3640838..36b3240 100644
--- a/chat/openaoe_zh_cn.md
+++ b/chat/openaoe_zh_cn.md
@@ -29,19 +29,19 @@ openaoe -f /path/to/your/config-template.yaml
 有两种方式获取 OpenAOE 的 docker 镜像：
 1. 官方拉取
 ```shell
-docker pull openaoe:latest
+docker pull opensealion/openaoe:latest
 ```
 
 2. 本地构建
 ```shell
 git clone https://github.com/internlm/OpenAOE
-cd open-aoe
+cd OpenAOE
 docker build . -f docker/Dockerfile -t openaoe:latest
 ```
 
 #### **运行**
 ```shell
-docker run -p 10099:10099 -v /path/to/your/config-template.yaml:/app/config-template.yaml --name OpenAOE openaoe:latest
+docker run -p 10099:10099 -v /path/to/your/config-template.yaml:/app/config.yaml --name OpenAOE opensealion/openaoe:latest
 ```
 
 ### 基于源代码
@@ -52,7 +52,7 @@ git clone https://github.com/internlm/OpenAOE
 ```
 2. [_可选_] （如果前端代码发生变动）重新构建前端项目
 ```shell
-cd open-aoe/openaoe/frontend
+cd OpenAOE/openaoe/frontend
 npm install
 npm run build
 ```
@@ -60,11 +60,11 @@ npm run build
 
 #### **运行**
 ```shell
-cd open-aoe/openaoe
-pip install -r backend/requirements.txt
-python -m main -f /path/to/your/config-template.yaml
+cd OpenAOE
+pip install -r openaoe/backend/requirements.txt
+python -m openaoe.main -f /path/to/your/config-template.yaml
 ``````
 
 > [!TIP]
-> `/path/to/your/config.yaml` 是 OpenAOE 启动时读取的配置文件，里面包含了大模型的相关配置信息，
-> 包括：调用API地址、AKSK、Token等信息，是 OpenAOE 启动的必备文件。模板文件可以在 `openaoe/backend/config/config.yaml` 中找到。
+> `/path/to/your/config-template.yaml` 是 OpenAOE 启动时读取的配置文件，里面包含了大模型的相关配置信息，
+> 包括：调用API地址、AKSK、Token等信息，是 OpenAOE 启动的必备文件。模板文件可以在 `openaoe/backend/config/config-template.yaml` 中找到。