Commit Graph
125 Commits
Author SHA1 Message Date
dd19f59eb6 fix(ocr_mkcontent): revise table caption output (#397)
* fix(ocr_mkcontent): revise table caption output

- Ensuring that
  table captions are properly included in the output.
- Remove the redundant `table_caption` variable。

* Update cla.yml

* Update bug_report.yml

* feat(cli): add debug option for detailed error handling

Enable users to invoke the CLI command with a new debug flag to get detailed debugging information.

* fix(pdf-extract-kit): adjust crop_paste parameters for better accuracyThe crop_paste_x and crop_paste_y values in the pdf_extract_kit.py have been modified
to improve the accuracy and consistency of OCR processing. The new values are set to 25
to ensure more precise image cropping and pasting which leads to better OCR recognition
results.

* Update README_zh-CN.md (#404)

correct FAQ url

* Update README_zh-CN.md (#404) (#409) (#410)

correct FAQ url

Co-authored-by: sfk <18810651050@163.com>

* Update FAQ_zh_cn.md

add new issue

* Update FAQ_en_us.md

* Update README_Windows_CUDA_Acceleration_zh_CN.md

* Update README_zh-CN.md

* @Thepathakarpit has signed the CLA in opendatalab/MinerU#418

* fix(pdf-extract-kit): increase crop_paste margin for OCR processingDouble the crop_paste margin from25 to 50 to ensure better OCR accuracy and
handling of border cases. This change will help in improving the overall quality of
OCR'ed text by providing more context around the detected text areas.

* fix(common): deep copy model list before drawing model bbox

Use a deep copy of the original model list in `drow_model_bbox` to avoid potential
modifications to the source data. This ensures the integrity of the original models
is maintained while generating the model bounding boxes visualization.

---------

Co-authored-by: sfk <18810651050@163.com>
Co-authored-by: drunkpig <60862764+drunkpig@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2024-08-20 14:40:36 +08:00
c9a51491a4 feat: rename the file generated by command line tools (#401)
* feat: rename the file generated by command line tools

* feat: add pdf filename as prefix to {span,layout,model}.pdf

---------

Co-authored-by: icecraft <tmortred@gmail.com>
Co-authored-by: icecraft <xurui1@pjlab.org.cn>
2024-08-20 14:13:25 +08:00
Xiaomeng Zhao 8601d2336f Update README_Windows_CUDA_Acceleration_zh_CN.md 2024-08-13 18:44:23 +08:00
Xiaomeng Zhao 4983bc1df6 Update FAQ_en_us.md 2024-08-13 16:43:02 +08:00
Xiaomeng Zhao 2f01dbab2b Update FAQ_zh_cn.md
add new issue
2024-08-13 16:41:25 +08:00
myhloli 0405461d35 docs(faq): add solution for libGL.so.1 missing on WSL2 Ubuntu22.04
Add FAQ entries in both English and Chinese to address the issue where the
libGL.so.1 library is missing on Ubuntu22.04 when running under WSL2. The
FAQ now includes instructions on how to install the missing library, resolvingthe corresponding ImportError.Closes https://github.com/opendatalab/MinerU/issues/388
2024-08-11 03:12:20 +08:00
sfk 2450353009 Update README_Windows_CUDA_Acceleration_en_US.md 2024-08-09 22:00:54 +08:00
sfk ece8dac40f Update README_Windows_CUDA_Acceleration_zh_CN.md 2024-08-09 21:59:31 +08:00
sfk 409ece8231 Update README_Ubuntu_CUDA_Acceleration_en_US.md 2024-08-09 21:58:13 +08:00
sfk 18f82ab7d1 Update README_Ubuntu_CUDA_Acceleration_zh_CN.md 2024-08-09 21:56:58 +08:00
sfk 85e363584f Create FAQ_en_us.md 2024-08-09 19:11:49 +08:00
sfk cf704253f0 Create output_file_en_us.md 2024-08-09 19:06:07 +08:00
Xiaomeng Zhao b03b5cddac Update FAQ_zh_cn.md 2024-08-09 17:31:34 +08:00
myhloli 048e0952e8 docs(cuda-acceleration): add tips to verify CUDA acceleration effectiveness
Add notes in the Ubuntu and Windows CUDA acceleration guides on how to
determine if CUDA acceleration is working. This includes checking for
significant reductions in `layout detection cost`, `mfr time`, and `ocr cost`
as indicators of successful acceleration.
2024-08-08 18:14:11 +08:00
myhloli 8da5328f18 docs(zh-cn): emphasize additional steps in model download guide
Add an exclamation mark to the section title to stress the importance of completing the
additional steps after downloading a model. This change is made in the Chinese
documentation to ensure users are aware of the necessary post-download actions.
2024-08-07 16:18:01 +08:00
myhloli 2ff63b7c5e fix(models-download-path): correct the download path for PDF-Extract-Kit
Adjust the print statement in the how_to_download_models_zh_cn.md guide to reflect
the correct model download location. The path has been updated to specify the 'models'
directory where the model is actually downloaded.
2024-08-07 16:01:46 +08:00
赵小蒙 c7067c8535 docs(models_zh_cn): add print statement to download models example
Add a print statement to the example code in 'how_to_download_models_zh_cn.md' to
output the downloaded model directory path. This enhancement aids users in locating
the model files as it provides a clear indication of where they are saved on the
user's file system.
2024-08-07 11:13:45 +08:00
myhloli 361f5042f8 docs(readme): update acknowledgment section and project description- Streamline the Acknowledgments section in the README by removing redundant entries.- Clarify the project's current use of PyMuPDF and future plans for exploring a more permissively licensed PDF processing library in the project description.
- Ensure all modifications adhere to the project's documentation standards and improve reader understanding.
2024-08-07 10:39:20 +08:00
myhloli d2a8cb4265 docs(models-download): update steps and remove deprecated sectionsUpdate the model download instructions to reflect the current process, removing
unnecessary sections and simplifying the steps. The updated guide now includesclearer instructions on installing Git LFS, downloading models from Hugging Face,and additional checks for model file completeness. This change ensures that the
documentation is up-to-date and provides a streamlined experience for users
downloading models.
2024-08-06 19:17:12 +08:00
myhloli c723cc6577 docs: correct path format description in Windows CUDA docsUpdate the instructions in the Windows CUDA Acceleration documentation toreflect the correct path format. Specifically, clarify that Windows paths
should include the drive letter and replace backslashes with forward slashes.
2024-08-06 19:11:17 +08:00
myhloli 4f5689a4da docs(cuda-acceleration): update PowerShell examples and formatting in README 2024-08-06 19:08:46 +08:00
myhloli d3e42e0845 docs: update URLs to gitee for Windows CUDA acceleration guides
Update the URLs for downloading the `magic-pdf.template.json` and `small_ocr.pdf`
files in the Windows CUDA acceleration guides. The links now point to the giteerepository instead of GitHub, ensuring users have access to the necessary files
from the correct source.
2024-08-06 19:01:59 +08:00
myhloli 020602ebfa docs(zh_CN): update Ubuntu CUDA Acceleration guide
- Streamline the installation process by removing the redundant apt update step.
- Adjust the numbering of installation steps throughout the document.
- Update download URLs to gitee for the configuration template and demo file.
- Ensure consistency in the model directory configuration advice.
2024-08-06 17:36:54 +08:00
myhloli 4d7dc06525 docs: add Ubuntu 22.04 LTS CUDA acceleration setup guide
Add a new README_Ubuntu_CUDA_Acceleration_en_US.md document to provide users with a
setup guide for enabling and testing CUDA acceleration on Ubuntu 22.04 LTS. The guideincludes steps to check and install NVIDIA drivers, install Anaconda, create a conda
environment, install required applications, download and verify models, configure theenvironment, and test CUDA acceleration.

This addition addresses the need for clear, concise instructions on achieving better
performance with CUDA-enabled graphics cards and
2024-08-06 17:26:53 +08:00
myhloli 2eaa9ca1d3 docs(FAQ): update troubleshooting sections for offline deployment and Mac issues
- Note the fix in version 0.6.2b1 for the network error during the first run of offline  deployment and clarify the model download requirement.
- Update the dependency installation guide for users on macOS with Intel CPUs.
- Indicate the resolution in version 0.6.2b1 for compatibility issues with paddlepaddle
  version 2.6.1 on certain Linux systems.

This change aims to make the FAQ more informative and easier to navigate for users
experiencing similar issues, providing direct solutions and links where applicable.
2024-08-06 16:08:48 +08:00
myhloli 29e48c7398 mirror(conda): use tuna mirror for Anaconda download
Update the download links for Anaconda in both Ubuntu and Windows CUDA
Acceleration documents to use the Tuna mirror. This change helps ensure that
users in China have faster access to the Anaconda distribution.
2024-08-05 19:12:20 +08:00
myhloli 9778a46142 docs: specify absolute path for model weights configuration
Update the README documents to clarify that the "models-dir" in the
configuration should be an absolute path. Also, provide additional guidance
for Windows users on how to correctly format the path to avoid common issues
with path escaping in JSON files.
2024-08-03 02:28:50 +08:00
myhloli 44a2dc3750 docs: add wget command for Ubuntu and powershell script for Windows
Add instructions to download the magic-pdf.template.json file using wget on
Ubuntu and a PowerShell script on Windows in the respective README files.
This is to facilitate the setup process by providing direct download options,
replacing manual file transfers.
2024-08-03 02:20:29 +08:00
myhloli a0c62b2632 fix(docs): pin Magic-PDF version to 0.6.2b1 in install commands
Update the install commands in both Ubuntu and Windows CUDA Acceleration
guides to specify Magic-PDF version 0.6.2b1, ensuring consistency andavoiding potential version mismatches.
2024-08-02 16:50:29 +08:00
myhloli 961330f784 docs(FAQ): update dependency installation troubleshooting
Update the FAQ to clarify the dependency installation issue when using magic-pdf. Ensure
users are directed to install the specific version of magic-pdf that resolves the dependency
error, rather than listing all individual dependencies. This simplifies the troubleshooting process
and provides a direct solution for users encountering the "Required dependency not installed"
error.
2024-08-02 16:30:58 +08:00
myhloli a24890b18c docs(models_zh_cn): update download methods from ModelScope
Update the download methods for models in the Chinese documentation to reflect
the latest options available from ModelScope. Simplify the section titles and
revise download instructions for clarity and consistency.
2024-08-02 15:46:11 +08:00
myhloli a53cb30f69 Merge remote-tracking branch 'origin/master' 2024-08-02 15:42:04 +08:00
myhloli 3ef4d054cf docs: update model download instructions and CUDA acceleration setup
Update the documentation to reflect the latest model download procedures, emphasis on
model file integrity checks, and expanded instructions for setting up CUDA accelerationon Ubuntu and Windows environments. The README files for various OS have been
enhanced with additional details to assist users in configuring and verifying their
environments for optimal performance.
2024-08-02 15:41:54 +08:00
xuchao 2a06e0c8c0 Make the documentation on how to download the model more concise 2024-08-02 14:58:15 +08:00
Kaiwen Liuandliukaiwen 37925f36d9 feat(model inference): add table recognition and conversion to LaTeX (#284)
* # add table recognition using struct-eqtable
## Changelog
31/07/20204
- Support table recognition. Table images will be converted into html.

### how to use the new feature:
set the attribute 'table-mode' to 'true' in magic-pdf.json

### caution:
it takes 200s to 500s to convert a single table image using cpu

* # add table recognition using struct-eqtable
## Changelog
31/07/20204
- Support table recognition. Table images will be converted into LaTex.

### how to use the new feature:
set the attribute 'table-mode' to 'true' in magic-pdf.json

### caution:
it takes 200s to 500s to convert a single table image using cpu

* # feat(model inference): add table recognition and convertion to LaTeX

# What's Changed

### New Features

- Add table content recognition, we use weights of [StructEqTable](https://github.com/UniModal4Reasoning/StructEqTable-Deploy) to convert table image to LaTex.

### Instruction

- pip install pypandoc struct-eqtable==0.1.0
- Download [StructEqTable weights](https://huggingface.co/wanderkid/PDF-Extract-Kit/tree/main/models/TabRec) and put it under models/ directory.
- Edit 'table-mode' value to turn on table recognition function which is turned off by default.
- If you did not download any models before, refer to [how to download models](docs/how_to_download_models_zh_cn.md)。

* add table recognition and convertion to LaTeX

* add table recognition and conversion to LaTeX

* add table recognition and conversion to LaTeX

* add table recognition and conversion to LaTeX

---------

Co-authored-by: liukaiwen <liukaiwen@pjlab.org.cn>
2024-08-02 11:13:46 +08:00
myhloli 41737adf8c docs(output-file): correct poly coordinate format and update table descriptions
- Fix the description of the 'poly' coordinate format in the output file documentation to correctly reflect the order of coordinates: left-top, right-top, right-bottom,
  left-bottom.
- Update various table-related descriptions for clarity and consistency, including
  field names and their corresponding explanations.
- Add version name field description in 'middle.json' structure to document the
  version of the magic-pdf used in the parsing process.
- Refactor the block and line description tables to improve readability and alignment
  with the rest of the documentation.
2024-08-02 10:14:39 +08:00
myhloli 15125623d1 docs: update README for Ubuntu CUDA Acceleration
- Adjust command installation format for PaddlePaddle GPU.
- Clarify instruction numbering for testing OCR acceleration.
2024-08-01 19:48:50 +08:00
myhloli a09291adbb docs(zh_CN): update Ubuntu CUDA setup guide for accuracy
Update the Ubuntu CUDA Acceleration setup guide to reflect the correct user directory
path and improve the clarity of instructions. Remove references to Windows and macOS
as they are out of scope for this document. Ensure the configuration file copying
command is correctly represented for Linux users.
2024-08-01 19:48:10 +08:00
myhloli 51a0bf4a42 fix(docs): correct link to magic-pdf.template.json in README
Update the link to the magic-pdf.template.json configuration template file in the
README_Ubuntu_CUDA_Acceleration_zh_CN.md document. The file path was previously
incorrect and has been amended to point to the correct location.
2024-08-01 19:46:07 +08:00
myhloli 866e47a0b2 docs(magic-pdf): update model directory reference in configuration
Update the instruction in README_Ubuntu_CUDA_Acceleration_zh_CN.md to reference
the correct section number for downloading the model weights. This change ensures
that users are directed to the correct location in the document for setting up the
model directory in the magic-pdf.json configuration.
2024-08-01 19:45:30 +08:00
myhloli fc18a5cfd2 docs: update Ubuntu CUDA acceleration guide for version 0.6.2- Add steps for Ubuntu 22.04 LTS installation.
- Detail the process of checking, installing, and configuring NVIDIA drivers.
- Include instructions for installing Anaconda and creating a specific environment.
- Provide guidance on installing magic-pdf and its dependencies.
- Add a note to verify magic-pdf version and report issues if necessary.
- Describe the process of downloading models and configuring the application.
- Include a sample command to run the application with CUDA acceleration.
- Add a note for enabling OCR CUDA acceleration with specific GPU requirements.

This update ensures users have the latest information for setting up CUDA accelerationwith magic-pdf on Ubuntu 22.04 LTS, specifically for version 0.6.2, and provides clearer
instructions on the installation and configuration process.
2024-08-01 19:43:14 +08:00
myhloli a697002cfb Merge remote-tracking branch 'origin/master' 2024-08-01 19:28:07 +08:00
myhloli b4b2a09928 docs: restructure download guide and add ModelScope options
Restructured the how-to download models document for better clarity and
added sections on downloading models from ModelScope, including SDK and
Git download methods. Provided detailed steps for installing Git LFS and
checking model integrity after download. Also included recommendations
for moving the models to an SSD for better performance.
2024-08-01 19:27:57 +08:00
icecraftandshenguanlin 40e0827e60 Feat/impl cli (#264)
* feat: refractor cli command

* feat: add docs to describe the output files of cli

* feat: resove review comments

* feat: updat docs about middle.json

---------

Co-authored-by: shenguanlin <shenguanlin@pjlab.org.cn>
2024-08-01 19:21:15 +08:00
Richard Li c30a1abdcb Update how_to_download_models_en.md 2024-08-01 17:52:04 +08:00
drunkpig 4a1d82eda9 Merge pull request #258 from nutshellfool/patch-1
Update how_to_download_models_zh_cn.md
2024-08-01 17:30:29 +08:00
myhloli 808563ce72 docs: add installation guide for git lfs on various platforms
Add detailed instructions for installing git lfs on Linux, macOS, and Windows
to facilitate users in downloading models from ModelScope repository. The guide
is included in the `how_to_download_models_zh_cn.md` document.
2024-07-31 15:37:41 +08:00
Richard Li b7cd875ffd Update how_to_download_models_zh_cn.md
use git lfs clone to download model from ModelScope
2024-07-31 14:21:40 +08:00
myhloli 3cdac5e466 docs(readme): update version requirement and GPU usage links 2024-07-30 18:22:20 +08:00
Xiaomeng Zhao 230e37edbc Update FAQ_zh_cn.md 2024-07-29 10:56:28 +08:00