Skip to content

Commit

Permalink
docs: Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
xixihahaliu committed Apr 26, 2024
1 parent b96741e commit e393968
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To install the package, run:
```bash
conda create -n qanything-python python=3.10
conda activate qanything-python
git clone -b qanything-python-v1.3.1 https://github.com/netease-youdao/QAnything.git
git clone -b qanything-python https://github.com/netease-youdao/QAnything.git
cd QAnything
pip install -e .
```
Expand Down Expand Up @@ -66,6 +66,20 @@ bash scripts/run_for_openai_api_in_M1_mac.sh
bash scripts/run_for_3B_in_M1_mac.sh
```

## Run in OpenCloud
OpenCloud Need Run in Docker Container, Please Install Docker First:
Docker version >= 20.10.5 and docker-compose version >= 2.23.3
```bash
docker-compose up -d
docker attach qanything-container
# Choose one of the 4 commands below to run:
bash scripts/run_for_3B_in_Linux_or_WSL.sh
bash scripts/run_for_7B_in_Linux_or_WSL.sh
bash scripts/run_for_openai_api_with_cpu_in_Linux_or_WSL.sh
bash scripts/run_for_openai_api_with_gpu_in_Linux_or_WSL.sh
```


## USE WITH WEB UI
Open http://0.0.0.0:8777/qanything/ in the browser to use the UI interface,

Expand Down
13 changes: 13 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ bash scripts/run_for_openai_api_in_M1_mac.sh
bash scripts/run_for_3B_in_M1_mac.sh
```

## 在OpenCloud操作系统中运行
OpenCloud 需要在 Docker 容器中运行,请先安装 Docker:
Docker 版本 >= 20.10.5 且 docker-compose 版本 >= 2.23.3
```bash
docker-compose up -d
docker attach qanything-container
# 选择以下4个命令之一来运行:
bash scripts/run_for_3B_in_Linux_or_WSL.sh
bash scripts/run_for_7B_in_Linux_or_WSL.sh
bash scripts/run_for_openai_api_with_cpu_in_Linux_or_WSL.sh
bash scripts/run_for_openai_api_with_gpu_in_Linux_or_WSL.sh
```

## 访问前端页面
在浏览器中打开http://0.0.0.0:8777/qanything/

Expand Down

0 comments on commit e393968

Please sign in to comment.