Эх сурвалжийг харах

docs(readme): update installation and usage instructions

myhloli 1 жил өмнө
parent
commit
843a1acff4
2 өөрчлөгдсөн 5 нэмэгдсэн , 3 устгасан
  1. 2 1
      README.md
  2. 3 2
      README_zh-CN.md

+ 2 - 1
README.md

@@ -90,7 +90,7 @@ pip install magic-pdf
 # For complete parsing capabilities (including high-precision model parsing)
 pip install magic-pdf[full-cpu]
 
-# Additionally, you will need to install the dependency detectron2.
+# For high-precision model parsing, you will need to install the dependency detectron2.
 # For detectron2, compile it yourself as per https://github.com/facebookresearch/detectron2/issues/5114
 # Or use our precompiled wheel
 
@@ -136,6 +136,7 @@ In magic-pdf.json, configure "models-dir" to point to the directory where the mo
 ###### simple
 
 ```bash
+#If the full version is installed, you can invoke the built-in models for parsing.
 magic-pdf pdf-command --pdf "pdf_path" --inside_model true
 ```
 After the program has finished, you can find the generated markdown files under the directory "/tmp/magic-pdf".

+ 3 - 2
README_zh-CN.md

@@ -84,8 +84,8 @@ pip install magic-pdf
 # 完整解析功能(含内置高精度模型解析功能)
 pip install magic-pdf[full-cpu]
 
-# 另外需要安装依赖 detectron2
-# detectron2需要编译安装,自行编译安装可以参考https://github.com/facebookresearch/detectron2/issues/5114
+# 只有在需要高精度模型解析功能时,您需要额外安装依赖 detectron2
+# detectron2 需要编译安装,自行编译安装可以参考https://github.com/facebookresearch/detectron2/issues/5114
 # 或直接使用我们编译好的的whl包,不同系统请自行选择适配包安装
 
 # windows
@@ -125,6 +125,7 @@ cp magic-pdf.template.json ~/magic-pdf.json
 ###### 直接使用
 
 ```bash
+# 已安装full版本可以调用内置模型进行解析
 magic-pdf pdf-command --pdf "pdf_path" --inside_model true
 ```
 程序运行完成后,你可以在"/tmp/magic-pdf"目录下看到生成的markdown文件,markdown目录中可以找到对应的xxx_model.json文件