Skip to content

Add "Performance Tips" section to README for large file optimization #1462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add "Performance Tips" section to README for large file optimization #1462

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,15 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc

You can also contribute by creating and sharing 3rd party plugins. See `packages/markitdown-sample-plugin` for more details.


## ⚡ Performance Tips

- For large PDFs, install optional dependencies with `pip install 'markitdown[pdf]'` to enable optimized parsing.
- Use `--no-ocr` flag (coming soon) or disable plugins if OCR slows down processing.
- Keep conversions local (not in Docker) if you need GPU acceleration for LLM-based image captioning.
- Check `markitdown --debug` for detailed logs on failed conversions.


## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
Expand Down