feat: add README
This commit is contained in:
0
src/mineru-sgalng/.env.example
Normal file
0
src/mineru-sgalng/.env.example
Normal file
@@ -1,26 +1,45 @@
|
||||
# MinerU SGLang
|
||||
|
||||
SGLang backend server:
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
```bash
|
||||
docker compose --profile sglang-server up -d
|
||||
```
|
||||
This service runs MinerU with the SGLang backend.
|
||||
|
||||
Document parse API:
|
||||
## Start Services
|
||||
|
||||
```bash
|
||||
docker compose --profile api up -d
|
||||
```
|
||||
- **SGLang backend server**:
|
||||
|
||||
Gradio WebUI:
|
||||
```bash
|
||||
docker compose --profile sglang-server up -d
|
||||
```
|
||||
|
||||
```bash
|
||||
docker compose --profile gradio up -d
|
||||
```
|
||||
- **Document parse API**:
|
||||
|
||||
Test SGLang backend:
|
||||
```bash
|
||||
docker compose --profile api up -d
|
||||
```
|
||||
|
||||
- **Gradio WebUI**:
|
||||
|
||||
```bash
|
||||
docker compose --profile gradio up -d
|
||||
```
|
||||
|
||||
## Test SGLang backend
|
||||
|
||||
```bash
|
||||
pip install mineru
|
||||
mineru -p demo.pdf -o ./output -b vlm-sglang-client -u http://localhost:30000
|
||||
```
|
||||
|
||||
## Services
|
||||
|
||||
- `mineru-sglang-server`: The SGLang backend server.
|
||||
- `mineru-api`: The document parsing API.
|
||||
- `mineru-gradio`: The Gradio WebUI.
|
||||
|
||||
## Configuration
|
||||
|
||||
- `MINERU_DOCKER_IMAGE`: The Docker image for MinerU SGLang, default is `alexsuntop/mineru-sglang:2.2.2`.
|
||||
- `MINERU_PORT_OVERRIDE_SGLANG`: The host port for the SGLang server, default is `30000`.
|
||||
- `MINERU_PORT_OVERRIDE_API`: The host port for the API service, default is `8000`.
|
||||
- `MINERU_PORT_OVERRIDE_GRADIO`: The host port for the Gradio WebUI, default is `7860`.
|
||||
|
||||
45
src/mineru-sgalng/README.zh.md
Normal file
45
src/mineru-sgalng/README.zh.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# MinerU SGLang
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
此服务使用 SGLang 后端运行 MinerU。
|
||||
|
||||
## 启动服务
|
||||
|
||||
- **SGLang 后端服务器**:
|
||||
|
||||
```bash
|
||||
docker compose --profile sglang-server up -d
|
||||
```
|
||||
|
||||
- **文档解析 API**:
|
||||
|
||||
```bash
|
||||
docker compose --profile api up -d
|
||||
```
|
||||
|
||||
- **Gradio WebUI**:
|
||||
|
||||
```bash
|
||||
docker compose --profile gradio up -d
|
||||
```
|
||||
|
||||
## 测试 SGLang 后端
|
||||
|
||||
```bash
|
||||
pip install mineru
|
||||
mineru -p demo.pdf -o ./output -b vlm-sglang-client -u http://localhost:30000
|
||||
```
|
||||
|
||||
## 服务
|
||||
|
||||
- `mineru-sglang-server`: SGLang 后端服务器。
|
||||
- `mineru-api`: 文档解析 API。
|
||||
- `mineru-gradio`: Gradio WebUI。
|
||||
|
||||
## 配置
|
||||
|
||||
- `MINERU_DOCKER_IMAGE`: MinerU SGLang 的 Docker 镜像,默认为 `alexsuntop/mineru-sglang:2.2.2`。
|
||||
- `MINERU_PORT_OVERRIDE_SGLANG`: SGLang 服务器的主机端口,默认为 `30000`。
|
||||
- `MINERU_PORT_OVERRIDE_API`: API 服务的主机端口,默认为 `8000`。
|
||||
- `MINERU_PORT_OVERRIDE_GRADIO`: Gradio WebUI 的主机端口,默认为 `7860`。
|
||||
Reference in New Issue
Block a user