A monitoring tool for vLLM metrics.
Project description
vllm-top
vllm-top is a Python package designed for monitoring and displaying metrics from the vLLM (Variable-length Language Model) service. It provides a comprehensive dashboard that visualizes the current state and historical performance of the service, making it easier to track its behavior and performance over time.
Features
- Fetches and parses metrics from the vLLM service.
- Displays real-time metrics in a terminal dashboard.
- Supports background monitoring at a configurable frequency.
- Visualizes historical data with bar charts and sparklines.
- Provides cumulative statistics for prompt and generation tokens.
Installation
To install the package, you can use pip:
pip install vllm-top
Usage
To run the monitoring functionality, you can execute the following command:
python -m vllm_top.main --monitor [INTERVAL]
Replace [INTERVAL] with the desired refresh interval in seconds (default is 2 seconds).
For a one-time snapshot of the metrics, run:
python -m vllm_top.main
Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Changelog
For a detailed list of changes and updates, please refer to the CHANGELOG.md file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vllm_top-0.1.1.tar.gz.
File metadata
- Download URL: vllm_top-0.1.1.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96c1f16f95f45757a9038a02b7179c00a181a75b4bb42a86de251fadf09e5942
|
|
| MD5 |
ce385b6d3340e90707c05c3d4c6d3f5d
|
|
| BLAKE2b-256 |
a75dad62cdbcb98321f8c2649898c59e48ab65ba6a40119c86558d92a234dd5b
|
File details
Details for the file vllm_top-0.1.1-py3-none-any.whl.
File metadata
- Download URL: vllm_top-0.1.1-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bfe2caa740847845a0fba5b4692828b602e1ffdfdb74b924decb2dd13ba6569
|
|
| MD5 |
7e8273a8d0d21791cf16b84c49b38082
|
|
| BLAKE2b-256 |
9a8ddfc55527dad60e310436f795beca1171746da7b7001a2d5ceaca8d3567d2
|