From d66ef5fccaa49b9a1b95e5e043ebc44f8a88f5a4 Mon Sep 17 00:00:00 2001 From: Soulter <905617992@qq.com> Date: Mon, 16 Dec 2024 12:08:51 +0800 Subject: [PATCH] Update README to introduce the customized mlm_prompt --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df7189d..3eac77b 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ result = markitdown.convert("test.xlsx") print(result.text_content) ``` -You can also configure markitdown to use Large Language Models to describe images. To do so you must provide mlm_client and mlm_model parameters to MarkItDown object, according to your specific client. +You can also configure markitdown to use Large Language Models to describe images. To do so you must provide `mlm_client` and `mlm_model` parameters to MarkItDown object, according to your specific client. ```python from markitdown import MarkItDown @@ -51,6 +51,13 @@ result = md.convert("example.jpg") print(result.text_content) ``` +The prompt of describing images can be customized by providing `mlm_prompt` parameter. + +```python +# ... +result = md.convert("example.jpg", mlm_prompt="Customized prompt") +``` + ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a