Cmake + workflows by wkpark · Pull Request #908 · bitsandbytes-foundation/bitsandbytes

wkpark · 2023-12-11T10:38:12Z

CmakeList.txt + github workflows action

CMake by @Jamezo97
github workflows actions - support ubuntu and windows (windows disabled for now)
cu11.8, cu12.1 + py310, py311 build matrix

Please see ~~https://github.com/wkpark/bitsandbytes/actions/runs/7166014267~~
~~https://github.com/wkpark/bitsandbytes/actions/runs/7167362163~~
https://github.com/wkpark/bitsandbytes/actions/runs/7648577944

TimDettmers · 2024-01-02T06:43:44Z

Thank you! We are planning to switch to make, and this is a great PR!

I do not have an overview of how this is different or could benefit from #220 and #229. Could you please have a look and discuss the differences and if we could benefit from some of the old code. Thank you!

rickardp · 2024-01-02T11:50:41Z

.github/workflows/cmake.yml

+
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.10', '3.11']


I would recommend building only the native library here using a build matrix, then a separate job to build the Python binary wheels.

CMakeLists.txt

rickardp · 2024-01-02T11:58:46Z

Is this PR complete? I remember there being some Windows-specific stuff needed, also some things for Linux/Arm64 that required specific handling. Unfortunately the original PRs (#220 etc) cannot be viewed because of force pushes. I'll see if I can dig up a relevant diff

wkpark · 2024-01-02T12:20:06Z

Is this PR complete? I remember there being some Windows-specific stuff needed, also some things for Linux/Arm64 that required specific handling. Unfortunately the original PRs (#220 etc) cannot be viewed because of force pushes. I'll see if I can dig up a relevant diff

Windows specific stuff extracted on PR #873 and #876
See also https://github.com/wkpark/bitsandbytes/actions (several times compiled, partial squashed rebased blah blah..)

(and pytest stuff is not fixed/tested much since I have no sm_75 capable GPU.)

rickardp · 2024-01-02T13:06:45Z

Is this PR complete? I remember there being some Windows-specific stuff needed, also some things for Linux/Arm64 that required specific handling. Unfortunately the original PRs (#220 etc) cannot be viewed because of force pushes. I'll see if I can dig up a relevant diff

Windows specific stuff extracted on PR #873 and #876 See also https://github.com/wkpark/bitsandbytes/actions (several times compiled, partial squashed rebased blah blah..)

(and pytest stuff is not fixed/tested much since I have no sm_75 capable GPU.)

I don't have a Windows machine at hand right now, but there are also specific compiler flags that MSVC needs. I think this is what PR #220 did.

I spend a few minutes to rebase and create a draft PR in #947 just for reference, which should compile on all platforms. Maybe it's worth just comparing notes on those?

@wkpark @TimDettmers
I extracted the relevant portability fixes in #949. I don't mind which one to proceed with, but I just want to preserve the work of the previous closed PRs as I believe not all of the patches are part of the currently open set of PRs.
Additionally, this implements my proposal to split the building of the native libs into a different job matrix than the Python distribution building.

niclimcy · 2024-01-03T00:41:37Z

I am not sure if current versions of bitsandbytes depend on pthread but attempt #220 imports pthread-win32 as pthread isn’t supported on windows either.

For context this is the original commit:
https://github.com/niclimcy/bitsandbytes/commit/4c1d3089cc8d1f1644f334b18402a45c1ff65a44

wkpark · 2024-01-24T09:52:32Z

rebased, conflict resolved

~~https://github.com/wkpark/bitsandbytes/actions/runs/7638675921~~
https://github.com/wkpark/bitsandbytes/actions/runs/7648577944

wkpark · 2024-01-29T19:01:54Z

rebased to test the current action workflows.
https://github.com/wkpark/bitsandbytes/actions/runs/7700400727/job/20984178019 (with minimal windows fix #876)
ubuntu, windows / cuda 11.8, 12.0 / python 3.10, 3.11 matrix (total 8 builds are available)

younesbelkada

Thanks a lot @wkpark
I am very much in favor of this PR as it currently
1- tests bnb compilation on windowns AND ubuntu on each commit on main + on each PR to make sure future PRs will not break bnb compilation
2- makes bnb compilation easier through Cmake
3- Once we merge this PR #876 should be closed
I will let @Titus-von-Koeller give a final decision on this - I assume the classic make xxx commands will still work - @wkpark once this gets merged, would you be happy to update the way we build bnb on our docker images to leverage CMake ? We do it exactly here: https://github.com/huggingface/peft/blob/189a9a666dc90f335b6a4db77f4b856b6a8bbdfd/docker/peft-gpu-bnb-source/Dockerfile#L60 and here: https://github.com/huggingface/peft/blob/189a9a666dc90f335b6a4db77f4b856b6a8bbdfd/docker/peft-gpu-bnb-latest/Dockerfile#L60

.github/workflows/cmake.yml

setup.py

wkpark · 2024-01-30T09:46:21Z

@TimDettmers says:
Thank you! We are planning to switch to make, and this is a great PR!

I do not have an overview of how this is different or could benefit from #220 and #229. Could you please have a look and discuss the differences and if we could benefit from some of the old code. Thank you!

PR #220 by @niclimcy and PR #229 by @acpopescu are almost identical with PR #788 @Jamezo97
(Some PRs have already been closed.)
so I've cleaned up some unrelated stuff, cherry picked/partial squashed and extracted into minimal subsets of several PRs.

pthread vs std::thread -> make pthread optional. : win32 fix PR
do not rename pythonInterface.cpp : add cmake option
AVX related : win32 fix PR
cmake -> extract PR
lib detection -> extract PR
documents and trivial fixes -> drop

See also:

wkpark · 2024-01-30T11:41:20Z

Partially squashed, updated.

wkpark · 2024-01-31T10:19:47Z

~~need to check cmake config for ubuntu. (*.so are not included)~~

need to add LIBRARY_OUTPUT_DIRECTORY property
set_target_properties(bitsandbytes PROPERTIES PREFIX "lib") for win32

fixed and partially squashed

.github/workflows/cmake.yml

github-actions · 2024-02-01T03:10:45Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

younesbelkada

Thanks @wkpark for your great work ! as #876 being merged could you re-enable windows build in the workflow + rebase with main?

.github/workflows/cmake.yml

younesbelkada · 2024-02-01T03:18:39Z

@wkpark could you also update the documentation and the main reamde with instructions on how to build bnb with windows?

younesbelkada · 2024-02-01T03:19:02Z

For the docs you can start filling some content here: https://github.com/TimDettmers/bitsandbytes/blob/main/docs/source/installation.mdx

…bytes-foundation#876

* fix project name and add lib prefix for win32 (2024/01/31) * set LIBRARY_OUTPUT_DIRECTORY property Co-authored-by: Won-Kyu Park <wkpark@gmail.com>

@akx

* build matrix for ubuntu + python 3.10, 3.11 + cuda 11.8 + 12.1 (windows is disabled for now) * add environment-bnb.yml for building * more fixes suggested by @akx (2024/01/30) * use python -m build --wheel suggested by @akx Co-authored-by: Aarni Koskela <akx@iki.fi>

@akx

* add a comment suggested by @akx (2024/01/30) Co-authored-by: Aarni Koskela <akx@iki.fi>

wkpark · 2024-02-01T05:03:53Z

rebased and

fixed mistake d97700a in PR minimal patch to fix Windows compilation issues #876
add windows build matrix

younesbelkada · 2024-02-01T05:45:37Z

@wkpark Thanks a lot ! let me know if you need any help for #908 (comment) - could you just share how to build bnb from source using a windows machine, i.e, the exact commands and I'll push on your branch

wkpark · 2024-02-01T06:10:48Z

For the docs you can start filling some content here: https://github.com/TimDettmers/bitsandbytes/blob/main/docs/source/installation.mdx

this is just a note for windows user who wanted to build from source.

git clone
cmake -B build -DBUILD_CUDA=ON -S .
cmake --build build --config Release
python -m build --wheel (build python wheel using build module.) then you can get dist/*.whl

younesbelkada · 2024-02-01T07:17:28Z

@wkpark check out https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_908/en/installation now there is a nice table that showcases how to install bnb:

docs/source/installation.mdx

younesbelkada · 2024-02-01T08:00:14Z

Thanks again for all your awesome contributions ! @rickardp @wkpark @akx @Jamezo97 !

Neumann-A · 2024-02-01T09:42:52Z

CMakeLists.txt

+    target_compile_definitions(bitsandbytes PUBLIC BUILD_CUDA)
+    target_link_libraries(bitsandbytes PUBLIC cudart cublas cusparse)
+    if(NO_CUBLASLT)
+        target_compile_definitions(bitsandbytes PUBLIC NO_CUBLASLT)
+    else()
+        target_link_libraries(bitsandbytes PUBLIC cublasLt)
+    endif()


Should have used targets from https://cmake.org/cmake/help/latest/module/FindCUDAToolkit.html . This now assumes that the libraries are on the library search path

All of this will be tweaked soon anyway, don't worry – see #949 for the follow-up.

wkpark force-pushed the cmake branch from 69eb1eb to 8d627c6 Compare December 11, 2023 12:45

wkpark mentioned this pull request Dec 11, 2023

Does bitsandbytes work for cuda 12.1 in linux (Centos)? #887

Closed

wkpark force-pushed the cmake branch from 8d627c6 to 260eb33 Compare December 11, 2023 13:24

wkpark mentioned this pull request Dec 17, 2023

[RFC] cross-platform: Refactoring bitsandbytes/cuda_setup #918

Closed

This was referenced Jan 1, 2024

CMake - Windows support #229

Closed

Initial CMake support #220

Closed

TimDettmers added High Priority (first issues that will be worked on) Medium Priority (will be worked on after all high priority issues) labels Jan 2, 2024

wkpark force-pushed the cmake branch from 260eb33 to e738120 Compare January 2, 2024 10:01

rickardp reviewed Jan 2, 2024

View reviewed changes

CMakeLists.txt Show resolved Hide resolved

wkpark force-pushed the cmake branch from e738120 to e53005a Compare January 24, 2024 09:51

wkpark force-pushed the cmake branch from 43cf711 to c77d8e7 Compare January 25, 2024 01:27

Titus-von-Koeller removed the High Priority (first issues that will be worked on) label Jan 25, 2024

Titus-von-Koeller self-assigned this Jan 25, 2024

wkpark force-pushed the cmake branch from c77d8e7 to 9d65351 Compare January 29, 2024 17:17

wkpark mentioned this pull request Jan 29, 2024

minimal patch to fix Windows compilation issues #876

Merged

younesbelkada mentioned this pull request Jan 29, 2024

Make native code portable and add GitHub workflow for building #949

Merged

younesbelkada approved these changes Jan 30, 2024

View reviewed changes

younesbelkada requested a review from Titus-von-Koeller January 30, 2024 00:55

akx reviewed Jan 30, 2024

View reviewed changes

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

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

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

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

setup.py Show resolved Hide resolved

wkpark force-pushed the cmake branch from 9d65351 to 565c3df Compare January 30, 2024 08:56

wkpark force-pushed the cmake branch from f713183 to 1f0f781 Compare January 30, 2024 11:39

akx mentioned this pull request Jan 30, 2024

Ruff fixes #984

Merged

wkpark force-pushed the cmake branch from 1f0f781 to 51e4b6f Compare January 31, 2024 11:52

matthewdouglas reviewed Jan 31, 2024

View reviewed changes

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

wkpark force-pushed the cmake branch from 51e4b6f to 5a0874e Compare February 1, 2024 03:07

younesbelkada approved these changes Feb 1, 2024

View reviewed changes

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

wkpark and others added 5 commits February 1, 2024 13:48

add missing definitions accidentally removed by mistake in PR bitsand…

d97700a

…bytes-foundation#876

Add CMakeLists.txt

5f76fe9

* fix project name and add lib prefix for win32 (2024/01/31) * set LIBRARY_OUTPUT_DIRECTORY property Co-authored-by: Won-Kyu Park <wkpark@gmail.com>

add ext_modules

c12c4c1

* add a comment suggested by @akx (2024/01/30) Co-authored-by: Aarni Koskela <akx@iki.fi>

add windows build matrix

9269139

wkpark force-pushed the cmake branch from 5a0874e to 9269139 Compare February 1, 2024 05:01

Update installation.mdx

5831205

younesbelkada reviewed Feb 1, 2024

View reviewed changes

docs/source/installation.mdx Outdated Show resolved Hide resolved

Update docs/source/installation.mdx

0f3d029

younesbelkada merged commit 3a630c5 into bitsandbytes-foundation:main Feb 1, 2024

Jamezo97 mentioned this pull request Feb 1, 2024

CMake and Windows Compilation #788

Closed

Neumann-A reviewed Feb 1, 2024

View reviewed changes

akx mentioned this pull request Feb 1, 2024

Optimize Cmake build slightly #1011

Merged

Uh oh!

Conversation

wkpark commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TimDettmers commented Jan 2, 2024

Uh oh!

rickardp Jan 2, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rickardp commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wkpark commented Jan 2, 2024

Uh oh!

rickardp commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niclimcy commented Jan 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wkpark commented Jan 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wkpark commented Jan 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

younesbelkada left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wkpark commented Jan 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wkpark commented Jan 30, 2024

Uh oh!

wkpark commented Jan 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 1, 2024

Uh oh!

younesbelkada left a comment • 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!

Uh oh!

younesbelkada commented Feb 1, 2024

Uh oh!

younesbelkada commented Feb 1, 2024

Uh oh!

wkpark commented Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

younesbelkada commented Feb 1, 2024

Uh oh!

wkpark commented Feb 1, 2024

Uh oh!

younesbelkada commented Feb 1, 2024

Uh oh!

Uh oh!

younesbelkada commented Feb 1, 2024

Uh oh!

Neumann-A Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

akx Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

wkpark commented Dec 11, 2023 •

edited

Loading

rickardp commented Jan 2, 2024 •

edited

Loading

rickardp commented Jan 2, 2024 •

edited

Loading

niclimcy commented Jan 3, 2024 •

edited

Loading

wkpark commented Jan 24, 2024 •

edited

Loading

wkpark commented Jan 29, 2024 •

edited

Loading

wkpark commented Jan 30, 2024 •

edited

Loading

wkpark commented Jan 31, 2024 •

edited

Loading

younesbelkada left a comment •

edited

Loading

wkpark commented Feb 1, 2024 •

edited

Loading