Skip to content

Minor cleanup in the README, allow docker compose env vars to be overidden #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ Default: 9192

### --model
Specifies the model to load. This will be downloaded automatically if it does not exist.
\
Default: Qwen2.5-VL-7B-Instruct
\
Choices: Qwen2.5-VL-3B-Instruct, Qwen2.5-VL-7B-Instruct, Qwen2.5-VL-72B-Instruct

### --resume
Expand Down Expand Up @@ -128,8 +130,7 @@ curl http://localhost:9192/health

Environment variables in docker-compose.yml:
- `NVIDIA_VISIBLE_DEVICES`: GPU device selection
- `MODEL_DIR`: Model directory path
- `PORT`: API port (default: 9192)
- `QWEN_MODEL`: Select the Qwen 2.5 VL model to load

## Integration with OpenWebUI

Expand Down Expand Up @@ -228,22 +229,3 @@ This project is licensed under the MIT License - see the LICENSE file for detail
## Support

For issues and feature requests, please use the GitHub issue tracker.
```

This README provides:
1. Clear installation instructions
2. API documentation
3. Configuration options
4. System requirements
5. Usage examples
6. Development guidelines
7. Monitoring information
8. Error handling details
9. Contributing guidelines

You may want to customize:
- Repository URLs
- License information
- Specific system requirements based on your deployment
- Additional configuration options
- Any specific deployment instructions for your environment
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ services:
count: all
capabilities: [gpu]
environment:
- NVIDIA_VISIBLE_DEVICES=all
- NVIDIA_VISIBLE_DEVICES=${NVIDIA_VISIBLE_DEVICES:-"all"}
- QWEN_MODEL: ${QWEN_MODEL:-"Qwen2.5-VL-7B-Instruct"}
restart: unless-stopped
healthcheck:
Expand Down