Commit 4383720
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
1 file changed
+31
-7
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
29 | 48 | | |
30 | 49 | | |
31 | 50 | | |
| |||
65 | 84 | | |
66 | 85 | | |
67 | 86 | | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
75 | 99 | | |
76 | 100 | | |
77 | 101 | | |
| |||
0 commit comments