docs: update README to match vlmrun-hub style #11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Sudeep Pillai <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
spillai
reviewed
Jan 7, 2025
README.md
Outdated
| ## VLM Run Python SDK | ||
|
|
||
| ## Installation | ||
| Welcome to the **VLM Run Python SDK**, a powerful and intuitive Python interface for interacting with VLM Run's Vision Language Model APIs. This SDK provides seamless integration capabilities for processing images, videos, and documents using state-of-the-art vision language models. |
Contributor
There was a problem hiding this comment.
Co-Authored-By: Sudeep Pillai <[email protected]>
spillai
reviewed
Jan 7, 2025
README.md
Outdated
| <a href="https://pypi.org/project/vlmrun/"><img alt="PyPI Version" src="https://img.shields.io/pypi/pyversions/vlmrun"></a> | ||
| <a href="https://www.pepy.tech/projects/vlmrun"><img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/vlmrun"></a><br> | ||
| <a href="https://github.com/vlm-run/vlmrun-python-sdk/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/vlm-run/vlmrun-python-sdk.svg"></a> | ||
| <a href="https://discord.gg/4jgyECY4rq"><img alt="Discord" src="https://img.shields.io/badge/discord-chat-purple?color=%235765F2&label=discord&logo=discord"></a> |
Contributor
There was a problem hiding this comment.
Use https://discord.gg/AMApC2UzVY instead of https://discord.gg/4jgyECY4rq
README.md
Outdated
|
|
||
| ## 💡 Motivation | ||
|
|
||
| The VLM Run Python SDK is designed to make it easy for developers to integrate vision language models into their applications. It provides: |
Contributor
There was a problem hiding this comment.
Vision Language Models (VLMs)
README.md
Outdated
|
|
||
| - 🔑 **Simple Authentication**: Easy-to-use client setup with API key management | ||
| - 🎯 **Type Safety**: Full type hints and modern Python typing support | ||
| - 🔄 **Async Support**: Both synchronous and asynchronous API interfaces |
Contributor
There was a problem hiding this comment.
Remove async support for now
README.md
Outdated
|
|
||
| ## 🔗 Quick Links | ||
|
|
||
| * 💬 Need help? Email us at [[email protected]](mailto:[email protected]) or join our [Discord](https://discord.gg/4jgyECY4rq) |
Contributor
There was a problem hiding this comment.
Change the discord URL as indicated above.
README.md
Outdated
| image = download_image("https://example.com/image.jpg") | ||
| ``` | ||
|
|
||
| ### Async Client |
Contributor
There was a problem hiding this comment.
Remove references to Async client
README.md
Outdated
| Welcome to the **VLM Run Python SDK**, a powerful and intuitive Python interface for interacting with [VLM Run's Vision Language Model APIs](https://vlm.run). This SDK provides seamless integration capabilities for processing images, videos, and documents using state-of-the-art vision language models. | ||
|
|
||
| <p align="center"> | ||
| <a href="https://vlm.run"><b>Website</b></a> | <a href="https://docs.vlm.run/"><b>Docs</b></a> | <a href="https://docs.vlm.run/blog"><b>Blog</b></a> | <a href="https://discord.gg/CCY8cYNC"><b>Discord</b></a> |
Contributor
There was a problem hiding this comment.
Use https://discord.gg/AMApC2UzVY instead of https://discord.gg/CCY8cYNC
…pdate Discord links Co-Authored-By: Sudeep Pillai <[email protected]>
spillai
reviewed
Jan 7, 2025
README.md
Outdated
|
|
||
| ## 💡 Motivation | ||
|
|
||
| The VLM Run Python SDK is designed to make it easy for developers to integrate vision language models into their applications. It provides: |
Contributor
There was a problem hiding this comment.
"integrate vision language models" -> "integrate Vision Language Models with the VLM Run API"
…I link Co-Authored-By: Sudeep Pillai <[email protected]>
spillai
reviewed
Jan 7, 2025
README.md
Outdated
| ## VLM Run Python SDK | ||
|
|
||
| ## Installation | ||
| Welcome to the **VLM Run Python SDK**, a powerful and intuitive Python interface for interacting with [VLM Run's Vision Language Model APIs](https://vlm.run). Vision Language Models (VLMs) are AI models that can understand and process both visual and textual information, enabling sophisticated analysis of images and documents. This SDK provides seamless integration capabilities for processing images, videos, and documents using state-of-the-art vision language models. |
Contributor
There was a problem hiding this comment.
Use https://docs.vlm.run instead of https://vlm.run
Contributor
There was a problem hiding this comment.
Re-write the heading to something simpler:
The VLM Run Python SDK is the official Python client for VLM Run API platform, providing a convenient way to interacting with our REST APIs.
Co-Authored-By: Sudeep Pillai <[email protected]>
Co-Authored-By: Sudeep Pillai <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update README to match vlmrun-hub style
This PR updates the README.md to follow a similar style and structure as the vlmrun-hub repository, improving documentation clarity and consistency across VLM Run projects.
Changes
Testing
✅ Changes are documentation-only and have been manually verified:
Link to Devin run: https://app.devin.ai/sessions/58e5fce35486415e9d3982a99f53b031