Files
MinerU/README.md
2024-06-20 17:47:32 +08:00

2.0 KiB

Magic-PDF

Introduction

Magic-PDF is a tool designed to convert PDF documents into Markdown format, capable of processing files stored locally or on object storage supporting S3 protocol.

Key features include:

  • Support for multiple front-end model inputs
  • Removal of headers, footers, footnotes, and page numbers
  • Human-readable layout formatting
  • Retains the original document's structure and formatting, including headings, paragraphs, lists, and more
  • Extraction and display of images and tables within markdown
  • Conversion of equations into LaTeX format
  • Automatic detection and conversion of garbled PDFs
  • Compatibility with CPU and GPU environments
  • Available for Windows, Linux, and macOS platforms

Getting Started

Requirements

  • Python 3.9 or newer

Usage Instructions

  1. Install Magic-PDF
pip install magic-pdf[cpu] # Install the CPU version 
or
pip install magic-pdf[gpu] # Install the GPU version
  1. Usage via Command Line
magic-pdf --help

License Information

See LICENSE.md for details.

Acknowledgments