Skip to content

refactor: migrate project metadata to pyproject.toml (PEP 621) #2441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
NJX-njx wants to merge 1 commit into from
Closed

refactor: migrate project metadata to pyproject.toml (PEP 621) #2441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 122 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,128 @@
[build-system]
requires = ["setuptools", "wheel", "setuptools_scm==8.2.0"]
requires = ["setuptools>=75.0", "wheel", "setuptools_scm==8.2.0"]
build-backend = "setuptools.build_meta"


# ---------------------------------------------------------------------------
# PEP 621 – project metadata
# ---------------------------------------------------------------------------
[project]
name = "llmcompressor"
dynamic = ["version"]
description = """\
A library for compressing large language models utilizing the latest \
techniques and research in the field for both training aware and post \
training techniques. The library is designed to be flexible and easy \
to use on top of PyTorch and HuggingFace Transformers, allowing for \
quick experimentation.\
"""
readme = { file = "README.md", content-type = "text/markdown" }
license = "Apache-2.0"
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In PEP 621, project.license is typically a table ({text=...} or {file=...}), and SPDX expressions are standardized via PEP 639 using license-expression. If the intent is an SPDX identifier/expression, prefer license-expression = \"Apache-2.0\" (and optionally license-files) to avoid tooling/build metadata validation issues.

Suggested change
license = "Apache-2.0"
license-expression = "Apache-2.0"

Copilot uses AI. Check for mistakes.
requires-python = ">=3.10"
authors = [
{ name = "Neuralmagic, Inc.", email = "support@neuralmagic.com" },
]
keywords = [
"llmcompressor", "llms", "large language models", "transformers",
"pytorch", "huggingface", "compressors", "compression",
"quantization", "pruning", "sparsity", "optimization",
"model optimization", "model compression",
]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: Information Technology",
"Intended Audience :: Science/Research",
"Operating System :: POSIX :: Linux",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Scientific/Engineering :: Mathematics",
"Topic :: Software Development",
"Topic :: Software Development :: Libraries :: Python Modules",
]
Comment on lines +31 to +45
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous setup.py classifiers included a license Trove classifier (License :: OSI Approved :: Apache Software License), but it’s missing from the migrated list. If you still want that metadata on PyPI, add the license classifier back under project.classifiers.

Copilot uses AI. Check for mistakes.
dependencies = [
"loguru>=0.7.2",
"pyyaml>=6.0.1",
"numpy>=2.0.0",
"requests>=2.32.2",
"tqdm>=4.66.3",
"torch>=2.9.0",
"transformers>=4.56.1,<=4.57.6",
"datasets>=4.0.0",
"auto-round>=0.9.6",
"accelerate>=1.6.0",
"nvidia-ml-py>=12.560.30",
"pillow>=10.4.0",
"compressed-tensors>=0.14.1a2",
]

[project.optional-dependencies]
dev = [
# testing framework
"pytest>=6.0.0",
"pytest-mock>=3.6.0",
"pytest-rerunfailures>=13.0",
"lm_eval==0.4.9.2",
# test dependencies
"beautifulsoup4~=4.12.3",
"cmarkgfm>=2024.1.14",
"trl>=0.10.1",
"pandas<2.3.0",
"torchvision",
"librosa==0.11.0",
"soundfile",
"torchcodec",
# linting, formatting, and type checking
"mypy~=1.10.0",
"ruff~=0.4.8",
# pre commit hooks
"pre-commit",
# docs
"mkdocs",
"mkdocs-material[imaging]",
"markdown",
"pymdown-extensions",
"mkdocs-section-index",
"mkdocs-minify-plugin",
"mkdocs-api-autonav",
"mkdocstrings-python",
"mkdocs-gen-files",
"mkdocs-awesome-nav",
]
qwen = [
"qwen_vl_utils",
]

[project.urls]
Homepage = "https://github.com/vllm-project/llm-compressor"
Repository = "https://github.com/vllm-project/llm-compressor"
Issues = "https://github.com/vllm-project/llm-compressor/issues"
Documentation = "https://llm-compressor.github.io/llm-compressor/"

[project.scripts]
"llmcompressor.trace" = "llmcompressor.transformers.tracing.debug:main"
"llmcompressor.reindex_fused_weights" = "llmcompressor.entrypoints.model_free.reindex_fused_weights:main"


# ---------------------------------------------------------------------------
# setuptools
# ---------------------------------------------------------------------------
[tool.setuptools.packages.find]
where = ["src"]
include = ["llmcompressor", "llmcompressor.*"]
exclude = ["*.__pycache__.*"]

[tool.setuptools_scm]
version_file = "src/llmcompressor/version.py"


# ---------------------------------------------------------------------------
# Tool configuration
# ---------------------------------------------------------------------------

[tool.mypy]
files = "src/guidellm"
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The [tool.mypy] configuration still points to src/guidellm. This appears to be a leftover from a previous project or a typo. It should be updated to src/llmcompressor to correctly apply type checking to the current project's source code.

Suggested change
files = "src/guidellm"
files = "src/llmcompressor"


Expand Down
196 changes: 45 additions & 151 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
"""
Thin setup.py retained for setuptools_scm version computation and
BUILD_TYPE-dependent dependency pinning for release / nightly builds.

All static project metadata has moved to pyproject.toml (PEP 621).
For local development you can simply run:

pip install -e ".[dev]" # or: uv pip install -e ".[dev]"

Release and nightly CI pipelines should set BUILD_TYPE=release or
BUILD_TYPE=nightly before invoking the build.
"""

import os
import sys
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sys is imported but no longer used after removing the debug print(...) block. Removing the unused import will avoid lint noise and keep the thin setup.py focused.

Copilot uses AI. Check for mistakes.

from setuptools import find_packages, setup
from setuptools import setup
from setuptools_scm import ScmVersion

# Set the build type using an environment variable to give us
# different package names based on the reason for the build.
# ---- build-type gating -----------------------------------------------------
VALID_BUILD_TYPES = {"release", "nightly", "dev"}
BUILD_TYPE = os.environ.get("BUILD_TYPE", "dev")
if BUILD_TYPE not in VALID_BUILD_TYPES:
Expand All @@ -14,6 +26,7 @@
)


# ---- version helpers --------------------------------------------------------
def version_func(version: ScmVersion) -> str:
from setuptools_scm.version import guess_next_version

Expand All @@ -25,8 +38,6 @@ def version_func(version: ScmVersion) -> str:
)

if BUILD_TYPE == "nightly":
# Nightly builds use alpha versions to ensure they are marked
# as pre-releases on pypi.org.
return version.format_next_version(
guess_next=guess_next_version,
fmt="{guessed}.a{node_date:%Y%m%d}",
Expand All @@ -37,11 +48,8 @@ def version_func(version: ScmVersion) -> str:
and not version.dirty
and (version.exact or version.node is None)
):
# When we have a tagged version, use that without modification.
return version.format_with("{tag}")

# In development mode or when the local repository is dirty, treat
# it is as local development version.
return version.format_next_version(
guess_next=guess_next_version,
fmt="{guessed}.dev{distance}",
Expand All @@ -51,164 +59,50 @@ def version_func(version: ScmVersion) -> str:
def localversion_func(version: ScmVersion) -> str:
from setuptools_scm.version import get_local_node_and_date

print(
f"computing local version for {BUILD_TYPE} build with "
f"{'dirty' if version.dirty else 'clean'} local repository"
"f{' and exact version from tag' if version.exact else ''}",
file=sys.stderr,
)

# When we are building nightly versions, we guess the next release
# and add the date as an alpha version. We cannot publish packages
# with local versions, so we do not add one.
if BUILD_TYPE == "nightly":
return ""

# When we have an exact tag, with no local changes, do not append
# anything to the local version field.
if (
BUILD_TYPE == "release"
and not version.dirty
and (version.exact or version.node is None)
):
return ""

# In development mode or when the local repository is dirty,
# return a string that includes the git SHA (node) and a date,
# formatted as a local version tag.
return get_local_node_and_date(version)


# ---- release dependency pins ------------------------------------------------
# For release builds we pin upper bounds. For dev / nightly the
# lower-bound-only specifiers from pyproject.toml are used as-is.

_RELEASE_OVERRIDES: dict[str, str] = {
"loguru": "loguru>=0.7.2,<=0.7.3",
"pyyaml": "pyyaml>=6.0.1,<=6.0.3",
"numpy": "numpy>=2.0.0,<=2.4.2",
"requests": "requests>=2.32.2,<=2.32.5",
"tqdm": "tqdm>=4.66.3,<=4.67.3",
"torch": "torch>=2.9.0,<=2.10.0",
"datasets": "datasets>=4.0.0,<=4.6.0",
"auto-round": "auto-round>=0.9.6,<=0.10.2",
"accelerate": "accelerate>=1.6.0,<=1.12.0",
"nvidia-ml-py": "nvidia-ml-py>=12.560.30,<=13.590.48",
"pillow": "pillow>=10.4.0,<=12.1.1",
"compressed-tensors": "compressed-tensors==0.14.0",
}


def _build_install_requires() -> list[str] | None:
"""Return overridden deps for release builds; None otherwise."""
if BUILD_TYPE != "release":
return None # fall back to pyproject.toml dependencies
return list(_RELEASE_OVERRIDES.values())
Comment on lines +77 to +97
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BUILD_TYPE=release currently sets install_requires to only _RELEASE_OVERRIDES.values(), which drops any dependencies not present in that dict (e.g., transformers is in pyproject.toml but not in _RELEASE_OVERRIDES). This will produce incomplete runtime requirements for release builds. Consider building install_requires from the full base dependency set and then applying upper-bound overrides (or ensure _RELEASE_OVERRIDES covers all core dependencies that must be installed in release mode).

Copilot uses AI. Check for mistakes.


# ---- setup() ----------------------------------------------------------------
setup(
name="llmcompressor",
use_scm_version={
"version_scheme": version_func,
"local_scheme": localversion_func,
"version_file": "src/llmcompressor/version.py",
},
author="Neuralmagic, Inc.",
author_email="support@neuralmagic.com",
description=(
"A library for compressing large language models utilizing the "
"latest techniques and research in the field for both "
"training aware and post training techniques. "
"The library is designed to be flexible and easy to use on top of "
"PyTorch and HuggingFace Transformers, allowing for quick experimentation."
),
long_description=open("README.md", "r", encoding="utf-8").read(),
long_description_content_type="text/markdown",
keywords=(
"llmcompressor, llms, large language models, transformers, pytorch, "
"huggingface, compressors, compression, quantization, pruning, "
"sparsity, optimization, model optimization, model compression, "
),
license="Apache",
url="https://github.com/vllm-project/llm-compressor",
include_package_data=True,
package_dir={"": "src"},
packages=find_packages(
"src", include=["llmcompressor", "llmcompressor.*"], exclude=["*.__pycache__.*"]
),
install_requires=[
("loguru>=0.7.2,<=0.7.3" if BUILD_TYPE == "release" else "loguru>=0.7.2"),
("pyyaml>=6.0.1,<=6.0.3" if BUILD_TYPE == "release" else "pyyaml>=6.0.1"),
# librosa 0.11.0 supports numpy 2.x
# https://librosa.org/doc/0.11.0/changelog.html
("numpy>=2.0.0,<=2.4.2" if BUILD_TYPE == "release" else "numpy>=2.0.0"),
(
"requests>=2.32.2,<=2.32.5"
if BUILD_TYPE == "release"
else "requests>=2.32.2"
),
("tqdm>=4.66.3,<=4.67.3" if BUILD_TYPE == "release" else "tqdm>=4.66.3"),
("torch>=2.9.0,<=2.10.0" if BUILD_TYPE == "release" else "torch>=2.9.0"),
(
"transformers>=4.56.1,<=4.57.6"
if BUILD_TYPE == "release"
else "transformers>=4.56.1,<=4.57.6"
),
("datasets>=4.0.0,<=4.6.0" if BUILD_TYPE == "release" else "datasets>=4.0.0"),
(
# auto-round 0.9.1 cannot work with accelerate <1.10.0
"auto-round>=0.9.6,<=0.10.2"
if BUILD_TYPE == "release"
else "auto-round>=0.9.6"
),
(
"accelerate>=1.6.0,<=1.12.0"
if BUILD_TYPE == "release"
else "accelerate>=1.6.0"
),
(
"nvidia-ml-py>=12.560.30,<=13.590.48"
if BUILD_TYPE == "release"
else "nvidia-ml-py>=12.560.30"
),
("pillow>=10.4.0,<=12.1.1" if BUILD_TYPE == "release" else "pillow>=10.4.0"),
(
"compressed-tensors==0.14.0"
if BUILD_TYPE == "release"
else "compressed-tensors>=0.14.1a2"
),
],
extras_require={
"dev": [
# testing framework
"pytest>=6.0.0",
"pytest-mock>=3.6.0",
"pytest-rerunfailures>=13.0",
"lm_eval==0.4.9.2",
# test dependencies
"beautifulsoup4~=4.12.3",
"cmarkgfm>=2024.1.14",
"trl>=0.10.1",
"pandas<2.3.0",
"torchvision",
"librosa==0.11.0",
"soundfile",
"torchcodec",
# linting, formatting, and type checking
"mypy~=1.10.0",
"ruff~=0.4.8",
# pre commit hooks
"pre-commit",
# docs
"mkdocs",
"mkdocs-material[imaging]",
"markdown",
"pymdown-extensions",
"mkdocs-section-index",
"mkdocs-minify-plugin",
"mkdocs-api-autonav",
"mkdocstrings-python",
"mkdocs-gen-files",
"mkdocs-awesome-nav",
],
"qwen": [
"qwen_vl_utils",
],
},
entry_points={
"console_scripts": [
"llmcompressor.trace=llmcompressor.transformers.tracing.debug:main",
"llmcompressor.reindex_fused_weights=llmcompressor.entrypoints.model_free.reindex_fused_weights:main",
]
},
python_requires=">=3.10",
classifiers=[
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: Information Technology",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: Apache Software License",
"Operating System :: POSIX :: Linux",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Scientific/Engineering :: Mathematics",
"Topic :: Software Development",
"Topic :: Software Development :: Libraries :: Python Modules",
],
install_requires=_build_install_requires(),
)
Loading