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 generates gpu kernel analysis output from nsys rep. Will call nsys
"""This generates gpu kernel analysis output from nsys rep. Will call nsys
stats -r cuda_gpu_kern_trace, get non-overlapped gpu cycles, then generate
csv and html output for analysis
"""
@@ -17,7 +16,7 @@ logger = logging.getLogger(__name__)
# helper data class for annotating kernels
def load_engine_model():
"""returns engine_model built from all json files in the current dir"""
"""Returns engine_model built from all json files in the current dir."""
import glob
import json
@@ -31,9 +30,7 @@ def load_engine_model():
class GPUTrace2Graph:
"""
Parses output of nsys report, generates csv and bar chart output
"""
"""Parses output of nsys report, generates csv and bar chart output."""
def __init__(self):
import pandas as pd # avoid importing till needed
@@ -64,8 +61,7 @@ class GPUTrace2Graph:
)
def sum_non_overlapping_intervals(self, df):
"""
returns new sorted df with Elapsed Time (ns) column using
"""Returns new sorted df with Elapsed Time (ns) column using
vectorized operations
"""
logger.info("sorting %s trace records by start time", str(df.shape))
@@ -105,7 +101,7 @@ class GPUTrace2Graph:
# functions for generating html files
def make_html(self, df, output_dir, title):
"""make html graph from df"""
"""Make html graph from df."""
import plotly.express as px
if df.empty:
@@ -163,7 +159,7 @@ class GPUTrace2Graph:
)
def anno_gpu_kernname(self, df, mapping):
"""add "Category" column"""
"""Add "Category" column."""
def anno_gpu_kernname_helper(name):
for kern_name, val in mapping.items():
@@ -173,7 +169,7 @@ class GPUTrace2Graph:
df["Category"] = df["Name"].apply(anno_gpu_kernname_helper)
def make_nongpu_row(self, df, nongpu_sec):
"""this will append non-gpu time entry at end of df"""
"""This will append non-gpu time entry at end of df."""
nongpu_row = self.pd.DataFrame([df.iloc[-1]])
nongpu_row["Category"] = nongpu_row["Name"] = "CPU(non-GPU)"
nongpu_row["Instances"] = 1
@@ -181,13 +177,13 @@ class GPUTrace2Graph:
return nongpu_row
def is_valid_file(self, base_file):
"""asserts if base_file is non-existent or is empty"""
"""Asserts if base_file is non-existent or is empty."""
assert os.path.isfile(base_file) and os.path.getsize(base_file) > 0, (
f"{base_file} doesn't exist or is empty"
)
def should_gen_file(self, new_file, base_file):
"""figure out if new file should be generated from base_file"""
"""Figure out if new file should be generated from base_file."""
self.is_valid_file(base_file)
if (
os.path.exists(new_file)
@@ -201,8 +197,7 @@ class GPUTrace2Graph:
return True
def gen_sum_file(self, file, nsys_cmd):
"""
generates sum file from nsys trace with times per kernel and
"""Generates sum file from nsys trace with times per kernel and
returns the name of the sum file
"""
import subprocess
@@ -246,7 +241,7 @@ class GPUTrace2Graph:
return sum_file
def gen_graph(self, in_file, out_dir, title, nsys_cmd, engine_model):
"""generates graph and csv file from in_file into out_dir"""
"""Generates graph and csv file from in_file into out_dir."""
# Initialize an empty DataFrame to store combined data
combined_df = self.pd.DataFrame()
for idx, (file, engine, model, total_sec) in enumerate(in_file):