orhan/test
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README to introduce the customized mlm_prompt

Browse Source
This commit is contained in:
Soulter
2024-12-16 12:08:51 +08:00
parent c168703d5e
commit d66ef5fcca
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -39,7 +39,7 @@ result = markitdown.convert("test.xlsx")
print(result.text_content) 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 ```python
from markitdown import MarkItDown from markitdown import MarkItDown
@@ -51,6 +51,13 @@ result = md.convert("example.jpg")
print(result.text_content) 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 ## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a This project welcomes contributions and suggestions. Most contributions require you to agree to a