SoMarkAI/OXR

选用指南

AI 根据 README 整理 · 2026/10/27 09:52:18

使用方式

可通过在线 Demo、免费 API 或本地部署使用，支持 Docker 一键启动服务和源代码运行，提供可视化演示界面及 API 接口。

查看 README 依据

## Quick Start <a id="free-api"></a> ### 0. 🔥 🆓 Free API OXR provides a free API so you can test parsing on your own documents without registering or requesting an API key. We'll keep the free API online until we can no longer afford to run it. ⚠️ Note: We do not recommend using the Free OXR API in production. We do not guarantee service stability, and requests are queued, so processing speed may vary slightly. | Online Demo | https://free-oxr.somark.ai | https://free-oxr.somark.cn | |-|-|-| | API URL | https://free-oxr.somark.ai/api/v1 | https://free-oxr.somark.cn/api/v1 |

modelscope download SoMark/OXR-1.0 --local_dir ./models/OXR-1.0 ``` #### 1.2 Start the Services ##### 1.2.1 Run with Docker (Recommended) We recommend Docker to configure and start all services together. ```Bash docker build -f docker/Dockerfile.allinone -t oxr-1.0 . docker run --rm --gpus all --ipc=host \ -p 127.0.0.1:8000:8000 \ -v "$PWD/models/OXR-1.0:/models/oxr-model:ro" \ oxr-1.0 ``` Once the startup logs show that the services are ready, open http://localhost:8000/demo or http://localhost:8000/docs.

Open http://localhost:8000/demo and upload a PDF or image. You can view the original file, Markdown preview, source, layout bounding boxes, and reading order, and download the Markdown. The demo uses a temporary file cache that expires after 1 hour by default and is renewed during processing. Cached results become inaccessible once the cache expires or is cleared, so download your results promptly. #### 1.4 Send a Parsing Request

部署要求

本地运行需要 Linux 操作系统、NVIDIA GPU（支持 BF16）、NVIDIA 驱动（兼容 CUDA 13.0）、Python 3.12，显存至少 24GB，推荐 48GB 以上。

查看 README 依据

somark --base-url https://free-oxr.somark.ai/api/v1 --api-key dummy \ parse document.pdf --formats md,json --out ./parsed-output/ ``` ### 1. Run Locally ```Plain Text Operating system: Linux GPU: NVIDIA (with BF16 support) Driver: NVIDIA driver (compatible with CUDA 13.0) Python: 3.12 (for model downloads / running from source) GPU memory to get started: 24GB on a single GPU (for low-concurrency testing) Recommended GPU memory: ≥48GB on a single GPU (for long documents / higher concurrency) ``` #### 1.1 Download the Code and Models

已知限制

免费 API 不保证服务稳定性，请求会排队，处理速度可能变化，不建议用于生产环境。

查看 README 依据

## Quick Start <a id="free-api"></a> ### 0. 🔥 🆓 Free API OXR provides a free API so you can test parsing on your own documents without registering or requesting an API key. We'll keep the free API online until we can no longer afford to run it. ⚠️ Note: We do not recommend using the Free OXR API in production. We do not guarantee service stability, and requests are queued, so processing speed may vary slightly. | Online Demo | https://free-oxr.somark.ai | https://free-oxr.somark.cn | |-|-|-| | API URL | https://free-oxr.somark.ai/api/v1 | https://free-oxr.somark.cn/api/v1 |