Skip to content

Commit

Permalink
a pretty readme so that people trust us
Browse files Browse the repository at this point in the history
  • Loading branch information
geohot committed Nov 26, 2023
1 parent 28cd498 commit be70173
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
- name: Install gpuctypes
run: pip install .
- name: Test gpuctypes import
run: python3 -c "import gpuctypes.${{ matrix.task }}"
run: python3 -c "import gpuctypes.${{ matrix.task }} as ${{ matrix.task }}"
- uses: actions/upload-artifact@v3
with:
name: Generated ${{ matrix.task }} Header
Expand Down
17 changes: 0 additions & 17 deletions README

This file was deleted.

25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## gpuctypes (a low level GPU library for Python)

Do you wish that there were simple wrappers for GPU libraries in Python? Like not pyopencl, pycuda, and (HIP library someday?) here, but just raw access to the APIs?

That's what gpuctypes does! While high level libraries have their place, the world needs more low level libraries. Like gpuctypes. Welcome home.

### Installation

```sh
pip install gpuctypes
```

### Usage

```py
import gpuctypes.hip as hip
import gpuctypes.cuda as cuda
import gpuctypes.opencl as opencl
```

### Current versions

* ROCm 5.7.1
* CUDA 11.5
* OpenCL whatever is in Ubuntu 22.04

0 comments on commit be70173

Please sign in to comment.