index.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. .. xtuner documentation master file, created by
  2. sphinx-quickstart on Tue Jan 9 16:33:06 2024.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. 欢迎来到 MinerU 文档库
  6. ==============================================
  7. .. figure:: ./_static/image/logo.png
  8. :align: center
  9. :alt: mineru
  10. :class: no-scaled-link
  11. .. raw:: html
  12. <p style="text-align:center">
  13. <strong> 一站式、高质量的开源文档提取工具
  14. </strong>
  15. </p>
  16. <p style="text-align:center">
  17. <script async defer src="https://buttons.github.io/buttons.js"></script>
  18. <a class="github-button" href="https://github.com/opendatalab/MinerU" data-show-count="true" data-size="large" aria-label="Star">Star</a>
  19. <a class="github-button" href="https://github.com/opendatalab/MinerU/subscription" data-icon="octicon-eye" data-size="large" aria-label="Watch">Watch</a>
  20. <a class="github-button" href="https://github.com/opendatalab/MinerU/fork" data-icon="octicon-repo-forked" data-size="large" aria-label="Fork">Fork</a>
  21. </p>
  22. 项目介绍
  23. --------------------
  24. MinerU是一款将PDF转化为机器可读格式的工具(如markdown、json),可以很方便地抽取为任意格式。
  25. MinerU诞生于\ `书生-浦语 <https://github.com/InternLM/InternLM>`__\ 的预训练过程中,我们将会集中精力解决科技文献中的符号转化问题,希望在大模型时代为科技发展做出贡献。
  26. 相比国内外知名商用产品MinerU还很年轻,如果遇到问题或者结果不及预期请到\ `issue <https://github.com/opendatalab/MinerU/issues>`__\ 提交问题,同时\ **附上相关PDF**\ 。
  27. .. video:: https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c
  28. 主要功能
  29. --------
  30. - 删除页眉、页脚、脚注、页码等元素,确保语义连贯
  31. - 输出符合人类阅读顺序的文本,适用于单栏、多栏及复杂排版
  32. - 保留原文档的结构,包括标题、段落、列表等
  33. - 提取图像、图片描述、表格、表格标题及脚注
  34. - 自动识别并转换文档中的公式为LaTeX格式
  35. - 自动识别并转换文档中的表格为LaTeX或HTML格式
  36. - 自动检测扫描版PDF和乱码PDF,并启用OCR功能
  37. - OCR支持84种语言的检测与识别
  38. - 支持多种输出格式,如多模态与NLP的Markdown、按阅读顺序排序的JSON、含有丰富信息的中间格式等
  39. - 支持多种可视化结果,包括layout可视化、span可视化等,便于高效确认输出效果与质检
  40. - 支持CPU和GPU环境
  41. - 兼容Windows、Linux和Mac平台
  42. 用户指南
  43. -------------
  44. .. toctree::
  45. :maxdepth: 2
  46. :caption: 用户指南
  47. user_guide
  48. API 接口
  49. -------------
  50. 本章节主要介绍函数、类、类方法的细节信息
  51. 目前只提供英文版本的接口文档,请切换到英文版本的接口文档!
  52. 附录
  53. ------------------
  54. .. toctree::
  55. :maxdepth: 1
  56. :caption: 附录
  57. additional_notes/known_issues
  58. additional_notes/faq
  59. additional_notes/glossary