From b1398384087a35b78394f88170c0b9bbd85ed904 Mon Sep 17 00:00:00 2001 From: ModelHub XC Date: Tue, 12 May 2026 00:10:20 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=9D=E5=A7=8B=E5=8C=96=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?=EF=BC=8C=E7=94=B1ModelHub=20XC=E7=A4=BE=E5=8C=BA=E6=8F=90?= =?UTF-8?q?=E4=BE=9B=E6=A8=A1=E5=9E=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Model: opendatalab/MinerU-HTML Source: Original Platform --- .gitattributes | 52 +++++ LICENCE | 201 ++++++++++++++++++ NOTICE | 5 + README.md | 454 ++++++++++++++++++++++++++++++++++++++++ added_tokens.json | 28 +++ config.json | 30 +++ configuration.json | 1 + generation_config.json | 13 ++ merges.txt | 3 + model.safetensors | 3 + special_tokens_map.json | 31 +++ tokenizer.json | 3 + tokenizer_config.json | 241 +++++++++++++++++++++ vocab.json | 3 + 14 files changed, 1068 insertions(+) create mode 100644 .gitattributes create mode 100644 LICENCE create mode 100644 NOTICE create mode 100644 README.md create mode 100644 added_tokens.json create mode 100644 config.json create mode 100644 configuration.json create mode 100644 generation_config.json create mode 100644 merges.txt create mode 100644 model.safetensors create mode 100644 special_tokens_map.json create mode 100644 tokenizer.json create mode 100644 tokenizer_config.json create mode 100644 vocab.json diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..784d577 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,52 @@ +*.7z filter=lfs diff=lfs merge=lfs -text +*.arrow filter=lfs diff=lfs merge=lfs -text +*.bin filter=lfs diff=lfs merge=lfs -text +*.bin.* filter=lfs diff=lfs merge=lfs -text +*.bz2 filter=lfs diff=lfs merge=lfs -text +*.ftz filter=lfs diff=lfs merge=lfs -text +*.gz filter=lfs diff=lfs merge=lfs -text +*.h5 filter=lfs diff=lfs merge=lfs -text +*.joblib filter=lfs diff=lfs merge=lfs -text +*.lfs.* filter=lfs diff=lfs merge=lfs -text +*.model filter=lfs diff=lfs merge=lfs -text +*.msgpack filter=lfs diff=lfs merge=lfs -text +*.onnx filter=lfs diff=lfs merge=lfs -text +*.ot filter=lfs diff=lfs merge=lfs -text +*.parquet filter=lfs diff=lfs merge=lfs -text +*.pb filter=lfs diff=lfs merge=lfs -text +*.pt filter=lfs diff=lfs merge=lfs -text +*.pth filter=lfs diff=lfs merge=lfs -text +*.rar filter=lfs diff=lfs merge=lfs -text +saved_model/**/* filter=lfs diff=lfs merge=lfs -text +*.tar.* filter=lfs diff=lfs merge=lfs -text +*.tflite filter=lfs diff=lfs merge=lfs -text +*.tgz filter=lfs diff=lfs merge=lfs -text +*.xz filter=lfs diff=lfs merge=lfs -text +*.zip filter=lfs diff=lfs merge=lfs -text +*.zstandard filter=lfs diff=lfs merge=lfs -text +*.tfevents* filter=lfs diff=lfs merge=lfs -text +*.db* filter=lfs diff=lfs merge=lfs -text +*.ark* filter=lfs diff=lfs merge=lfs -text +**/*ckpt*data* filter=lfs diff=lfs merge=lfs -text +**/*ckpt*.meta filter=lfs diff=lfs merge=lfs -text +**/*ckpt*.index filter=lfs diff=lfs merge=lfs -text + +*.ckpt filter=lfs diff=lfs merge=lfs -text +*.gguf* filter=lfs diff=lfs merge=lfs -text +*.ggml filter=lfs diff=lfs merge=lfs -text +*.llamafile* filter=lfs diff=lfs merge=lfs -text +*.pt2 filter=lfs diff=lfs merge=lfs -text +*.mlmodel filter=lfs diff=lfs merge=lfs -text +*.npy filter=lfs diff=lfs merge=lfs -text +*.npz filter=lfs diff=lfs merge=lfs -text +*.pickle filter=lfs diff=lfs merge=lfs -text +*.pkl filter=lfs diff=lfs merge=lfs -text +*.tar filter=lfs diff=lfs merge=lfs -text +*.wasm filter=lfs diff=lfs merge=lfs -text +*.zst filter=lfs diff=lfs merge=lfs -text +*tfevents* filter=lfs diff=lfs merge=lfs -text + +tokenizer.json filter=lfs diff=lfs merge=lfs -text +model.safetensors filter=lfs diff=lfs merge=lfs -text +merges.txt filter=lfs diff=lfs merge=lfs -text +vocab.json filter=lfs diff=lfs merge=lfs -text \ No newline at end of file diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..04d77ab --- /dev/null +++ b/LICENCE @@ -0,0 +1,201 @@ + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + Copyright 2024 Alibaba Cloud + Copyright 2025 OpenDatalab Shanghai AILab + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..176e308 --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +This project contains code and model weights derived from Qwen3. +Original Qwen3 Copyright 2024 Alibaba Cloud, licensed under Apache License 2.0. + +Modifications and additional training Copyright 2025 OpenDatalab Shanghai AILab, licensed under Apache License 2.0. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e3b4700 --- /dev/null +++ b/README.md @@ -0,0 +1,454 @@ +--- +license: apache-2.0 +datasets: +- opendatalab/AICC +language: +- en +- zh +pipeline_tag: text-generation +tags: +- commoncrawl +- html-extraction +- content-extraction +- information-extraction +- qwen +base_model: +- Qwen/Qwen3-0.6B +--- +# Dripper(MinerU-HTML) + + GitHub Repo + + +**Dripper(MinerU-HTML)** is an advanced HTML main content extraction tool based on Large Language Models (LLMs). It provides a complete pipeline for extracting primary content from HTML pages using LLM-based classification and state machine-guided generation. + +## Features + +- ๐Ÿš€ **LLM-Powered Extraction**: Uses state-of-the-art language models to intelligently identify main content +- ๐ŸŽฏ **State Machine Guidance**: Implements logits processing with state machines for structured JSON output +- ๐Ÿ”„ **Fallback Mechanism**: Automatically falls back to alternative extraction methods on errors +- ๐Ÿ“Š **Comprehensive Evaluation**: Built-in evaluation framework with ROUGE and item-level metrics +- ๐ŸŒ **REST API Server**: FastAPI-based server for easy integration +- โšก **Distributed Processing**: Ray-based parallel processing for large-scale evaluation +- ๐Ÿ”ง **Multiple Extractors**: Supports various baseline extractors for comparison + +--- + +## Installation + +### Prerequisites + +- Python >= 3.10 +- CUDA-capable GPU (recommended for LLM inference) +- Sufficient memory for model loading + +### Install from Source + +The installation process automatically handles dependencies. The `setup.py` reads dependencies from `requirements.txt` and optionally from `baselines.txt`. + +#### Basic Installation (Core Functionality) + +For basic usage of Dripper, install with core dependencies only: + +```bash +# Clone the repository +git clone https://github.com/opendatalab/MinerU-HTML +cd MinerU-HTML + +# Install the package with core dependencies only +# Dependencies from requirements.txt are automatically installed +pip install . +``` + +#### Installation with Baseline Extractors (for Evaluation) + +If you need to run baseline evaluations and comparisons, install with the `baselines` extra: + +```bash +# Install with baseline extractor dependencies +pip install -e .[baselines] +``` + +This will install additional libraries required for baseline extractors: + +- `readabilipy`, `readability_lxml` - Readability-based extractors +- `resiliparse` - Resilient HTML parsing +- `justext` - JustText extractor +- `gne` - General News Extractor +- `goose3` - Goose3 article extractor +- `boilerpy3` - Boilerplate removal +- `crawl4ai` - AI-powered web content extraction + +**Note**: The baseline extractors are only needed for running comparative evaluations. For basic usage of Dripper, the core installation is sufficient. + +## Quick Start + +### 1. Download the model + +visit our model at [MinerU-HTML](https://huggingface.co/opendatalab/MinerU-HTML) and download the model, you can use the following command to download the model: + +```bash +huggingface-cli download opendatalab/MinerU-HTML +``` + +### 2. Using the Python API + +```python +from dripper.api import Dripper + +# Initialize Dripper with model configuration +dripper = Dripper( + config={ + 'model_path': '/path/to/your/model', + 'tp': 1, # Tensor parallel size + 'state_machine': None, # or 'v1', or 'v2 + 'use_fall_back': True, + 'raise_errors': False, + } +) + +# Extract main content from HTML +html_content = "..." +result = dripper.process(html_content) + +# Access results +main_html = result[0].main_html +``` + +### 3. Using the REST API Server + +```bash +# Start the server +python -m dripper.server \ + --model_path /path/to/your/model \ + --state_machine v2 \ + --port 7986 + +# Or use environment variables +export DRIPPER_MODEL_PATH=/path/to/your/model +export DRIPPER_STATE_MACHINE=v2 +export DRIPPER_PORT=7986 +python -m dripper.server +``` + +Then make requests to the API: + +```bash +# Extract main content +curl -X POST "http://localhost:7986/extract" \ + -H "Content-Type: application/json" \ + -d '{"html": "...", "url": "https://example.com"}' + +# Health check +curl http://localhost:7986/health +``` + +## Configuration + +### Dripper Configuration Options + +| Parameter | Type | Default | Description | +| --------------- | ---- | ------------ | ------------------------------------------------ | +| `model_path` | str | **Required** | Path to the LLM model directory | +| `tp` | int | 1 | Tensor parallel size for model inference | +| `state_machine` | str | None | State machine version: `'v1'`, `'v2'`, or `None` | +| `use_fall_back` | bool | True | Enable fallback to trafilatura on errors | +| `raise_errors` | bool | False | Raise exceptions on errors (vs returning None) | +| `debug` | bool | False | Enable debug logging | +| `early_load` | bool | False | Load model during initialization | + +### Environment Variables + +- `DRIPPER_MODEL_PATH`: Path to the LLM model +- `DRIPPER_STATE_MACHINE`: State machine version (`v1`, `v2`, or empty) +- `DRIPPER_PORT`: Server port number (default: 7986) +- `VLLM_USE_V1`: Must be set to `'0'` when using state machine + +## Usage Examples + +### Batch Processing + +```python +from dripper.api import Dripper + +dripper = Dripper(config={'model_path': '/path/to/model'}) + +# Process multiple HTML strings +html_list = ["...", "..."] +results = dripper.process(html_list) + +for result in results: + print(result.main_html) +``` + +### Evaluation + +#### Baseline Evaluation + +```bash +python app/eval_baseline.py \ + --bench /path/to/benchmark.jsonl \ + --task_dir /path/to/output \ + --extractor_name dripper-md \ + --default_config gpu \ + --model_path /path/to/model +``` + +#### Two-Step Evaluation + +```bash +# if inferencen with no state machine, set VLLM_USE_V1=1 +export VLLM_USE_V1=1 +# if use state machine, set VLLM_USE_V1=0 +# export VLLM_USE_V1=0 + +RESULT_PATH=/path/to/output +EXP_NAME=MinerU-HTML +MODEL_PATH=/path/to/model +BENCH_DATA=/path/to/benchmark.jsonl + +# Step 1: Prepare for evaluation +python app/eval_with_answer.py \ + --bench $BENCH_DATA \ + --task_dir $RESULT_PATH/$MODEL_NAME \ + --step 1 --cpus 128 --force_update + +# Step 2: Run inference +python app/run_inference.py \ + --task_dir $RESULT_PATH/$MODEL_NAME \ + --model_path $MODEL_PATH \ + --output_path $RESULT_PATH/$MODEL_NAME/res.jsonl \ + --no_logits + +# Step 3๏ผš process results +python app/process_res.py \ + --response $RESULT_PATH/$MODEL_NAME/res.jsonl \ + --answer $RESULT_PATH/$MODEL_NAME/ans.jsonl \ + --error $RESULT_PATH/$MODEL_NAME/err.jsonl + +# Step 4: Evaluate with answers +python app/eval_with_answer.py \ + --bench $BENCH_DATA \ + --task_dir $RESULT_PATH/$MODEL_NAME \ + --answer $RESULT_PATH/$MODEL_NAME/ans.jsonl \ + --step 2 --cpus 128 --force_update +``` + +## MinerU Ecosystem & Cloud API (No GPU Required) + +MinerU-HTML is part of the broader **MinerU Ecosystem**. If you don't have local GPU resources, or if you want to seamlessly integrate HTML/PDF/Document extraction into your existing workflows, you can use our official Cloud API, SDKs, and RAG integrations. + +### Command Line API +
+Show commands + +```bash +# Windows (PowerShell) +irm https://cdn-mineru.openxlab.org.cn/open-api-cli/install.ps1 | iex + +# macOS / Linux +curl -fsSL https://cdn-mineru.openxlab.org.cn/open-api-cli/install.sh | sh + +# Precision extract โ€” token required +mineru-open-api auth +mineru-open-api extract webpage.html -o ./output/ # local file +mineru-open-api crawl https://mineru.net/apiManage/docs -o ./output/ # crawl from URL +``` +
+ +### Python SDK +
+Show code + +```python +# pip install mineru-open-sdk +from mineru import MinerU + +# Precision mode โ€” tables, formulas, large files +client = MinerU("your-token") # https://mineru.net/apiManage/token +result = client.extract("webpage.html") # local file +result = client.crawl("https://mineru.net/apiManage/docs") # crawl from URL +print(result.markdown) +``` +
+ +### RAG โ€” LangChain +
+Show code + +```python +# pip install langchain-mineru +from langchain_mineru import MinerULoader + +# Precision mode โ€” full RAG pipeline +from langchain_text_splitters import RecursiveCharacterTextSplitter +from langchain_openai import OpenAIEmbeddings +from langchain_community.vectorstores import FAISS + +docs = MinerULoader(source="article.html", mode="precision", token="your-token", + formula=True, table=True).load() +chunks = RecursiveCharacterTextSplitter(chunk_size=1200, chunk_overlap=200).split_documents(docs) +vectorstore = FAISS.from_documents(chunks, OpenAIEmbeddings()) +results = vectorstore.similarity_search("key requirements", k=3) +``` +
+ +### RAG โ€” LlamaIndex +llama-index-readers-mineru is an official LlamaIndex Reader supporting multi-format document extraction. + +
+Show code + +```python +# pip install llama-index-readers-mineru +from llama_index.readers.mineru import MinerUReader + +# Precision mode โ€” OCR, formula, table +docs = MinerUReader(mode="precision", token="your-token", + ocr=True, formula=True, table=True).load_data("complex_article.html") + +# Full RAG pipeline +from llama_index.core import VectorStoreIndex +index = VectorStoreIndex.from_documents(docs) +response = index.as_query_engine().query("Summarize the key content of this page") +print(response) +``` +
+ +### MCP Server (Claude Desktop ยท Cursor ยท Windsurf) +mineru-open-mcp lets any MCP-compatible AI client parse web pages and documents as a native tool. + +
+Show config + +```json +{ + "mcpServers": { + "mineru": { + "command": "uvx", + "args": ["mineru-open-mcp"], + "env": { "MINERU_API_TOKEN": "your-token" } + } + } +} +``` +
+ + +## Project Structure + +``` +Dripper/ +โ”œโ”€โ”€ dripper/ # Main package +โ”‚ โ”œโ”€โ”€ api.py # Dripper API class +โ”‚ โ”œโ”€โ”€ server.py # FastAPI server +โ”‚ โ”œโ”€โ”€ base.py # Core data structures +โ”‚ โ”œโ”€โ”€ exceptions.py # Custom exceptions +โ”‚ โ”œโ”€โ”€ inference/ # LLM inference modules +โ”‚ โ”‚ โ”œโ”€โ”€ inference.py # Generation functions +โ”‚ โ”‚ โ”œโ”€โ”€ prompt.py # Prompt generation +โ”‚ โ”‚ โ”œโ”€โ”€ logits.py # Response parsing +โ”‚ โ”‚ โ””โ”€โ”€ logtis_processor/ # State machine logits processors +โ”‚ โ”œโ”€โ”€ process/ # HTML processing +โ”‚ โ”‚ โ”œโ”€โ”€ simplify_html.py +โ”‚ โ”‚ โ”œโ”€โ”€ map_to_main.py +โ”‚ โ”‚ โ””โ”€โ”€ html_utils.py +โ”‚ โ”œโ”€โ”€ eval/ # Evaluation modules +โ”‚ โ”‚ โ”œโ”€โ”€ metric.py # ROUGE and item-level metrics +โ”‚ โ”‚ โ”œโ”€โ”€ eval.py # Evaluation functions +โ”‚ โ”‚ โ”œโ”€โ”€ process.py # Processing utilities +โ”‚ โ”‚ โ””โ”€โ”€ benckmark.py # Benchmark data structures +โ”‚ โ””โ”€โ”€ eval_baselines/ # Baseline extractors +โ”‚ โ”œโ”€โ”€ base.py # Evaluation framework +โ”‚ โ””โ”€โ”€ baselines/ # Extractor implementations +โ”œโ”€โ”€ app/ # Application scripts +โ”‚ โ”œโ”€โ”€ eval_baseline.py # Baseline evaluation script +โ”‚ โ”œโ”€โ”€ eval_with_answer.py # Two-step evaluation +โ”‚ โ”œโ”€โ”€ run_inference.py # Inference script +โ”‚ โ””โ”€โ”€ process_res.py # Result processing +โ”œโ”€โ”€ requirements.txt # Core Python dependencies (auto-installed) +โ”œโ”€โ”€ baselines.txt # Optional dependencies for baseline extractors +โ”œโ”€โ”€ LICENCE # Apache License 2.0 +โ”œโ”€โ”€ NOTICE # Copyright and attribution notices +โ””โ”€โ”€ setup.py # Package setup (handles dependency installation) +``` + +## Supported Extractors + +Dripper supports various baseline extractors for comparison: + +- **Dripper** (`dripper-md`, `dripper-html`): The main LLM-based extractor +- **Trafilatura**: Fast and accurate content extraction +- **Readability**: Mozilla's readability algorithm +- **BoilerPy3**: Python port of Boilerpipe +- **NewsPlease**: News article extractor +- **Goose3**: Article extractor +- **GNE**: General News Extractor +- **Crawl4ai**: AI-powered web content extraction +- And more... + +## Evaluation Metrics + +- **ROUGE Scores**: ROUGE-N precision, recall, and F1 scores +- **Item-Level Metrics**: Per-tag-type (main/other) precision, recall, F1, and accuracy +- **HTML Output**: Extracted main HTML for visual inspection + +## Development + +### Running Tests + +```bash +# Add test commands here when available +``` + +### Code Style + +The project uses pre-commit hooks for code quality. Install them: + +```bash +pre-commit install +``` + +## Troubleshooting + +### Common Issues + +1. **VLLM_USE_V1 Error**: When using state machine, ensure `VLLM_USE_V1=0` is set: + + ```bash + export VLLM_USE_V1=0 + ``` + +2. **Model Loading Errors**: Verify model path and ensure sufficient GPU memory + +3. **Import Errors**: Ensure the package is properly installed: + + ```bash + # Reinstall the package (this will automatically install dependencies from requirements.txt) + pip install -e . + + # If you need baseline extractors for evaluation: + pip install -e .[baselines] + ``` + +## License + +This project is licensed under the Apache License, Version 2.0. See the [LICENCE](LICENCE) file for details. + +### Copyright Notice + +This project contains code and model weights derived from Qwen3. Original Qwen3 Copyright 2024 Alibaba Cloud, licensed under Apache License 2.0. Modifications and additional training Copyright 2025 OpenDatalab Shanghai AILab, licensed under Apache License 2.0. + +For more information, please see the [NOTICE](NOTICE) file. + + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## Acknowledgments + +- Built on top of [vLLM](https://github.com/vllm-project/vllm) for efficient LLM inference +- Uses [Trafilatura](https://github.com/adbar/trafilatura) for fallback extraction +- Finetuned on [Qwen3](https://github.com/QwenLM/Qwen3) +- Inspired by various HTML content extraction research \ No newline at end of file diff --git a/added_tokens.json b/added_tokens.json new file mode 100644 index 0000000..b54f913 --- /dev/null +++ b/added_tokens.json @@ -0,0 +1,28 @@ +{ + "": 151668, + "": 151658, + "": 151666, + "": 151667, + "": 151657, + "": 151665, + "<|box_end|>": 151649, + "<|box_start|>": 151648, + "<|endoftext|>": 151643, + "<|file_sep|>": 151664, + "<|fim_middle|>": 151660, + "<|fim_pad|>": 151662, + "<|fim_prefix|>": 151659, + "<|fim_suffix|>": 151661, + "<|im_end|>": 151645, + "<|im_start|>": 151644, + "<|image_pad|>": 151655, + "<|object_ref_end|>": 151647, + "<|object_ref_start|>": 151646, + "<|quad_end|>": 151651, + "<|quad_start|>": 151650, + "<|repo_name|>": 151663, + "<|video_pad|>": 151656, + "<|vision_end|>": 151653, + "<|vision_pad|>": 151654, + "<|vision_start|>": 151652 +} diff --git a/config.json b/config.json new file mode 100644 index 0000000..44b79eb --- /dev/null +++ b/config.json @@ -0,0 +1,30 @@ +{ + "architectures": [ + "Qwen3ForCausalLM" + ], + "attention_bias": false, + "attention_dropout": 0.0, + "bos_token_id": 151643, + "eos_token_id": 151645, + "head_dim": 128, + "hidden_act": "silu", + "hidden_size": 1024, + "initializer_range": 0.02, + "intermediate_size": 3072, + "max_position_embeddings": 40960, + "max_window_layers": 28, + "model_type": "qwen3", + "num_attention_heads": 16, + "num_hidden_layers": 28, + "num_key_value_heads": 8, + "rms_norm_eps": 1e-06, + "rope_scaling": null, + "rope_theta": 1000000, + "sliding_window": null, + "tie_word_embeddings": true, + "torch_dtype": "bfloat16", + "transformers_version": "4.51.3", + "use_cache": false, + "use_sliding_window": false, + "vocab_size": 151936 +} diff --git a/configuration.json b/configuration.json new file mode 100644 index 0000000..bbeeda1 --- /dev/null +++ b/configuration.json @@ -0,0 +1 @@ +{"framework": "pytorch", "task": "text-generation", "allow_remote": true} \ No newline at end of file diff --git a/generation_config.json b/generation_config.json new file mode 100644 index 0000000..e4f1d31 --- /dev/null +++ b/generation_config.json @@ -0,0 +1,13 @@ +{ + "bos_token_id": 151643, + "do_sample": true, + "eos_token_id": [ + 151645, + 151643 + ], + "pad_token_id": 151643, + "temperature": 0.6, + "top_k": 20, + "top_p": 0.95, + "transformers_version": "4.51.3" +} diff --git a/merges.txt b/merges.txt new file mode 100644 index 0000000..80c1a19 --- /dev/null +++ b/merges.txt @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8831e4f1a044471340f7c0a83d7bd71306a5b867e95fd870f74d0c5308a904d5 +size 1671853 diff --git a/model.safetensors b/model.safetensors new file mode 100644 index 0000000..28df951 --- /dev/null +++ b/model.safetensors @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32e21cff0eb06c724b26d00090f6199c90ceb2717438c8a83544eb5fb7878acd +size 1503300328 diff --git a/special_tokens_map.json b/special_tokens_map.json new file mode 100644 index 0000000..ac23c0a --- /dev/null +++ b/special_tokens_map.json @@ -0,0 +1,31 @@ +{ + "additional_special_tokens": [ + "<|im_start|>", + "<|im_end|>", + "<|object_ref_start|>", + "<|object_ref_end|>", + "<|box_start|>", + "<|box_end|>", + "<|quad_start|>", + "<|quad_end|>", + "<|vision_start|>", + "<|vision_end|>", + "<|vision_pad|>", + "<|image_pad|>", + "<|video_pad|>" + ], + "eos_token": { + "content": "<|im_end|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false + }, + "pad_token": { + "content": "<|endoftext|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false + } +} diff --git a/tokenizer.json b/tokenizer.json new file mode 100644 index 0000000..cd71f61 --- /dev/null +++ b/tokenizer.json @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aeb13307a71acd8fe81861d94ad54ab689df773318809eed3cbe794b4492dae4 +size 11422654 diff --git a/tokenizer_config.json b/tokenizer_config.json new file mode 100644 index 0000000..e8bb905 --- /dev/null +++ b/tokenizer_config.json @@ -0,0 +1,241 @@ +{ + "add_bos_token": false, + "add_prefix_space": false, + "added_tokens_decoder": { + "151643": { + "content": "<|endoftext|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151644": { + "content": "<|im_start|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151645": { + "content": "<|im_end|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151646": { + "content": "<|object_ref_start|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151647": { + "content": "<|object_ref_end|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151648": { + "content": "<|box_start|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151649": { + "content": "<|box_end|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151650": { + "content": "<|quad_start|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151651": { + "content": "<|quad_end|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151652": { + "content": "<|vision_start|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151653": { + "content": "<|vision_end|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151654": { + "content": "<|vision_pad|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151655": { + "content": "<|image_pad|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151656": { + "content": "<|video_pad|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": true + }, + "151657": { + "content": "", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151658": { + "content": "", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151659": { + "content": "<|fim_prefix|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151660": { + "content": "<|fim_middle|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151661": { + "content": "<|fim_suffix|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151662": { + "content": "<|fim_pad|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151663": { + "content": "<|repo_name|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151664": { + "content": "<|file_sep|>", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151665": { + "content": "", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151666": { + "content": "", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151667": { + "content": "", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + }, + "151668": { + "content": "", + "lstrip": false, + "normalized": false, + "rstrip": false, + "single_word": false, + "special": false + } + }, + "additional_special_tokens": [ + "<|im_start|>", + "<|im_end|>", + "<|object_ref_start|>", + "<|object_ref_end|>", + "<|box_start|>", + "<|box_end|>", + "<|quad_start|>", + "<|quad_end|>", + "<|vision_start|>", + "<|vision_end|>", + "<|vision_pad|>", + "<|image_pad|>", + "<|video_pad|>" + ], + "bos_token": null, + "chat_template": "{%- if tools %}\n {{- '<|im_start|>system\\n' }}\n {%- if messages[0].role == 'system' %}\n {{- messages[0].content + '\\n\\n' }}\n {%- endif %}\n {{- \"# Tools\\n\\nYou may call one or more functions to assist with the user query.\\n\\nYou are provided with function signatures within XML tags:\\n\" }}\n {%- for tool in tools %}\n {{- \"\\n\" }}\n {{- tool | tojson }}\n {%- endfor %}\n {{- \"\\n\\n\\nFor each function call, return a json object with function name and arguments within XML tags:\\n\\n{\\\"name\\\": , \\\"arguments\\\": }\\n<|im_end|>\\n\" }}\n{%- else %}\n {%- if messages[0].role == 'system' %}\n {{- '<|im_start|>system\\n' + messages[0].content + '<|im_end|>\\n' }}\n {%- endif %}\n{%- endif %}\n{%- set ns = namespace(multi_step_tool=true, last_query_index=messages|length - 1) %}\n{%- for message in messages[::-1] %}\n {%- set index = (messages|length - 1) - loop.index0 %}\n {%- if ns.multi_step_tool and message.role == \"user\" and message.content is string and not(message.content.startswith('') and message.content.endswith('')) %}\n {%- set ns.multi_step_tool = false %}\n {%- set ns.last_query_index = index %}\n {%- endif %}\n{%- endfor %}\n{%- for message in messages %}\n {%- if message.content is string %}\n {%- set content = message.content %}\n {%- else %}\n {%- set content = '' %}\n {%- endif %}\n {%- if (message.role == \"user\") or (message.role == \"system\" and not loop.first) %}\n {{- '<|im_start|>' + message.role + '\\n' + content + '<|im_end|>' + '\\n' }}\n {%- elif message.role == \"assistant\" %}\n {%- set reasoning_content = '' %}\n {%- if message.reasoning_content is string %}\n {%- set reasoning_content = message.reasoning_content %}\n {%- else %}\n {%- if '' in content %}\n {%- set reasoning_content = content.split('')[0].rstrip('\\n').split('')[-1].lstrip('\\n') %}\n {%- set content = content.split('')[-1].lstrip('\\n') %}\n {%- endif %}\n {%- endif %}\n {%- if loop.index0 > ns.last_query_index %}\n {%- if loop.last or (not loop.last and reasoning_content) %}\n {{- '<|im_start|>' + message.role + '\\n\\n' + reasoning_content.strip('\\n') + '\\n\\n\\n' + content.lstrip('\\n') }}\n {%- else %}\n {{- '<|im_start|>' + message.role + '\\n' + content }}\n {%- endif %}\n {%- else %}\n {{- '<|im_start|>' + message.role + '\\n' + content }}\n {%- endif %}\n {%- if message.tool_calls %}\n {%- for tool_call in message.tool_calls %}\n {%- if (loop.first and content) or (not loop.first) %}\n {{- '\\n' }}\n {%- endif %}\n {%- if tool_call.function %}\n {%- set tool_call = tool_call.function %}\n {%- endif %}\n {{- '\\n{\"name\": \"' }}\n {{- tool_call.name }}\n {{- '\", \"arguments\": ' }}\n {%- if tool_call.arguments is string %}\n {{- tool_call.arguments }}\n {%- else %}\n {{- tool_call.arguments | tojson }}\n {%- endif %}\n {{- '}\\n' }}\n {%- endfor %}\n {%- endif %}\n {{- '<|im_end|>\\n' }}\n {%- elif message.role == \"tool\" %}\n {%- if loop.first or (messages[loop.index0 - 1].role != \"tool\") %}\n {{- '<|im_start|>user' }}\n {%- endif %}\n {{- '\\n\\n' }}\n {{- content }}\n {{- '\\n' }}\n {%- if loop.last or (messages[loop.index0 + 1].role != \"tool\") %}\n {{- '<|im_end|>\\n' }}\n {%- endif %}\n {%- endif %}\n{%- endfor %}\n{%- if add_generation_prompt %}\n {{- '<|im_start|>assistant\\n' }}\n {%- if enable_thinking is defined and enable_thinking is false %}\n {{- '\\n\\n\\n\\n' }}\n {%- endif %}\n{%- endif %}", + "clean_up_tokenization_spaces": false, + "eos_token": "<|im_end|>", + "errors": "replace", + "extra_special_tokens": {}, + "model_max_length": 131072, + "pad_token": "<|endoftext|>", + "padding_side": "right", + "split_special_tokens": false, + "tokenizer_class": "Qwen2Tokenizer", + "unk_token": null +} diff --git a/vocab.json b/vocab.json new file mode 100644 index 0000000..6c49fc6 --- /dev/null +++ b/vocab.json @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca10d7e9fb3ed18575dd1e277a2579c16d108e32f27439684afa0e10b1440910 +size 2776833