MinerU icon indicating copy to clipboard operation
MinerU copied to clipboard

对输出结果中的各参数做出一个说明

Open WillingLau opened this issue 1 year ago • 5 comments

或许可以写一个文档,对输出结果中的文档做一个说明,因为输出的文档有很多种,而各文档中又有多种参数等,对于刚接触这方面的人来说可能比较困难地读出各参数的意义

WillingLau avatar Jul 30 '24 06:07 WillingLau

输入参数也需要做个说明吧,每个参数的详细含义还是不太清晰,并且默认值也没有进行解释

(mineru) ➜  MinerU magic-pdf pdf-command --help
Usage: magic-pdf pdf-command [OPTIONS]

Options:
  --pdf PATH               PDF文件的路径  [required]
  --model PATH             模型的路径
  --method [ocr|txt|auto]  指定解析方法。txt: 文本型 pdf 解析方法, ocr: 光学识别解析
                           pdf, auto: 程序智能选择解析方法
  --inside_model BOOLEAN   使用内置模型测试
  --model_mode TEXT        内置模型选择。lite: 快速解析,精度较低,full: 高精度解析,速度较慢
  --help                   Show this message and exit.

Tendo33 avatar Jul 31 '24 03:07 Tendo33

@WillingLau @Tendo33 we'll pub a new release 0.7.0, document will be ok.

drunkpig avatar Jul 31 '24 14:07 drunkpig

@WillingLau @Tendo33 we'll pub a new release 0.7.0, document will be ok.

next week, about first week of Aug.

drunkpig avatar Jul 31 '24 14:07 drunkpig

@WillingLau @Tendo33 please refer to https://github.com/opendatalab/MinerU/blob/master/README_zh-CN_v2.md, we'll release it latter.

drunkpig avatar Aug 01 '24 11:08 drunkpig

@WillingLau @Tendo33 please refer to https://github.com/opendatalab/MinerU/blob/master/README_zh-CN_v2.md, we'll release it latter.

I saw in the v2 README that the command line usage and parameters have changed, right? But hasn't this new version not been released yet?

(mineru) ➜  minerU git:(main) ✗ magic-pdf --help
Usage: magic-pdf [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --version  显示版本信息
  -h, --help     显示帮助信息

Commands:
  json-command
  local-json-command
  pdf-command

@drunkpig

Tendo33 avatar Aug 07 '24 03:08 Tendo33

https://github.com/opendatalab/MinerU/blob/master/docs/output_file_zh_cn.md

myhloli avatar Jan 05 '25 14:01 myhloli