Skip to content

Commit

Permalink
updated readme - Adithya S K
Browse files Browse the repository at this point in the history
  • Loading branch information
adithya-s-k committed Jun 10, 2024
1 parent a7ece55 commit 398d9e3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# OmniParse
API to Convert anything to markdown
<div align="center">
<img src="./docs/assets/hero_image.jpeg" width="300"/>
<p>1 API to convert anything to markdown<p>
</div>

> [!IMPORTANT]
>
Expand All @@ -9,30 +12,12 @@ API to Convert anything to markdown

✅ Supports 15+ file types \
✅ Convert Documents, Multimedia, Web pages to high-quality structured markdown \
✅ Table Extraction, Image Extraction/Captioning, Audio Transcription, Web page Crawling \
✅ Table Extraction, Image Extraction/Captioning, Audio/Video Transcription, Web page Crawling \
✅ Easily Deployable using Docker and Skypilot \
✅ CPU/GPU compatible \
✅ Batch processing for handling multiple files at once \
✅ Comprehensive logging and error handling for robust performance \

## Supported File Types

| Type | Supported Extensions |
|------------|-----------------------------------------|
| Documents | .doc, .docx, .epub, .odt, .pdf, .ppt, .pptx |

<!--
| Type | Supported Extensions |
|-----------|-----------------------------------------------------|
| Plaintext | .eml, .html, .md, .msg, .rst, .rtf, .txt, .xml |
| Documents | .doc, .docx, .epub, .odt, .pdf, .ppt, .pptx |
| Table | .csv, .xlsx |
| Images | .png, .jpg, .jpeg, .tiff, .bmp, .heic |
| Video | .mp4, .mkv, .avi, .mov |
| Audio | .mp3, .wav, .aac |
| Web | dynamic webpages, http://<anything>.com |
| Crawl | dynamic webpages, http://<anything>.com |
-->

## Installation

Expand Down Expand Up @@ -91,6 +76,24 @@ document = parser.load_data('path/to/document.pdf')
parser.save_to_markdown(document)
```

## Supported File Types

| Type | Supported Extensions |
|------------|-----------------------------------------|
| Documents | .doc, .docx, .epub, .odt, .pdf, .ppt, .pptx |

<!--
| Type | Supported Extensions |
|-----------|-----------------------------------------------------|
| Plaintext | .eml, .html, .md, .msg, .rst, .rtf, .txt, .xml |
| Documents | .doc, .docx, .epub, .odt, .pdf, .ppt, .pptx |
| Table | .csv, .xlsx |
| Images | .png, .jpg, .jpeg, .tiff, .bmp, .heic |
| Video | .mp4, .mkv, .avi, .mov |
| Audio | .mp3, .wav, .aac |
| Web | dynamic webpages, http://<anything>.com |
| Crawl | dynamic webpages, http://<anything>.com |
-->


## License
Expand Down
Binary file added docs/assets/hero_image.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 398d9e3

Please sign in to comment.