mirror of https://github.com/InternLM/InternLM
[Doc]: add openaoe docs (#586)
* add openaoe docs add openaoe docs * Update openaoe.md * Update openaoe_zh_cn.md * Update openaoe.mdpull/593/head
parent
830944d061
commit
2ae6225891
|
@ -0,0 +1,71 @@
|
|||
# Multi-Chats by OpenAOE
|
||||
|
||||
English | [简体中文](openaoe_zh_cn.md)
|
||||
## Introduction
|
||||
[OpenAOE](https://github.com/InternLM/OpenAOE) is a LLM-Group-Chat Framework, which can chat with multiple LLMs (commercial/open source LLMs) at the same time. OpenAOE provides both backend API and WEB-UI to meet different usage needs.
|
||||
|
||||
Currently already supported LLMs: [InternLM2-Chat-7B](https://huggingface.co/internlm/internlm2-chat-7b), [IntenLM-Chat-7B](https://huggingface.co/internlm/internlm-chat-7b), GPT-3.5, GPT-4, Google PaLM, MiniMax, Claude, Spark, etc.
|
||||
|
||||
## Quick Run
|
||||
> [!TIP]
|
||||
> Require python >= 3.9
|
||||
|
||||
We provide three different ways to run OpenAOE: `run by pip`, `run by docker` and `run by source code` as well.
|
||||
|
||||
### Run by pip
|
||||
#### **Install**
|
||||
```shell
|
||||
pip install -U openaoe
|
||||
```
|
||||
#### **Start**
|
||||
```shell
|
||||
openaoe -f /path/to/your/config-template.yaml
|
||||
```
|
||||
|
||||
### Run by docker
|
||||
#### **Install**
|
||||
|
||||
There are two ways to get the OpenAOE docker image by:
|
||||
1. pull the OpenAOE docker image
|
||||
```shell
|
||||
docker pull openaoe:latest
|
||||
```
|
||||
|
||||
2. or build a docker image
|
||||
```shell
|
||||
git clone https://github.com/internlm/OpenAOE
|
||||
cd open-aoe
|
||||
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
|
||||
```
|
||||
|
||||
### Run by source code
|
||||
#### **Install**
|
||||
1. clone this project
|
||||
```shell
|
||||
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
|
||||
npm install
|
||||
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
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> `/path/to/your/config.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`.
|
|
@ -0,0 +1,70 @@
|
|||
# OpenAOE 多模型对话
|
||||
|
||||
[English](openaoe.md) | 简体中文
|
||||
|
||||
|
||||
## 介绍
|
||||
[OpenAOE](https://github.com/InternLM/OpenAOE) 是一个 LLM-Group-Chat 框架,可以同时与多个商业大模型或开源大模型进行聊天。 OpenAOE还提供后端API和WEB-UI以满足不同的使用需求。
|
||||
|
||||
目前已经支持的大模型有: [InternLM2-Chat-7B](https://huggingface.co/internlm/internlm2-chat-7b), [IntenLM-Chat-7B](https://huggingface.co/internlm/internlm-chat-7b), GPT-3.5, GPT-4, Google PaLM, MiniMax, Claude, 讯飞星火等。
|
||||
|
||||
|
||||
## 快速安装
|
||||
我们将提供 3 种不同的方式安装:基于 pip、基于 docker 以及基于源代码,实现开箱即用。
|
||||
|
||||
### 基于 pip
|
||||
> [!TIP]
|
||||
> 需要 python >= 3.9
|
||||
#### **安装**
|
||||
```shell
|
||||
pip install -U openaoe
|
||||
```
|
||||
#### **运行**
|
||||
```shell
|
||||
openaoe -f /path/to/your/config-template.yaml
|
||||
```
|
||||
|
||||
### 基于 docker
|
||||
#### **安装**
|
||||
有两种方式获取 OpenAOE 的 docker 镜像:
|
||||
1. 官方拉取
|
||||
```shell
|
||||
docker pull openaoe:latest
|
||||
```
|
||||
|
||||
2. 本地构建
|
||||
```shell
|
||||
git clone https://github.com/internlm/OpenAOE
|
||||
cd open-aoe
|
||||
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
|
||||
```
|
||||
|
||||
### 基于源代码
|
||||
#### **安装**
|
||||
1. 克隆项目
|
||||
```shell
|
||||
git clone https://github.com/internlm/OpenAOE
|
||||
```
|
||||
2. [_可选_] (如果前端代码发生变动)重新构建前端项目
|
||||
```shell
|
||||
cd open-aoe/openaoe/frontend
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
|
||||
#### **运行**
|
||||
```shell
|
||||
cd open-aoe/openaoe
|
||||
pip install -r backend/requirements.txt
|
||||
python -m main -f /path/to/your/config-template.yaml
|
||||
``````
|
||||
|
||||
> [!TIP]
|
||||
> `/path/to/your/config.yaml` 是 OpenAOE 启动时读取的配置文件,里面包含了大模型的相关配置信息,
|
||||
> 包括:调用API地址、AKSK、Token等信息,是 OpenAOE 启动的必备文件。模板文件可以在 `openaoe/backend/config/config.yaml` 中找到。
|
Loading…
Reference in New Issue