Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CosmosShadow committed Aug 7, 2024
1 parent 1244c4a commit e63d87e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 18 deletions.
42 changes: 24 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,28 +120,34 @@ Parses a PDF file into a Markdown file and returns the Markdown content along wi

You can pass custom prompts in the form of a dictionary to replace any of the prompts. Here is an example:

```python
prompt = {
"prompt": "Custom prompt text",
"rect_prompt": "Custom rect prompt",
"role_prompt": "Custom role prompt"
}

content, image_paths = parse_pdf(
pdf_path=pdf_path,
output_dir='./output',
model="gpt-4o",
prompt=prompt,
verbose=False,
)
```

- **args"": LLM other parameters, such as `temperature`, `top_p`, `max_tokens`, `presence_penalty`, `frequency_penalty`, etc.

prompt = {
"prompt": "Custom prompt text",
"rect_prompt": "Custom rect prompt",
"role_prompt": "Custom role prompt"
}
content, image_paths = parse_pdf(
pdf_path=pdf_path,
output_dir='./output',
model="gpt-4o",
prompt=prompt,
verbose=False,
)
```



**args**: LLM other parameters, such as `temperature`, `top_p`, `max_tokens`, `presence_penalty`, `frequency_penalty`, etc.





## Join Us 👏🏻

Scan the QR code below with WeChat to join our group chat or contribute.

<p align="center">
<img src="./docs/wechat.jpg" alt="wechat" width=400/>
</p>
</p>
4 changes: 4 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,10 @@ def parse_pdf(
- **args"": LLM 中其他参数,例如 `temperature``max_tokens`, `top_p`, `frequency_penalty`, `presence_penalty` 等。






## 加入我们👏🏻

使用微信扫描下方二维码,加入微信群聊,或参与贡献。
Expand Down

0 comments on commit e63d87e

Please sign in to comment.