# 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-cu114",
"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": "649a6f050ac0d74e7aa733979dfb8462ae92adcdebdf0ba7da453a6e69c47db0",
"md5": "a6d95ab523726ca55b17445e65bcace1",
"sha256": "945b5a2169f1ddb1be4b47aa08789b3f0efb72ab47ac8e5bdb29db70a148a8b6"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "a6d95ab523726ca55b17445e65bcace1",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.6",
"size": 22789152,
"upload_time": "2023-12-26T04:26:07",
"upload_time_iso_8601": "2023-12-26T04:26:07.684877Z",
"url": "https://files.pythonhosted.org/packages/64/9a/6f050ac0d74e7aa733979dfb8462ae92adcdebdf0ba7da453a6e69c47db0/cumm_cu114-0.5.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b889172799e64515c20ce694c66e9d3cc7efd1433dd3c9b96d31d3a4403ada6b",
"md5": "ceb73e77adf5a3e238db546a3a1688db",
"sha256": "0f9ae2804ec3149e6182414f50572233050c7e346ebe18db69d8cb742252dc4e"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "ceb73e77adf5a3e238db546a3a1688db",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.6",
"size": 1160862,
"upload_time": "2023-12-26T04:01:33",
"upload_time_iso_8601": "2023-12-26T04:01:33.004726Z",
"url": "https://files.pythonhosted.org/packages/b8/89/172799e64515c20ce694c66e9d3cc7efd1433dd3c9b96d31d3a4403ada6b/cumm_cu114-0.5.1-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c55354b7c864c831ec192918869c693c9be0dcdf61469a357f6ac92fb0d33a9d",
"md5": "812a33f9cd4ab757f5186de33b46e3dc",
"sha256": "6655887b07fa5dff7f6e0b4a1d9e3701a0320185f0345e593aaacad691dfd524"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "812a33f9cd4ab757f5186de33b46e3dc",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.6",
"size": 22791803,
"upload_time": "2023-12-26T04:26:18",
"upload_time_iso_8601": "2023-12-26T04:26:18.457334Z",
"url": "https://files.pythonhosted.org/packages/c5/53/54b7c864c831ec192918869c693c9be0dcdf61469a357f6ac92fb0d33a9d/cumm_cu114-0.5.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ffb588d93a77c1b80de7cb37bb0344d6a0d0c7ca73e9583440914fcf0372258c",
"md5": "87ca0c0b82fb81b8e8ae31f4d4f4ba63",
"sha256": "81d911f259e43fed29e8d22be7f00d737e21aea40bcbcc75b855f3717ee66a6f"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "87ca0c0b82fb81b8e8ae31f4d4f4ba63",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.6",
"size": 1162253,
"upload_time": "2023-12-26T04:02:00",
"upload_time_iso_8601": "2023-12-26T04:02:00.916992Z",
"url": "https://files.pythonhosted.org/packages/ff/b5/88d93a77c1b80de7cb37bb0344d6a0d0c7ca73e9583440914fcf0372258c/cumm_cu114-0.5.1-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f30b44d7806157738044134a17569ca54976f4aa323984c006ae66069e11e9f8",
"md5": "a7780d67dfc5ae1581d4d11866857e38",
"sha256": "c74e41c1acfa4cdfb6ee0839180995ecb29a5e75d65ebde096f34377473d0f55"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "a7780d67dfc5ae1581d4d11866857e38",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.6",
"size": 1160899,
"upload_time": "2023-12-26T04:02:18",
"upload_time_iso_8601": "2023-12-26T04:02:18.013212Z",
"url": "https://files.pythonhosted.org/packages/f3/0b/44d7806157738044134a17569ca54976f4aa323984c006ae66069e11e9f8/cumm_cu114-0.5.1-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a19d64296fe3e0f0060fab832ef5ddb03a47a9d82a6073998420dd44e03a2d58",
"md5": "746a4c81b8d9edf5b0153e01f0417a53",
"sha256": "e5717811c3701673ece0a8c275665143eab9aae3c65be22405ac1b864fd4272a"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "746a4c81b8d9edf5b0153e01f0417a53",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.6",
"size": 22780526,
"upload_time": "2023-12-26T04:26:34",
"upload_time_iso_8601": "2023-12-26T04:26:34.604780Z",
"url": "https://files.pythonhosted.org/packages/a1/9d/64296fe3e0f0060fab832ef5ddb03a47a9d82a6073998420dd44e03a2d58/cumm_cu114-0.5.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d16e7226143c11695de6ee8447714bad3edef7fd3fa525a73f462794a14bda3b",
"md5": "c53e697ef04e1eec4e45231583a5a708",
"sha256": "5cf823cd8da2e9ea94d7a1121e6965d20f23301603e4c7107333fbc447808b70"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "c53e697ef04e1eec4e45231583a5a708",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.6",
"size": 22787954,
"upload_time": "2023-12-26T04:26:40",
"upload_time_iso_8601": "2023-12-26T04:26:40.140404Z",
"url": "https://files.pythonhosted.org/packages/d1/6e/7226143c11695de6ee8447714bad3edef7fd3fa525a73f462794a14bda3b/cumm_cu114-0.5.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c65859b8fb90a2f34afb5235e8847c4be55d7dce56e1d86f609cc61b6ea25cb1",
"md5": "dafd03b516a10d04f3c27735ebb81e3b",
"sha256": "622197c10e896968792a88d82d3872656561e2027434ce634f00790e0fa94281"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "dafd03b516a10d04f3c27735ebb81e3b",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.6",
"size": 1160645,
"upload_time": "2023-12-26T04:02:31",
"upload_time_iso_8601": "2023-12-26T04:02:31.018643Z",
"url": "https://files.pythonhosted.org/packages/c6/58/59b8fb90a2f34afb5235e8847c4be55d7dce56e1d86f609cc61b6ea25cb1/cumm_cu114-0.5.1-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0317f402d58198585ef7facb130d0d295182fe77e2346781e9d4b0fc1a2cd27e",
"md5": "69ada65b4f076c555d81b9bad70acac3",
"sha256": "735a0e30da9ce29e17de4e7d3c0a945cf6ccb903a76125042159ef41ce86ebd3"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "69ada65b4f076c555d81b9bad70acac3",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.6",
"size": 22787544,
"upload_time": "2023-12-26T04:26:46",
"upload_time_iso_8601": "2023-12-26T04:26:46.560103Z",
"url": "https://files.pythonhosted.org/packages/03/17/f402d58198585ef7facb130d0d295182fe77e2346781e9d4b0fc1a2cd27e/cumm_cu114-0.5.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69dc433bd5b5a088f7bed5520c730b131da72b028181a24f503b8e5044a2f344",
"md5": "d6c982d8d1f7e6553035e932056c4af6",
"sha256": "ef97eba89feb264502260f5b9fa756b7a206249d3b8990787ef4b9163aa4ae82"
},
"downloads": -1,
"filename": "cumm_cu114-0.5.1-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "d6c982d8d1f7e6553035e932056c4af6",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.6",
"size": 1160983,
"upload_time": "2023-12-26T04:02:38",
"upload_time_iso_8601": "2023-12-26T04:02:38.443934Z",
"url": "https://files.pythonhosted.org/packages/69/dc/433bd5b5a088f7bed5520c730b131da72b028181a24f503b8e5044a2f344/cumm_cu114-0.5.1-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-26 04:26:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FindDefinition",
"github_project": "cumm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cumm-cu114"
}
JSON
