Fix building source distributions #6381

mgorny · 2025-04-03T09:32:43Z

This is an attempt to make it possible to build source distributions of Triton, with the goal that they should produce wheels identical to in-repo builds.

The changes involve:

moving setup.py to top-level directory and merging pyproject.tomls, so the package can now be built from top directory
deferring downloads to CMakeBuild command execution, ensuring they don't happen unnecessarily while building source distributions
adding missing files to source distributions
removing triton/_C/include symlink that didn't seem to do anything right now, but broke non-isolated builds if setuptools_scm were installed, and caused wheels built from source distributions to include the includes
while at it, handle wheel.bdist_wheel being deprecated, since upstream recently announced plans to remove it

TODO:

The generated source distributions contain duplicate files (notably, files copied from third_party). Fixing this isn't going to be easy, since we're passing the output directories to setup(packages=...). Not sure if we consider it a problem needing an immediate fix.
Update workflows to use new source distributions.
Do we want to include documentation and tests as well, or just the bare essentials needed to build wheels?

CC @ptillet @Jokeren @ThomasRaoux @atalman @tiran

New contributor declaration

I am not making a trivial change, such as fixing a typo in a comment.
I have written a PR description following these
rules.
I have run pre-commit run --from-ref origin/main --to-ref HEAD.
Select one of the following.
- I have added tests.
  - /test for lit tests
  - /unittest for C++ tests
  - /python/test for end-to-end tests
- This PR does not need a test because it only changes the build system.
Select one of the following.
- I have not added any lit tests.
- The lit tests I have added follow these best practices,
  including the "tests should be minimal" section. (Usually running Python code
  and using the instructions it generates is not minimal.)

atalman · 2025-04-03T14:12:45Z

HI @mgorny I think we should target something like this for next release 3.4 . As per our established criteria: https://github.com/triton-lang/triton/blob/main/RELEASE.md#release-cherry-pick-criteria we do not allow Feature work as cherry-pick for release 3.3. Also would be nice to add some unit tests to cover for these changes.

atalman · 2025-04-07T21:56:08Z

Hi @mgorny to your point: Do we want to include documentation and tests as well, or just the bare essentials needed to build wheels? I believe yes, we want to include documentation and tests changes

atalman · 2025-04-07T22:07:12Z

hi @mgorny we should also temporary enable upload artifact to github on PR so we can actually download both the wheels and sdist for testing.

mgorny · 2025-04-08T17:36:19Z

hi @mgorny we should also temporary enable upload artifact to github on PR so we can actually download both the wheels and sdist for testing.

I think I've done that. Could you double-check?

mgorny · 2025-04-09T17:12:10Z

Okay, now I'm really satisfied with it. Confirmed that TRITON_BUILD_PROTON is respected, wheels come out the same.

The difference between git archive and source distribution is:

@@ -1,35 +1,10 @@
 triton-3.3.0+git9fc4181c/
-triton-3.3.0+git9fc4181c/.clang-format
-triton-3.3.0+git9fc4181c/.editorconfig
-triton-3.3.0+git9fc4181c/.git-blame-ignore-revs
-triton-3.3.0+git9fc4181c/.github/
-triton-3.3.0+git9fc4181c/.github/CODEOWNERS
-triton-3.3.0+git9fc4181c/.github/ISSUE_TEMPLATE/
-triton-3.3.0+git9fc4181c/.github/ISSUE_TEMPLATE/bug.yml
-triton-3.3.0+git9fc4181c/.github/ISSUE_TEMPLATE/config.yml
-triton-3.3.0+git9fc4181c/.github/ISSUE_TEMPLATE/performance.yml
-triton-3.3.0+git9fc4181c/.github/PULL_REQUEST_TEMPLATE.md
-triton-3.3.0+git9fc4181c/.github/dependabot.yml
-triton-3.3.0+git9fc4181c/.github/workflows/
-triton-3.3.0+git9fc4181c/.github/workflows/create_release.yml
-triton-3.3.0+git9fc4181c/.github/workflows/documentation.yml
-triton-3.3.0+git9fc4181c/.github/workflows/integration-tests.yml
-triton-3.3.0+git9fc4181c/.github/workflows/integration-tests.yml.in
-triton-3.3.0+git9fc4181c/.github/workflows/llvm-build.yml
-triton-3.3.0+git9fc4181c/.github/workflows/llvm-build/
-triton-3.3.0+git9fc4181c/.github/workflows/llvm-build/almalinux.Dockerfile
-triton-3.3.0+git9fc4181c/.github/workflows/llvm-build/centos.Dockerfile
-triton-3.3.0+git9fc4181c/.github/workflows/test-backends.yml
-triton-3.3.0+git9fc4181c/.github/workflows/wheels.yml
-triton-3.3.0+git9fc4181c/.gitignore
-triton-3.3.0+git9fc4181c/.pre-commit-config.yaml
 triton-3.3.0+git9fc4181c/CMakeLists.txt
-triton-3.3.0+git9fc4181c/CONTRIBUTING.md
 triton-3.3.0+git9fc4181c/LICENSE
 triton-3.3.0+git9fc4181c/MANIFEST.in
 triton-3.3.0+git9fc4181c/Makefile
+triton-3.3.0+git9fc4181c/PKG-INFO
 triton-3.3.0+git9fc4181c/README.md
-triton-3.3.0+git9fc4181c/RELEASE.md
 triton-3.3.0+git9fc4181c/bin/
 triton-3.3.0+git9fc4181c/bin/CMakeLists.txt
 triton-3.3.0+git9fc4181c/bin/RegisterTritonDialects.h
@@ -464,18 +439,15 @@ triton-3.3.0+git9fc4181c/python/triton/t
 triton-3.3.0+git9fc4181c/python/triton/tools/experimental_descriptor.py
 triton-3.3.0+git9fc4181c/python/triton/tools/link.py
 triton-3.3.0+git9fc4181c/python/triton/tools/mxfp.py
-triton-3.3.0+git9fc4181c/python/tutorials/
-triton-3.3.0+git9fc4181c/python/tutorials/01-vector-add.py
-triton-3.3.0+git9fc4181c/python/tutorials/02-fused-softmax.py
-triton-3.3.0+git9fc4181c/python/tutorials/03-matrix-multiplication.py
-triton-3.3.0+git9fc4181c/python/tutorials/04-low-memory-dropout.py
-triton-3.3.0+git9fc4181c/python/tutorials/05-layer-norm.py
-triton-3.3.0+git9fc4181c/python/tutorials/06-fused-attention.py
-triton-3.3.0+git9fc4181c/python/tutorials/07-extern-functions.py
-triton-3.3.0+git9fc4181c/python/tutorials/08-grouped-gemm.py
-triton-3.3.0+git9fc4181c/python/tutorials/09-persistent-matmul.py
-triton-3.3.0+git9fc4181c/python/tutorials/10-block-scaled-matmul.py
-triton-3.3.0+git9fc4181c/python/tutorials/README.rst
+triton-3.3.0+git9fc4181c/python/triton.egg-info/
+triton-3.3.0+git9fc4181c/python/triton.egg-info/PKG-INFO
+triton-3.3.0+git9fc4181c/python/triton.egg-info/SOURCES.txt
+triton-3.3.0+git9fc4181c/python/triton.egg-info/dependency_links.txt
+triton-3.3.0+git9fc4181c/python/triton.egg-info/entry_points.txt
+triton-3.3.0+git9fc4181c/python/triton.egg-info/not-zip-safe
+triton-3.3.0+git9fc4181c/python/triton.egg-info/requires.txt
+triton-3.3.0+git9fc4181c/python/triton.egg-info/top_level.txt
+triton-3.3.0+git9fc4181c/setup.cfg
 triton-3.3.0+git9fc4181c/setup.py
 triton-3.3.0+git9fc4181c/test/
 triton-3.3.0+git9fc4181c/test/Analysis/
@@ -1166,6 +1138,3 @@ triton-3.3.0+git9fc4181c/unittest/Tools/
 triton-3.3.0+git9fc4181c/unittest/Tools/LayoutUtilsTest.cpp
 triton-3.3.0+git9fc4181c/unittest/Tools/LinearLayoutTest.cpp
 triton-3.3.0+git9fc4181c/unittest/googletest.cmake
-triton-3.3.0+git9fc4181c/utils/
-triton-3.3.0+git9fc4181c/utils/generate-test-checks.py
-triton-3.3.0+git9fc4181c/utils/nightly.pypirc

Please let me know if I should include more files.

.github/workflows/create_release.yml

pyproject.toml

atalman · 2025-04-10T14:16:26Z

.github/workflows/wheels.yml

          export CIBW_FREE_THREADED_SUPPORT=1
-          python3 -m cibuildwheel python --output-dir wheelhouse
+          python3 -m cibuildwheel . --output-dir wheelhouse



HI @mgorny
Please add this action before trying to use Azure (since its failing):

- uses: actions/upload-artifact@v4 with: name: cibw-wheels-manylinux_2_28_${{ matrix.config.arch }}-wheels-upload path: ./wheelhouse/*.whl

It will allow us to get the wheels from the workflow on this PR.

atalman

Thank you, the changes looks good

atalman · 2025-04-18T17:38:36Z

Hi @mgorny looks like there are some failures on the integration tests here:
https://github.com/triton-lang/triton/actions/runs/14464928080/job/40786949058?pr=6381

/usr/lib/python3.10/importlib/util.py:94: in find_spec
    parent = __import__(parent_name, fromlist=['__path__'])
E   ModuleNotFoundError: No module named 'triton.backends.amd'
!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
=============================== 1 error in 1.33s ===============================

And on H100:
https://github.com/triton-lang/triton/actions/runs/14464928080/job/40786949025?pr=6381

FAILED cuda/test_tma_descriptor.py::test_2d_tma_descriptor_exception[127-32-True-128-32] - AttributeError: module 'triton' has no attribute 'runtime'

If you take a look at these test on main its passing: https://github.com/triton-lang/triton/actions/runs/14529664771/job/40789464219

atalman · 2025-04-18T17:40:31Z

Also looks like there is a merge conflict please rebase

mgorny · 2025-04-19T14:06:48Z

Okay, let's rebase first and see if that changes anything.

Move the Python build system files to the top directory, to enable building triton via regular Python packaging tools. This will also make it possible to build source distributions that include all the files needed to build the package.

Do not download the dependencies before the CMake build command is executed. Most importantly, this avoids them being prematurely downloaded while only a source distribution is being built.

Add files necessary for the package build to source distribution. Currently, this implies some duplication, as we end up including both original `third_party` tree and the files copied from it.

Remove the `triton/_C/include` symlink that does not seem to serve any purpose right now, and causes trouble in some scenarios. Notably, `triton/_C/include` is neither included in the wheels as I build them from the git repository, or in the wheels that are published on PyPI right now. However, if `setuptools_scm` package is installed, it causes setuptools to attempt to include the symlink as a data files, which triggers an error (only regular files are allowed). Furthermore, including it in source distribution caused the symlink to be replaced by the actual files, which meant they were now included in the wheels. In place of that, add a trivial `mkdir()` that ensures that `triton._C` package directory is being present for the `setup()` call.

See: https://discuss.python.org/t/upcoming-changes-in-the-pypa-wheel-project/85967

This one apparently is not really used either, and for some reason it causes the release workflow to put headers in `third_party/proton/proton/_C/include` rather than in `third_party/proton/csrc/include`.

Use entry points to locate Triton backends instead of iterating over the `triton.backends` package directory. This fixes support for nontrivial install layouts, particularly editable installs made using `package_dir`. Now `setup.py` keeps record of all installed backends in entry points, and `triton.backends` uses them to locate and load the backends. This also technically permits installing third-party backends without altering the Triton installation, by adding additional entry points.

Use a hybrid approach where clean `package_dir` is used for regular wheel installs, but symlinks are still used by the `develop` command and editable installs. Hopefully, this will give us the best of both worlds: clean source distributions, and reliable editable installs, given that the package loading logic used by setuptools currently is not 100% reliable and fails on CI.

atalman · 2025-04-22T13:23:38Z

setup.py

-    packages=get_packages(),
+    install_requires=[
+        "setuptools>=40.8.0",
+        "importlib-metadata; python_version < '3.10'",


What is the reason to introduce new importlib-metadata dependency ?

importlib.metadata is used by the new backend finder. Unfortunately, the API changed in Python 3.10, and the usual way of dealing with that is to pull importlib-metadata backport for older Pythons.

atalman · 2025-04-22T13:35:50Z

Question about the third_party dependency changes:

amd/backend why do we need to add blank __init__.py ?
Why are we removing third_party/proton/proton/_C/include ?

mgorny · 2025-04-22T13:48:51Z

1. amd/backend why do we need to add blank `__init__.py` ?

Originally, this was needed to make the editable builds work. It's not technically necessary now that I've restore symlinks, but I figured out I'd leave it for consistency with the nvidia backend.

2. Why are we removing `third_party/proton/proton/_C/include` ?

This symlink is not used anywhere, and it is messing up source distributions (because of pypa/setuptools#4937).

mgorny · 2025-04-22T13:49:37Z

This symlink is not used anywhere

(and wasn't installed anyway)

python/triton/backends/__init__.py

This reverts commit a782a36.

This PR adds basic mypy type checking to the codebase. Previously, type checking worked out of the box (e.g., via pylsp-mypy in Neovim with an editable install), but after [#6381](#6381), mypy started reporting: Cannot find implementation or library stub for module named 'triton'. This is likely due to a known issue with type checkers and editable installs. As a workaround, this PR introduces a mypy.ini with a [`mypy_path`](https://mypy.readthedocs.io/en/stable/config_file.html#confval-mypy_path) to restore correct module resolution. This is a small step toward making the Python codebase fully type-checkable.

triton-lang#6381 updated some building and doc but didn't fix the command to find the proper `compile_commands.json`. `python/build` would contain the old one if user has previously built the project in `./python`, which would not work now.

#6381 updated some building and doc but didn't fix the command to find the proper `compile_commands.json`. `python/build` would contain the old one if user has previously built the project in `./python`, which would not work now, since we now build the project at dir `.`  # New contributor declaration - [ ] I am not making a trivial change, such as fixing a typo in a comment. - [x] I have written a PR description following these [rules](https://cbea.ms/git-commit/#why-not-how). - [ ] I have run `pre-commit run --from-ref origin/main --to-ref HEAD`. - Select one of the following. - [ ] I have added tests. - `/test` for `lit` tests - `/unittest` for C++ tests - `/python/test` for end-to-end tests - [x] This PR does not need a test because it's a trivial doc fix. - Select one of the following. - [x] I have not added any `lit` tests. - [ ] The `lit` tests I have added follow these [best practices](https://mlir.llvm.org/getting_started/TestingGuide/#filecheck-best-practices), including the "tests should be minimal" section. (Usually running Python code and using the instructions it generates is not minimal.)

@ptillet

This is an attempt to make it possible to build source distributions of Triton, with the goal that they should produce wheels identical to in-repo builds. The changes involve: - moving `setup.py` to top-level directory and merging `pyproject.toml`s, so the package can now be built from top directory - deferring downloads to `CMakeBuild` command execution, ensuring they don't happen unnecessarily while building source distributions - adding missing files to source distributions - removing `triton/_C/include` symlink that didn't seem to do anything right now, but broke non-isolated builds if `setuptools_scm` were installed, and caused wheels built from source distributions to include the includes - while at it, handle `wheel.bdist_wheel` being deprecated, since upstream recently announced plans to remove it TODO: - [x] The generated source distributions contain duplicate files (notably, files copied from `third_party`). Fixing this isn't going to be easy, since we're passing the output directories to `setup(packages=...)`. Not sure if we consider it a problem needing an immediate fix. - [ ] Update workflows to use new source distributions. - [x] Do we want to include documentation and tests as well, or just the bare essentials needed to build wheels? CC @ptillet @Jokeren @ThomasRaoux @atalman @tiran # New contributor declaration - [x] I am not making a trivial change, such as fixing a typo in a comment. - [x] I have written a PR description following these [rules](https://cbea.ms/git-commit/#why-not-how). - [x] I have run `pre-commit run --from-ref origin/main --to-ref HEAD`. - Select one of the following. - [ ] I have added tests. - `/test` for `lit` tests - `/unittest` for C++ tests - `/python/test` for end-to-end tests - [x] This PR does not need a test because it only changes the build system. - Select one of the following. - [x] I have not added any `lit` tests. - [ ] The `lit` tests I have added follow these [best practices](https://mlir.llvm.org/getting_started/TestingGuide/#filecheck-best-practices), including the "tests should be minimal" section. (Usually running Python code and using the instructions it generates is not minimal.) --------- Co-authored-by: Andrey Talman <[email protected]>

This PR adds basic mypy type checking to the codebase. Previously, type checking worked out of the box (e.g., via pylsp-mypy in Neovim with an editable install), but after [triton-lang#6381](triton-lang#6381), mypy started reporting: Cannot find implementation or library stub for module named 'triton'. This is likely due to a known issue with type checkers and editable installs. As a workaround, this PR introduces a mypy.ini with a [`mypy_path`](https://mypy.readthedocs.io/en/stable/config_file.html#confval-mypy_path) to restore correct module resolution. This is a small step toward making the Python codebase fully type-checkable.

mgorny force-pushed the python-sdist branch from d0676dc to 0bb4cb1 Compare April 3, 2025 13:38

mgorny marked this pull request as ready for review April 9, 2025 17:06

mgorny requested a review from ptillet as a code owner April 9, 2025 17:06

atalman reviewed Apr 9, 2025

View reviewed changes

.github/workflows/create_release.yml Outdated Show resolved Hide resolved

atalman reviewed Apr 9, 2025

View reviewed changes

pyproject.toml Show resolved Hide resolved

atalman reviewed Apr 10, 2025

View reviewed changes

atalman approved these changes Apr 10, 2025

View reviewed changes

mgorny mentioned this pull request Apr 11, 2025

[BUG] PEP 420 namespace packages via package_dir don't work with editable installs pypa/setuptools#4943

Open

mgorny requested review from antiagainst and zhanglx13 as code owners April 11, 2025 16:45

mgorny requested a review from atalman April 15, 2025 08:32

mgorny added 11 commits April 19, 2025 16:07

Move Python build system to root directory

9e31f6b

Move the Python build system files to the top directory, to enable building triton via regular Python packaging tools. This will also make it possible to build source distributions that include all the files needed to build the package.

Delay downloading dependencies until CMake build command

af98b69

Do not download the dependencies before the CMake build command is executed. Most importantly, this avoids them being prematurely downloaded while only a source distribution is being built.

Add missing files to source distribution

8efcbf1

Add files necessary for the package build to source distribution. Currently, this implies some duplication, as we end up including both original `third_party` tree and the files copied from it.

Future-proof against wheel removing bdist_wheel command

93146d2

See: https://discuss.python.org/t/upcoming-changes-in-the-pypa-wheel-project/85967

Update path in wheels workflow

349e890

Remove third_party/proton/proton/_C/include symlink too

4f24e68

This one apparently is not really used either, and for some reason it causes the release workflow to put headers in `third_party/proton/proton/_C/include` rather than in `third_party/proton/csrc/include`.

Update release workflow to build proper sdist

1322da6

Force fixed version into sdist

0ca799d

Update install instructions and Makefile for changed paths

1943ccf

Include docs in sdist as well

ee7b993

mgorny force-pushed the python-sdist branch from c99418b to 4d0a951 Compare April 19, 2025 14:30

mgorny added 2 commits April 21, 2025 19:58

mgorny force-pushed the python-sdist branch from 4d0a951 to b249ecc Compare April 21, 2025 17:59

mgorny added 2 commits April 21, 2025 20:10

Use modern setuptools backend

cd61e2d

Add a fallback for ancient setuptools

93b876f

atalman reviewed Apr 22, 2025

View reviewed changes

atalman approved these changes Apr 22, 2025

View reviewed changes

atalman requested review from Jokeren and ThomasRaoux April 22, 2025 14:00

Jokeren reviewed Apr 23, 2025

View reviewed changes

python/triton/backends/__init__.py Show resolved Hide resolved

Jokeren approved these changes Apr 23, 2025

View reviewed changes

Merge branch 'main' into python-sdist

74a93c5

atalman enabled auto-merge (squash) April 23, 2025 19:23

atalman merged commit a782a36 into triton-lang:main Apr 23, 2025
9 of 11 checks passed

mgorny deleted the python-sdist branch April 24, 2025 01:54

danzimm mentioned this pull request Apr 24, 2025

[python][typing] Specify mypy_path in pyproject.toml #6596

Merged

MikeHolman mentioned this pull request Apr 25, 2025

Adding third party TRITON_PLUGIN_DIRS is broken #6612

Closed

csullivan added a commit to csullivan/triton that referenced this pull request Apr 25, 2025

Revert "Fix building source distributions (triton-lang#6381)"

d06b202

This reverts commit a782a36.

pchen7e2 mentioned this pull request Apr 29, 2025

Update README.md for vscode intellisense #6648

Merged

7 tasks

atalman mentioned this pull request May 8, 2025

Bump triton pin and update setup.py path pytorch/pytorch#153165

Closed

tiran mentioned this pull request Aug 25, 2025

Build fails due to missing package metadata in python/pyproject.toml #7911

Closed

Fix building source distributions #6381

Fix building source distributions #6381

Uh oh!

Conversation

mgorny commented Apr 3, 2025 • edited by atalman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New contributor declaration

Uh oh!

atalman commented Apr 3, 2025

Uh oh!

atalman commented Apr 7, 2025

Uh oh!

atalman commented Apr 7, 2025

Uh oh!

mgorny commented Apr 8, 2025

Uh oh!

mgorny commented Apr 9, 2025

Uh oh!

Uh oh!

Uh oh!

atalman Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mgorny Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

atalman left a comment

Choose a reason for hiding this comment

Uh oh!

atalman commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

atalman commented Apr 18, 2025

Uh oh!

mgorny commented Apr 19, 2025

Uh oh!

atalman Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

mgorny Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

atalman commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mgorny commented Apr 22, 2025

Uh oh!

mgorny commented Apr 22, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mgorny commented Apr 3, 2025 •

edited by atalman

Loading

atalman Apr 10, 2025 •

edited

Loading

atalman commented Apr 18, 2025 •

edited

Loading

atalman commented Apr 22, 2025 •

edited

Loading