install.rst 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. Install
  2. ===============================================================
  3. If you encounter any installation issues, please first consult the :doc:`../../additional_notes/faq`.
  4. If the parsing results are not as expected, refer to the :doc:`../../additional_notes/known_issues`.
  5. Also you can try `online demo <https://www.modelscope.cn/studios/OpenDataLab/MinerU>`_ without installation.
  6. .. admonition:: Warning
  7. :class: tip
  8. **Pre-installation Notice—Hardware and Software Environment Support**
  9. To ensure the stability and reliability of the project, we only optimize
  10. and test for specific hardware and software environments during
  11. development. This ensures that users deploying and running the project
  12. on recommended system configurations will get the best performance with
  13. the fewest compatibility issues.
  14. By focusing resources on the mainline environment, our team can more
  15. efficiently resolve potential bugs and develop new features.
  16. In non-mainline environments, due to the diversity of hardware and
  17. software configurations, as well as third-party dependency compatibility
  18. issues, we cannot guarantee 100% project availability. Therefore, for
  19. users who wish to use this project in non-recommended environments, we
  20. suggest carefully reading the documentation and FAQ first. Most issues
  21. already have corresponding solutions in the FAQ. We also encourage
  22. community feedback to help us gradually expand support.
  23. .. raw:: html
  24. <style>
  25. table, th, td {
  26. border: 1px solid black;
  27. border-collapse: collapse;
  28. }
  29. </style>
  30. <table>
  31. <tr>
  32. <td colspan="3" rowspan="2">Operating System</td>
  33. </tr>
  34. <tr>
  35. <td>Linux after 2019</td>
  36. <td>Windows 10 / 11</td>
  37. <td>macOS 11+</td>
  38. </tr>
  39. <tr>
  40. <td colspan="3">CPU</td>
  41. <td>x86_64 / arm64</td>
  42. <td>x86_64(unsupported ARM Windows)</td>
  43. <td>x86_64 / arm64</td>
  44. </tr>
  45. <tr>
  46. <td colspan="3">Memory Requirements</td>
  47. <td colspan="3">16GB or more, recommended 32GB+</td>
  48. </tr>
  49. <tr>
  50. <td colspan="3">Storage Requirements</td>
  51. <td colspan="3">20GB or more, with a preference for SSD</td>
  52. </tr>
  53. <tr>
  54. <td colspan="3">Python Version</td>
  55. <td colspan="3">3.10~3.13</td>
  56. </tr>
  57. <tr>
  58. <td colspan="3">Nvidia Driver Version</td>
  59. <td>latest (Proprietary Driver)</td>
  60. <td>latest</td>
  61. <td>None</td>
  62. </tr>
  63. <tr>
  64. <td colspan="3">CUDA Environment</td>
  65. <td colspan="2"><a href="https://pytorch.org/get-started/locally/">Refer to the PyTorch official website</a></td>
  66. <td>None</td>
  67. </tr>
  68. <tr>
  69. <td colspan="3">CANN Environment(NPU support)</td>
  70. <td>8.0+(Ascend 910b)</td>
  71. <td>None</td>
  72. <td>None</td>
  73. </tr>
  74. <tr>
  75. <td rowspan="2">GPU/MPS Hardware Support List</td>
  76. <td colspan="2">GPU VRAM 6GB or more</td>
  77. <td colspan="2">All GPUs with Tensor Cores produced from Volta(2017) onwards.<br>
  78. More than 6GB VRAM </td>
  79. <td rowspan="2">Apple silicon</td>
  80. </tr>
  81. </table>
  82. Create an environment
  83. ---------------------------
  84. .. code-block:: shell
  85. conda create -n mineru 'python=3.12' -y
  86. conda activate mineru
  87. pip install -U "magic-pdf[full]"
  88. Download model weight files
  89. ------------------------------
  90. .. code-block:: shell
  91. pip install huggingface_hub
  92. wget https://github.com/opendatalab/MinerU/raw/master/scripts/download_models_hf.py -O download_models_hf.py
  93. python download_models_hf.py
  94. Install LibreOffice[Optional]
  95. ----------------------------------
  96. This section is required for handle **doc**, **docx**, **ppt**, **pptx** filetype, You can **skip** this section if no need for those filetype processing.
  97. Linux/Macos Platform
  98. """"""""""""""""""""""
  99. .. code::
  100. apt-get/yum/brew install libreoffice
  101. Windows Platform
  102. """"""""""""""""""""
  103. .. code::
  104. install libreoffice
  105. append "install_dir\LibreOffice\program" to ENVIRONMENT PATH
  106. .. tip::
  107. The MinerU is installed, Check out :doc:`../usage/command_line` to convert your first pdf **or** reading the following sections for more details about install