update readme

2026-09-19 01:28:13 +08:00 · 2024-09-26 20:49:10 +08:00
parent 57fa0803cb
commit f5c431cc91
12 changed files with 109 additions and 20 deletions
@@ -41,6 +41,7 @@
 </div>

 # Changelog
+- 2024/09/27 Version 0.8.2 released, providing a [localized deployment version](https://github.com/opendatalab/MinerU/tree/master/projects/web_demo/README.md) of the [online demo](https://opendatalab.com/OpenSourceTools/Extractor/PDF/) and the [front-end interface](https://github.com/opendatalab/MinerU/tree/master/projects/web/README.md).
 - 2024/09/09: Version 0.8.0 released, supporting fast deployment with Dockerfile, and launching demos on Huggingface and Modelscope.
 - 2024/08/30: Version 0.7.1 released, add paddle tablemaster table recognition option
 - 2024/08/09: Version 0.7.0b1 released, simplified installation process, added table recognition functionality
@@ -41,6 +41,7 @@
 </div>

 # 更新记录
+- 2024/09/27 0.8.2发布，提供了[在线demo](https://opendatalab.com/OpenSourceTools/Extractor/PDF/)的[本地化部署版本](https://github.com/opendatalab/MinerU/tree/master/projects/web_demo/README_zh-CN.md)和[前端界面](https://github.com/opendatalab/MinerU/tree/master/projects/web/README_zh-CN.md)
 - 2024/09/09 0.8.0发布，支持Dockerfile快速部署，同时上线了huggingface、modelscope demo
 - 2024/08/30 0.7.1发布，集成了paddle tablemaster表格识别功能
 - 2024/08/09 0.7.0b1发布，简化安装步骤提升易用性，加入表格识别功能
@@ -4,5 +4,5 @@

 - [llama_index_rag](./llama_index_rag/README.md): Build a lightweight RAG system based on llama_index
 - [gradio_app](./gradio_app/README.md): Build a web app based on gradio
-
+- [web_demo](./web_demo/README.md): MinerU online[demo](https://opendatalab.com/OpenSourceTools/Extractor/PDF/)localized deployment version

@@ -4,4 +4,5 @@

 - [llama_index_rag](./llama_index_rag/README_zh-CN.md): 基于 llama_index 构建轻量级 RAG 系统
 - [gradio_app](./gradio_app/README_zh-CN.md): 基于 Gradio 的 Web 应用
+- [web_demo](./web_demo/README_zh-CN.md): MinerU在线[demo](https://opendatalab.com/OpenSourceTools/Extractor/PDF/)本地化部署版本

@@ -9,7 +9,7 @@ export default defineConfig({
    proxy: {
      "/api": {
        // target: "https://staging.openxlab.org.cn/datasets",
-        target: "http://10.6.16.161:5559",
+        target: "http://10.6.16.169:5559",
        changeOrigin: true,
      },
    },
@@ -1,47 +1,60 @@
-## Mineru 本地API服务
+# MinerU Local web_demo
+## Feature Overview
+<p align="center">
+  <img src="images/web_demo_1.png" width="600px" style="vertical-align:middle;">
+</p>
+
+- Supports uploading PDFs and calling MinerU for processing
+
+- Supports online editing of the Markdown results parsed by MinerU
+
+- Supports viewing of historical tasks
+
+## Installation and Deployment
+
+0. MinerU Installation and Deployment

-MinerU

 ```
-# 服务依赖mineru，请先确保mineru已安装
+# The service depends on mineru, please ensure mineru is installed first
 ```

-1. 打包前端界面
+1. Package the front-end interface

 ```bash
-# 先进入前端目录
+# First, navigate to the front-end directory
 cd projects/web

-# 修改配置
-# 将文件vite.config.ts中的target中的IP更改为自己电脑IP
+# Modify the configuration
+# Change the IP in the target field of the file vite.config.ts to your own computer's IP

-# 打包前端项目
+# Build the front-end project
 npm install -g yarn
 yarn install
 yarn build
 ```

-2. 安装服务依赖
+2. Install service dependencies

 ```bash
-# 先进入后端目录
+# First, navigate to the back-end directory
 cd projects/web_demo
-# 安装依赖
+# Install dependencies
 pip3 install -r requirements.txt  -i https://pypi.tuna.tsinghua.edu.cn/simple
 ```

-3. 启动服务
+3. Start the service

 ```bash
-# 进入程序目录
+# Navigate to the program directory
 cd projects/web_demo/web_demo
-# 启动服务
-python3 app.py 或者 python app.py
-# 在浏览器访问启动的地址即可访问界面
+# Start the service
+python3 app.py or python app.py
+# Access the interface by visiting the started address in the browser
 ```

-ps：接口文档
+ps：API documentation

 ```
-在浏览器打开 mineru-web接口文档.html
+Open the mineru-web API mineru-web接口文档.html in the browser
 ```
@@ -0,0 +1,59 @@
+# Mineru本地web_demo
+## 功能简介
+<p align="center">
+  <img src="images/web_demo_1.png" width="600px" style="vertical-align:middle;">
+</p>
+
+- 支持上传pdf，并调用MinerU进行处理
+
+- 支持对MinerU解析的Markdown结果进行在线修改
+
+- 支持查看历史任务
+
+## 安装部署
+
+0. MinerU安装部署
+
+```
+# 服务依赖MinerU，请先确保MinerU已安装
+```
+
+1. 打包前端界面
+
+```bash
+# 先进入前端目录
+cd projects/web
+
+# 修改配置
+# 将文件vite.config.ts中的target中的IP更改为自己电脑IP
+
+# 打包前端项目
+npm install -g yarn
+yarn install
+yarn build
+```
+
+2. 安装服务依赖
+
+```bash
+# 先进入后端目录
+cd projects/web_demo
+# 安装依赖
+pip3 install -r requirements.txt  -i https://pypi.tuna.tsinghua.edu.cn/simple
+```
+
+3. 启动服务
+
+```bash
+# 进入程序目录
+cd projects/web_demo/web_demo
+# 启动服务
+python3 app.py 或者 python app.py
+# 在浏览器访问启动的地址即可访问界面
+```
+
+ps：接口文档
+
+```
+在浏览器打开 mineru-web接口文档.html
+```
@@ -0,0 +1,10 @@
+{
+  "systemParams": "win32-x64-127",
+  "modulesFolders": [],
+  "flags": [],
+  "linkedModules": [],
+  "topLevelPatterns": [],
+  "lockfileEntries": {},
+  "files": [],
+  "artifacts": {}
+}
@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+