Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vllm_top-0.1.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vllm_top-0.1.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file vllm_top-0.1.0.tar.gz.

File metadata

  • Download URL: vllm_top-0.1.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for vllm_top-0.1.0.tar.gz
Algorithm Hash digest
SHA256 eb7be9c0d7a060e296d03da4371b1a2a9a124680906d1c64ab6244e6546496ca
MD5 5b7a35c4a670b3e997af9b2e2d48e7f8
BLAKE2b-256 9a2d974c6e38353bcd2fb87ed599f2ea14aeda7ee69098d5001796832ad9a8d7

See more details on using hashes here.

File details

Details for the file vllm_top-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vllm_top-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for vllm_top-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a01b97530bf7a93a1c4592f4e97d8f7876efc49162fae22c508a32ce69a96982
MD5 7e54b537469572cb86e456c4c2d92fed
BLAKE2b-256 404d6530182494a3c7725bae5abde78c3e6eb0754cf7da2a9245726bf40e98f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page