github
/
InternLM
mirror of https://github.com/InternLM/InternLM
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[Doc]: update introduction of OpenAOE (#605)

pull/611/head
fly2tomato 2024-01-17 19:38:15 +08:00 committed by GitHub
parent 70478bfc61
commit 112ed18575
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
chat/openaoe.md
View File

@ -28,19 +28,19 @@ openaoe -f /path/to/your/config-template.yaml
There are two ways to get the OpenAOE docker image by: There are two ways to get the OpenAOE docker image by:
1. pull the OpenAOE docker image 1. pull the OpenAOE docker image
```shell ```shell
docker pull openaoe:latest docker pull opensealion/openaoe:latest
``` ```
2. or build a docker image 2. or build a docker image
```shell ```shell
git clone https://github.com/internlm/OpenAOE git clone https://github.com/internlm/OpenAOE
cd open-aoe cd OpenAOE
docker build . -f docker/Dockerfile -t openaoe:latest docker build . -f docker/Dockerfile -t openaoe:latest
``` ```
#### **Start** #### **Start**
```shell ```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 ### 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 2. [_optional_] build the frontend project when the frontend codes are changed
```shell ```shell
cd open-aoe/openaoe/frontend cd OpenAOE/openaoe/frontend
npm install npm install
npm run build npm run build
``` ```
@ -59,13 +59,13 @@ npm run build
#### **Start** #### **Start**
```shell ```shell
cd open-aoe/openaoe cd OpenAOE
pip install -r backend/requirements.txt pip install -r openaoe/backend/requirements.txt
python -m main -f /path/to/your/config-template.yaml python -m openaoe.main -f /path/to/your/config-template.yaml
``` ```
> [!TIP] > [!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, > which contains the relevant configuration information for the LLMs,
> including: API URLs, AKSKs, Tokens, etc. > 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`.

18
chat/openaoe_zh_cn.md
View File

@ -29,19 +29,19 @@ openaoe -f /path/to/your/config-template.yaml
有两种方式获取 OpenAOE 的 docker 镜像： 有两种方式获取 OpenAOE 的 docker 镜像：
1. 官方拉取 1. 官方拉取
```shell ```shell
docker pull openaoe:latest docker pull opensealion/openaoe:latest
``` ```
2. 本地构建 2. 本地构建
```shell ```shell
git clone https://github.com/internlm/OpenAOE git clone https://github.com/internlm/OpenAOE
cd open-aoe cd OpenAOE
docker build . -f docker/Dockerfile -t openaoe:latest docker build . -f docker/Dockerfile -t openaoe:latest
``` ```
#### **运行** #### **运行**
```shell ```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. [_可选_] （如果前端代码发生变动）重新构建前端项目 2. [_可选_] （如果前端代码发生变动）重新构建前端项目
```shell ```shell
cd open-aoe/openaoe/frontend cd OpenAOE/openaoe/frontend
npm install npm install
npm run build npm run build
``` ```
@ -60,11 +60,11 @@ npm run build
#### **运行** #### **运行**
```shell ```shell
cd open-aoe/openaoe cd OpenAOE
pip install -r backend/requirements.txt pip install -r openaoe/backend/requirements.txt
python -m main -f /path/to/your/config-template.yaml python -m openaoe.main -f /path/to/your/config-template.yaml
`````` ``````
> [!TIP] > [!TIP]
> `/path/to/your/config.yaml` 是 OpenAOE 启动时读取的配置文件，里面包含了大模型的相关配置信息， > `/path/to/your/config-template.yaml` 是 OpenAOE 启动时读取的配置文件，里面包含了大模型的相关配置信息，
> 包括：调用API地址、AKSK、Token等信息，是 OpenAOE 启动的必备文件。模板文件可以在 `openaoe/backend/config/config.yaml` 中找到。 > 包括：调用API地址、AKSK、Token等信息，是 OpenAOE 启动的必备文件。模板文件可以在 `openaoe/backend/config/config-template.yaml` 中找到。