Add pydocstyle to the ruff rules (#52136)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <hej.mellor@gmail.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Harry Mellor
2026-09-16 16:44:29 +00:00
committed by GitHub
co-authored by Claude Opus 5
parent 804e5377aa
commit 8c1557a79c
2002 changed files with 15024 additions and 14269 deletions
@@ -1,7 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""
This script demonstrates how to use the vLLM API server to perform audio
"""This script demonstrates how to use the vLLM API server to perform audio
transcription with the `openai/whisper-large-v3` model.
Before running this script, you must start the vLLM server with the following command:
@@ -35,8 +34,7 @@ def sync_openai(
hotwords: str = None,
prompt: str | None = None,
):
"""
Perform synchronous transcription using OpenAI-compatible API.
"""Perform synchronous transcription using OpenAI-compatible API.
The optional ``prompt`` is the OpenAI-API ``prompt`` field (style /
vocabulary hint). It is wired through model-by-model: Whisper uses it
@@ -69,9 +67,7 @@ async def stream_openai_response(
hotwords: str = None,
prompt: str | None = None,
):
"""
Perform asynchronous transcription using OpenAI-compatible API.
"""
"""Perform asynchronous transcription using OpenAI-compatible API."""
print("\ntranscription result [stream]:", end=" ")
with open(audio_path, "rb") as f:
transcription = await client.audio.transcriptions.create(
@@ -98,9 +94,7 @@ async def stream_openai_response(
def stream_api_response(audio_path: str, model: str, openai_api_base: str):
"""
Perform streaming transcription using raw HTTP requests to the vLLM API server.
"""
"""Stream a transcription using raw HTTP requests to the vLLM API server."""
import json
import os
@@ -1,7 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""
This script demonstrates how to use the vLLM Realtime WebSocket API to perform
"""This script demonstrates how to use the vLLM Realtime WebSocket API to perform
audio transcription by uploading an audio file.
Before running this script, you must start the vLLM server with a realtime-capable
@@ -34,9 +33,7 @@ from vllm.multimodal.media.audio import load_audio
def audio_to_pcm16_base64(audio_path: str) -> str:
"""
Load an audio file and convert it to base64-encoded PCM16 @ 16kHz.
"""
"""Load an audio file and convert it to base64-encoded PCM16 @ 16kHz."""
# Load audio and resample to 16kHz mono
audio, _ = load_audio(audio_path, sr=16000, mono=True)
# Convert to PCM16
@@ -46,9 +43,7 @@ def audio_to_pcm16_base64(audio_path: str) -> str:
async def realtime_transcribe(audio_path: str, host: str, port: int, model: str):
"""
Connect to the Realtime API and transcribe an audio file.
"""
"""Connect to the Realtime API and transcribe an audio file."""
uri = f"ws://{host}:{port}/v1/realtime"
async with websockets.connect(uri) as ws:
@@ -1,7 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""
Minimal Gradio demo for real-time speech transcription using the vLLM Realtime API.
"""Minimal Gradio demo for real-time speech transcription using the vLLM Realtime API.
Start the vLLM server first: