Skip to content

Commit 4383720

Browse files
docs: update readme with current directory structure and installation extras (#26)
# Documentation Updates This PR updates the README.md to accurately reflect the current state of the codebase: ## Changes Made 1. Updated directory structure to show all current client files: - Added client.py (Main Client class) - Added base_requestor.py (Low-level request logic) - Added files.py (File operations) - Added models.py (Model operations) - Added finetune.py (Fine-tuning operations) - Added types.py (Client type definitions) - Removed outdated sync.py reference 2. Added installation extras documentation: - Video processing features (numpy, opencv-python) - Document processing features (pypdfium2) - All features combined option 3. Verified types/abstract.py usage: - Confirmed it's actively used by files.py, models.py, and finetune.py - Contains essential Client Protocol class - Kept in codebase as it's required 4. Confirmed Discord URL consistency: - All Discord links consistently use discord.gg/AMApC2UzVY - No inconsistencies found ## Testing Documentation-only changes, no code modifications required. Link to Devin run: https://app.devin.ai/sessions/f6485ae88e814f8fae7998b7c2622f81 Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Sudeep Pillai <sudeep@vlm.run>
1 parent 4d2e649 commit 4383720

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,25 @@ The [VLM Run Python SDK](https://pypi.org/project/vlmrun/) is the official Pytho
2626
pip install vlmrun
2727
```
2828

29+
### Installation with Optional Features
30+
31+
The package provides optional features that can be installed based on your needs:
32+
33+
- Video processing features (numpy, opencv-python):
34+
```bash
35+
pip install "vlmrun[video]"
36+
```
37+
38+
- Document processing features (pypdfium2):
39+
```bash
40+
pip install "vlmrun[doc]"
41+
```
42+
43+
- All optional features:
44+
```bash
45+
pip install "vlmrun[all]"
46+
```
47+
2948
### Basic Usage
3049

3150
```python
@@ -65,13 +84,18 @@ image = download_image("https://example.com/image.jpg")
6584

6685
```bash
6786
vlmrun/
68-
├── client/ # Client implementation
69-
│ └── sync.py # Synchronous client
70-
├── common/ # Common utilities
71-
│ ├── auth.py # Authentication utilities
72-
│ └── image.py # Image processing utilities
73-
└── types/ # Type definitions
74-
└── responses.py # API response types
87+
├── client/ # Client implementation
88+
│ ├── client.py # Main Client class
89+
│ ├── base_requestor.py # Low-level request logic
90+
│ ├── files.py # File operations
91+
│ ├── models.py # Model operations
92+
│ ├── finetune.py # Fine-tuning operations
93+
│ └── types.py # Client type definitions
94+
├── common/ # Common utilities
95+
│ ├── auth.py # Authentication utilities
96+
│ └── image.py # Image processing utilities
97+
└── types/ # Type definitions
98+
└── abstract.py # Abstract base classes
7599
```
76100

77101
## 🔗 Quick Links

0 commit comments

Comments
 (0)