pyproject.toml

[build-system]
requires = ["setuptools>=68", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "commprof"
version = "1.0.0"
description = "Per layer DDP gradient all-reduce profiling for PyTorch, with a calibrated ring all-reduce cost model."
readme = "README.md"
license = { text = "MIT" }
requires-python = ">=3.11"
authors = [{ name = "Olajide Badejo" }]
keywords = ["pytorch", "ddp", "distributed-training", "profiling", "nccl", "mlsys"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: System :: Benchmark",
]
dependencies = [
    "torch>=2.4",
    "torchvision>=0.19",
    "numpy>=1.26",
    "pyyaml>=6.0",
    "tqdm>=4.66",
    "matplotlib>=3.8",
    "pandas>=2.1",
]

[project.optional-dependencies]
# ruff and mypy are pinned exactly rather than by lower bound. Both change their
# output across minor releases, so an unpinned CI would eventually fail a build that
# passes locally, on a formatting rule nobody chose to adopt.
dev = [
    "pytest>=8.0",
    "pytest-cov>=5.0",
    "ruff==0.16.0",
    "mypy==2.3.0",
    "pre-commit>=3.8",
    "types-PyYAML",
    "pandas-stubs",
]

[project.scripts]
commprof = "commprof.cli:main"

[project.urls]
Homepage = "https://github.com/Olajide-Badejo/Distributed-Training-Communication-Profiler"
Repository = "https://github.com/Olajide-Badejo/Distributed-Training-Communication-Profiler"
Issues = "https://github.com/Olajide-Badejo/Distributed-Training-Communication-Profiler/issues"

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.package-data]
commprof = ["py.typed"]

[tool.ruff]
line-length = 100
target-version = "py311"
src = ["src", "tests", "scripts"]

[tool.ruff.lint]
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # pyflakes
    "I",   # isort
    "N",   # pep8-naming
    "UP",  # pyupgrade
    "B",   # flake8-bugbear
    "C4",  # flake8-comprehensions
    "SIM", # flake8-simplify
    "RUF", # ruff specific
    "D",   # pydocstyle
]
ignore = [
    "D107",  # __init__ docstring lives on the class
    "D203",  # incompatible with D211
    "D213",  # incompatible with D212
    "B008",  # function call in default argument, used deliberately for configs
]

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["D100", "D101", "D102", "D103", "D104"]
"scripts/*" = ["D103"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.mypy]
python_version = "3.11"
files = ["src", "scripts", "tests"]
warn_unused_configs = true
warn_redundant_casts = true
warn_unused_ignores = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
check_untyped_defs = true
no_implicit_optional = true
strict_equality = true

[[tool.mypy.overrides]]
module = ["torchvision.*", "matplotlib.*", "tqdm.*", "scipy.*"]
ignore_missing_imports = true

[[tool.mypy.overrides]]
# Test bodies are assertions, not API. Annotating every `-> None` adds noise
# without adding safety, so the two strictness flags that would demand it are off
# here. Everything else, including argument types, still applies.
#
# This pattern only resolves because the test tree carries __init__.py files. Without
# them mypy names each module by basename and `tests.*` matches nothing.
module = ["tests.*"]
disallow_untyped_defs = false
disallow_incomplete_defs = false

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-ra --strict-markers"
markers = [
    "gpu: requires a CUDA device (skipped in CI)",
    "slow: takes more than a few seconds",
    "integration: spawns real processes",
    "timing: asserts a relationship between measured durations, so it depends on how fast the machine is (excluded in CI)",
]
filterwarnings = ["ignore::DeprecationWarning"]