# cumm
CUda Matrix Multiply library.
[](https://github.com/FindDefinition/cumm/actions?query=workflow%3Abuild)
```cumm``` is developed during learning of [CUTLASS](https://github.com/NVIDIA/cutlass), which use too much c++ template and make code unmaintainable. So I develop [pccm](https://github.com/FindDefinition/PCCM), use python as meta programming language, to replace c++ template meta programming.
Now ```pccm``` become a foundational framework of ```cumm``` and my other c++ project such as [spconv](https://github.com/traveller59/spconv).
```cumm``` also contains a python asyncio-based gemm simulator that **share same meta program** with CUDA code, enable gemm visualization and easy debug experience.
## BREAKING CHANGES
* 0.3.1: tv::DType enum value changed, this will affect all binary code of tv::Tensor user. you must recompile all code if upgrade to cumm >= 0.3.1.
## News
* Ampere feature support (by [EvernightAurora](https://github.com/EvernightAurora))
## Install
### Prebuilt
We offer python 3.7-3.11 and cuda 10.2/11.3/11.4/11.7/12.0 prebuilt binaries for linux (manylinux).
We offer python 3.7-3.11 and cuda 10.2/11.3/11.4/11.7/12.0 prebuilt binaries for windows 10/11.
```pip install cumm``` for CPU-only
```pip install cumm-cu102``` for CUDA 10.2
```pip install cumm-cu113``` for CUDA 11.3
```pip install cumm-cu114``` for CUDA 11.4
```pip install cumm-cu117``` for CUDA 11.7
```pip install cumm-cu120``` for CUDA 12.0
### Build from source for development (JIT, recommend for develop)
**WARNING** Use code in [tags](https://github.com/FindDefinition/cumm/releases)!!! code in main branch may contain bugs.
The c++ code will be built automatically when you change c++ code in project.
#### Linux
0. uninstall cumm installed by pip. you must ensure no "cumm" exists in ```pip list | grep cumm```
1. install build-essential, install CUDA
2. ```git clone https://github.com/FindDefinition/cumm```, ```cd ./cumm```, ```git checkout tags/<tag_name>```, ```pip install -e .```
3. in python, ```import cumm``` and wait for build finish.
#### Windows
0. uninstall spconv and cumm installed by pip. you must ensure no "cumm" exists in ```pip list | grep cumm```
1. install visual studio 2019 or newer. make sure C++ development component is installed. install CUDA
2. set [powershell script execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1)
3. start a new powershell, run ```tools/msvc_setup.ps1```
4. ```git clone https://github.com/FindDefinition/cumm```, ```cd ./cumm```, ```git checkout tags/<tag_name>```, ```pip install -e .```
5. in python, ```import cumm``` and wait for build finish.
### Build wheel from source
**WARNING** Use code in [tags](https://github.com/FindDefinition/cumm/releases)!!! code in main branch may contain bugs.
**WARNING**: If ```CUMM_CUDA_VERSION``` is set with a CUDA version, following steps will create a wheel named "cumm-cuxxx", not "cumm", this means you must use ```cumm-cuxxx``` in dependency of your project which depend on cumm, not ```cumm```. If ```CUMM_CUDA_VERSION``` isn't set, ```cumm``` will always built with CUDA, so the CUDA must exists in your system. The wheel name will be ```cumm``` even if it is built with cuda.
#### Linux
It's recommend to build Linux packages in [official build docker](https://github.com/FindDefinition/cumm/blob/main/.github/workflows/build.yaml). Build with CUDA support don't need a real GPU.
##### Build in Official Docker
1. select a cuda version. available: CUDA 11.1, 11.3, 11.4, 11.5, 12.0
2. (Example for CUDA 11.4) ```git clone https://github.com/FindDefinition/cumm```, ```cd ./cumm```, ```docker run --rm -e PLAT=manylinux2014_x86_64 -e CUMM_CUDA_VERSION=114 -v `pwd`:/io scrin/manylinux2014-cuda:cu114-devel-1.0.0 bash -c "source /etc/bashrc && /io/tools/build-wheels.sh"```
##### Build in your environment
1. install build-essential, install CUDA
2. set env for installed cuda version. for example, ```export CUMM_CUDA_VERSION="11.4"```. If you want to build CPU-only, run ```export CUMM_CUDA_VERSION=""```. If ```CUMM_CUDA_VERSION``` isn't set, you need to ensure cuda libraries are inside OS search path, and the built wheel name will be ```cumm```, otherwise ```cumm-cuxxx```
3. run ```export CUMM_DISABLE_JIT="1"```
4. run ```python setup.py bdist_wheel```+```pip install dists/xxx.whl```
#### Windows 10/11
1. install visual studio 2019 or newer. make sure C++ development package is installed. install CUDA
2. set [powershell script execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1)
3. start a new powershell, run ```tools/msvc_setup.ps1```
4. set env for installed cuda version. for example, ```$Env:CUMM_CUDA_VERSION = "11.4"```. If you want to build CPU-only, run ```$Env:CUMM_CUDA_VERSION = ""```. . If ```CUMM_CUDA_VERSION``` isn't set, you need to ensure cuda libraries are inside OS search path, and the built wheel name will be ```cumm```, otherwise ```cumm-cuxxx```
4. run ```$Env:CUMM_DISABLE_JIT = "1"```
5. run ```python setup.py bdist_wheel```+```pip install dists/xxx.whl```
## Contributers
* [EvernightAurora](https://github.com/EvernightAurora): add ampere feature.
## Note
The work is done when the author is an employee at [Tusimple](https://www.tusimple.com/).
## LICENSE
Apache 2.0
Raw data
{
"_id": null,
"home_page": "https://github.com/FindDefinition/cumm",
"name": "cumm-cu117",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Yan Yan",
"author_email": "yanyan.sub@outlook.com",
"download_url": "",
"platform": null,
"description": "\r\n# cumm\r\nCUda Matrix Multiply library.\r\n\r\n[](https://github.com/FindDefinition/cumm/actions?query=workflow%3Abuild)\r\n\r\n```cumm``` is developed during learning of [CUTLASS](https://github.com/NVIDIA/cutlass), which use too much c++ template and make code unmaintainable. So I develop [pccm](https://github.com/FindDefinition/PCCM), use python as meta programming language, to replace c++ template meta programming. \r\nNow ```pccm``` become a foundational framework of ```cumm``` and my other c++ project such as [spconv](https://github.com/traveller59/spconv). \r\n```cumm``` also contains a python asyncio-based gemm simulator that **share same meta program** with CUDA code, enable gemm visualization and easy debug experience.\r\n\r\n## BREAKING CHANGES\r\n\r\n* 0.3.1: tv::DType enum value changed, this will affect all binary code of tv::Tensor user. you must recompile all code if upgrade to cumm >= 0.3.1.\r\n\r\n## News\r\n\r\n* Ampere feature support (by [EvernightAurora](https://github.com/EvernightAurora))\r\n\r\n## Install\r\n\r\n### Prebuilt\r\n\r\nWe offer python 3.7-3.11 and cuda 10.2/11.3/11.4/11.7/12.0 prebuilt binaries for linux (manylinux).\r\n\r\nWe offer python 3.7-3.11 and cuda 10.2/11.3/11.4/11.7/12.0 prebuilt binaries for windows 10/11.\r\n\r\n```pip install cumm``` for CPU-only\r\n\r\n```pip install cumm-cu102``` for CUDA 10.2\r\n\r\n```pip install cumm-cu113``` for CUDA 11.3\r\n\r\n```pip install cumm-cu114``` for CUDA 11.4\r\n\r\n```pip install cumm-cu117``` for CUDA 11.7\r\n\r\n```pip install cumm-cu120``` for CUDA 12.0\r\n\r\n### Build from source for development (JIT, recommend for develop)\r\n\r\n**WARNING** Use code in [tags](https://github.com/FindDefinition/cumm/releases)!!! code in main branch may contain bugs.\r\n\r\nThe c++ code will be built automatically when you change c++ code in project.\r\n\r\n#### Linux\r\n\r\n0. uninstall cumm installed by pip. you must ensure no \"cumm\" exists in ```pip list | grep cumm```\r\n1. install build-essential, install CUDA\r\n2. ```git clone https://github.com/FindDefinition/cumm```, ```cd ./cumm```, ```git checkout tags/<tag_name>```, ```pip install -e .```\r\n3. in python, ```import cumm``` and wait for build finish.\r\n\r\n#### Windows\r\n0. uninstall spconv and cumm installed by pip. you must ensure no \"cumm\" exists in ```pip list | grep cumm```\r\n1. install visual studio 2019 or newer. make sure C++ development component is installed. install CUDA\r\n2. set [powershell script execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1)\r\n3. start a new powershell, run ```tools/msvc_setup.ps1```\r\n4. ```git clone https://github.com/FindDefinition/cumm```, ```cd ./cumm```, ```git checkout tags/<tag_name>```, ```pip install -e .```\r\n5. in python, ```import cumm``` and wait for build finish.\r\n\r\n### Build wheel from source \r\n\r\n**WARNING** Use code in [tags](https://github.com/FindDefinition/cumm/releases)!!! code in main branch may contain bugs.\r\n\r\n**WARNING**: If ```CUMM_CUDA_VERSION``` is set with a CUDA version, following steps will create a wheel named \"cumm-cuxxx\", not \"cumm\", this means you must use ```cumm-cuxxx``` in dependency of your project which depend on cumm, not ```cumm```. If ```CUMM_CUDA_VERSION``` isn't set, ```cumm``` will always built with CUDA, so the CUDA must exists in your system. The wheel name will be ```cumm``` even if it is built with cuda.\r\n\r\n#### Linux\r\n\r\nIt's recommend to build Linux packages in [official build docker](https://github.com/FindDefinition/cumm/blob/main/.github/workflows/build.yaml). Build with CUDA support don't need a real GPU.\r\n\r\n##### Build in Official Docker\r\n\r\n1. select a cuda version. available: CUDA 11.1, 11.3, 11.4, 11.5, 12.0\r\n2. (Example for CUDA 11.4) ```git clone https://github.com/FindDefinition/cumm```, ```cd ./cumm```, ```docker run --rm -e PLAT=manylinux2014_x86_64 -e CUMM_CUDA_VERSION=114 -v `pwd`:/io scrin/manylinux2014-cuda:cu114-devel-1.0.0 bash -c \"source /etc/bashrc && /io/tools/build-wheels.sh\"```\r\n\r\n##### Build in your environment\r\n\r\n1. install build-essential, install CUDA\r\n2. set env for installed cuda version. for example, ```export CUMM_CUDA_VERSION=\"11.4\"```. If you want to build CPU-only, run ```export CUMM_CUDA_VERSION=\"\"```. If ```CUMM_CUDA_VERSION``` isn't set, you need to ensure cuda libraries are inside OS search path, and the built wheel name will be ```cumm```, otherwise ```cumm-cuxxx```\r\n3. run ```export CUMM_DISABLE_JIT=\"1\"```\r\n4. run ```python setup.py bdist_wheel```+```pip install dists/xxx.whl```\r\n\r\n#### Windows 10/11\r\n\r\n1. install visual studio 2019 or newer. make sure C++ development package is installed. install CUDA\r\n2. set [powershell script execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1)\r\n3. start a new powershell, run ```tools/msvc_setup.ps1```\r\n4. set env for installed cuda version. for example, ```$Env:CUMM_CUDA_VERSION = \"11.4\"```. If you want to build CPU-only, run ```$Env:CUMM_CUDA_VERSION = \"\"```. . If ```CUMM_CUDA_VERSION``` isn't set, you need to ensure cuda libraries are inside OS search path, and the built wheel name will be ```cumm```, otherwise ```cumm-cuxxx```\r\n4. run ```$Env:CUMM_DISABLE_JIT = \"1\"```\r\n5. run ```python setup.py bdist_wheel```+```pip install dists/xxx.whl```\r\n\r\n## Contributers\r\n\r\n* [EvernightAurora](https://github.com/EvernightAurora): add ampere feature.\r\n\r\n## Note\r\nThe work is done when the author is an employee at [Tusimple](https://www.tusimple.com/).\r\n\r\n## LICENSE\r\n\r\nApache 2.0\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CUda Matrix Multiply library",
"version": "0.5.1",
"project_urls": {
"Homepage": "https://github.com/FindDefinition/cumm"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfab76894578de11432df2e7733c05997173d782a2f5d00e3f3a7e2b7306a90f",
"md5": "19a2dc0f49813983cb0ebda792b7851b",
"sha256": "acbc2b7facf964aa712d5a407eea5885dfeb493547fa8be12fcf3b980ba3ca32"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "19a2dc0f49813983cb0ebda792b7851b",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.6",
"size": 23245484,
"upload_time": "2023-12-26T04:25:50",
"upload_time_iso_8601": "2023-12-26T04:25:50.761062Z",
"url": "https://files.pythonhosted.org/packages/bf/ab/76894578de11432df2e7733c05997173d782a2f5d00e3f3a7e2b7306a90f/cumm_cu117-0.5.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "554d46423b102f269b6976e0853faa8bc45d050edd2393880fd82ec2e323308c",
"md5": "37124434fa71f8f0a17bf1af2dca571a",
"sha256": "ea16efdc2efa94b5571a940cf81e28aa6e1e1d4ab2131d333dbb5efdc81a89f2"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "37124434fa71f8f0a17bf1af2dca571a",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.6",
"size": 1160810,
"upload_time": "2023-12-26T04:10:26",
"upload_time_iso_8601": "2023-12-26T04:10:26.021041Z",
"url": "https://files.pythonhosted.org/packages/55/4d/46423b102f269b6976e0853faa8bc45d050edd2393880fd82ec2e323308c/cumm_cu117-0.5.1-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e04265df544bc017922680d0f36a8fac2251ca000c15a33b645be0e8e96571d9",
"md5": "593f94bf81fd98e9400dbc6ebdacc000",
"sha256": "cd87a7229f352df69dba4a9e893dccf5da43f2054ce80ea5abe9262043e1be4a"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "593f94bf81fd98e9400dbc6ebdacc000",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.6",
"size": 23248155,
"upload_time": "2023-12-26T04:25:55",
"upload_time_iso_8601": "2023-12-26T04:25:55.261032Z",
"url": "https://files.pythonhosted.org/packages/e0/42/65df544bc017922680d0f36a8fac2251ca000c15a33b645be0e8e96571d9/cumm_cu117-0.5.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15b6258d201175ff0e66927541f87b144cd8519e17c66ae168af1fbd4cfee7e1",
"md5": "02e8550e4f9efa63bcda6ddef748d3e8",
"sha256": "f342b0190baa5bb5db9d022515f948a1ff0c08cc8c5b831fcac5ddbfae2130eb"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "02e8550e4f9efa63bcda6ddef748d3e8",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.6",
"size": 1162213,
"upload_time": "2023-12-26T04:12:15",
"upload_time_iso_8601": "2023-12-26T04:12:15.951918Z",
"url": "https://files.pythonhosted.org/packages/15/b6/258d201175ff0e66927541f87b144cd8519e17c66ae168af1fbd4cfee7e1/cumm_cu117-0.5.1-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ecb7de5c6f5e8a6a1ba4c20951d33656df0cb28a8032cfc6d3ace83e85523d6",
"md5": "7a285e97e37e15d8ab03f509786b4f16",
"sha256": "b8efe5147d8d9f4e9ecd92a3b9213f93de35221d181d9f585ac08b08b1bdebc4"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "7a285e97e37e15d8ab03f509786b4f16",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.6",
"size": 1160883,
"upload_time": "2023-12-26T04:10:35",
"upload_time_iso_8601": "2023-12-26T04:10:35.643229Z",
"url": "https://files.pythonhosted.org/packages/3e/cb/7de5c6f5e8a6a1ba4c20951d33656df0cb28a8032cfc6d3ace83e85523d6/cumm_cu117-0.5.1-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3ffb770648c1227fb5d1f38656b6f8e0f96b9980182aa98cbe148b0d74f407d",
"md5": "30a80d526ef60fa1c8807a19cdee8b7b",
"sha256": "d863c155f37f0ba7f89d9eb7e4cb4123ac487d9291f70b94347caf68d246918e"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "30a80d526ef60fa1c8807a19cdee8b7b",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.6",
"size": 23236876,
"upload_time": "2023-12-26T04:26:01",
"upload_time_iso_8601": "2023-12-26T04:26:01.315153Z",
"url": "https://files.pythonhosted.org/packages/b3/ff/b770648c1227fb5d1f38656b6f8e0f96b9980182aa98cbe148b0d74f407d/cumm_cu117-0.5.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a2b5e1db85ee114f8ba8750e5b8b8582a165b33aab45f56a5cbacfbc3e1ecb46",
"md5": "06ee89c7191f9aeac16412b81a215643",
"sha256": "fc7bf41ea1232a703dc500cd2d035d1655780c994f6488b1080a1a962c1b17fa"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "06ee89c7191f9aeac16412b81a215643",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.6",
"size": 23244293,
"upload_time": "2023-12-26T04:26:09",
"upload_time_iso_8601": "2023-12-26T04:26:09.795863Z",
"url": "https://files.pythonhosted.org/packages/a2/b5/e1db85ee114f8ba8750e5b8b8582a165b33aab45f56a5cbacfbc3e1ecb46/cumm_cu117-0.5.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5aee04bf2f6f8c252933a8f533b1b3bbfad8b3aa89a595347c91af745b4bc932",
"md5": "33cf356c605813fc7a25608d55df7b08",
"sha256": "e03ce9391d74e19ee5f80eb508a8c8f4522b6860d057768b3fe8dbf8ced519f8"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "33cf356c605813fc7a25608d55df7b08",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.6",
"size": 1160627,
"upload_time": "2023-12-26T04:03:31",
"upload_time_iso_8601": "2023-12-26T04:03:31.367212Z",
"url": "https://files.pythonhosted.org/packages/5a/ee/04bf2f6f8c252933a8f533b1b3bbfad8b3aa89a595347c91af745b4bc932/cumm_cu117-0.5.1-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "716ef23327d46ed226cc4442f9b3cabb8d1bde9af725c3958c816b5ce7663f27",
"md5": "096ac1f20dbc7bc06d75799362776a02",
"sha256": "71167fa5731db5e76d7edd0b9d30615632e5b413cb0bef0c72604017f9281fe3"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "096ac1f20dbc7bc06d75799362776a02",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.6",
"size": 23243817,
"upload_time": "2023-12-26T04:26:13",
"upload_time_iso_8601": "2023-12-26T04:26:13.769040Z",
"url": "https://files.pythonhosted.org/packages/71/6e/f23327d46ed226cc4442f9b3cabb8d1bde9af725c3958c816b5ce7663f27/cumm_cu117-0.5.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "271067ba747143cd8eabec1b02666d010367964637f260711c77aed1c4c86d95",
"md5": "b36e0fe1081ce4701d958d999dddc1cc",
"sha256": "b5523d33d7087a64519300990e0f9cd025f74f1eba32b32c52c909e1bdfd5a7d"
},
"downloads": -1,
"filename": "cumm_cu117-0.5.1-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "b36e0fe1081ce4701d958d999dddc1cc",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.6",
"size": 1160994,
"upload_time": "2023-12-26T04:06:26",
"upload_time_iso_8601": "2023-12-26T04:06:26.248324Z",
"url": "https://files.pythonhosted.org/packages/27/10/67ba747143cd8eabec1b02666d010367964637f260711c77aed1c4c86d95/cumm_cu117-0.5.1-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-26 04:25:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FindDefinition",
"github_project": "cumm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cumm-cu117"
}
JSON
