diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-metalcompute.spec | 498 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 500 insertions, 0 deletions
@@ -0,0 +1 @@ +/metalcompute-0.2.4.tar.gz diff --git a/python-metalcompute.spec b/python-metalcompute.spec new file mode 100644 index 0000000..62516a3 --- /dev/null +++ b/python-metalcompute.spec @@ -0,0 +1,498 @@ +%global _empty_manifest_terminate_build 0 +Name: python-metalcompute +Version: 0.2.4 +Release: 1 +Summary: A python library to run metal compute kernels on macOS +License: MIT License +URL: https://github.com/baldand/py-metal-compute +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/84/af/5412f208b516cf3dc718abf583b6cb88b3bd35d0ac9c5e2c1c7e1160454f/metalcompute-0.2.4.tar.gz +BuildArch: noarch + + +%description +# metalcompute for Python + + + +A python library to run metal compute kernels on macOS >= 11 + +## Installations + +Install latest stable release from PyPI: + +``` +> python3 -m pip install metalcompute +``` + +Install latest unstable version from Github: + +``` +> python3 -m pip install git+https://github.com/baldand/py-metal-compute.git +``` + +Install locally from source: + +``` +> python3 -m pip install . +``` + +## Basic test + +Example execution from M1-based Mac running macOS 12: + +``` +> python3 tests/basic.py +Calculating sin of 1234567 values +Expected value: 0.9805107116699219 Received value: 0.9807852506637573 +Metal compute took: 0.0040209293365478516 s +Reference compute took: 0.1068720817565918 s +``` + +## Interface + +``` +import metalcompute as mc + +devices = mc.get_devices() +# Get list of available Metal devices + +dev = mc.Device() +# Call before use. Will open default Metal device +# or to pick a specific device: +# mc.Device(device_index) + +program = """ +#include <metal_stdlib> +using namespace metal; + +kernel void test(const device float *in [[ buffer(0) ]], + device float *out [[ buffer(1) ]], + uint id [[ thread_position_in_grid ]]) { + out[id] = sin(in[id]); +} +""" +function_name = "test" + +kernel_fn = dev.kernel(program).function(function_name) +# Will raise exception with details if metal kernel has errors + +buf_0 = array('f',[1.0,3.14159]) # Any python buffer object +buf_n = dev.buffer(out_size) +# Allocate metal buffers for input and output (must be compatible with kernel) +# Input buffers can be dev.buffer or python buffers (will be copied) +# Output buffers must be dev.buffer +# Buffer objects support python buffer protocol +# Can be modified or read using e.g. memoryview, numpy.frombuffer + +kernel_fn(kernel_call_count, buf_0, ..., buf_n) +# Run the kernel once with supplied input data, +# filling supplied output data +# Specify number of kernel calls +# Will block until data available + +handle = kernel_fn(kernel_call_count, buf_0, ..., buf_n) +# Run the kernel once, +# Specify number of kernel calls +# Supply all needed buffers +# Will return immediately, before kernel runs, +# allowing additional kernels to be queued +# Do not modify or read buffers until kernel completed! + +del handle +# Block until previously queued kernel has completed + +``` + +## Examples + +### Measure TFLOPS of GPU + +``` +> metalcompute-measure +Using device: Apple M1 (unified memory=True) +Running compute intensive Metal kernel to measure TFLOPS... +Estimated GPU TFLOPS: 2.53236 +Running compute intensive Metal kernel to measure data transfer rate... +Data transfer rate: 58.7291 GB/s +``` + +### Render a 3D image with raymarching + +``` +# Usage: metalcompute-raymarch [-width <width>] [-height <height>] [-outname <output image file: PNG, JPG>] + +> metalcompute-raymarch.py -width 1024 -height 1024 -outname raymarch.jpg +Render took 0.0119569s +``` + + + +### Mandelbrot set + +``` +# Usage: metalcompute-mandelbrot [-width <width>] [-height <height>] [-outname <output image file: PNG, JPG>] + +> metalcompute-mandelbrot +Rendering mandelbrot set using Metal compute, res:4096x4096, iters:8192 +Render took 0.401446s +Writing image to mandelbrot.png +Image encoding took 1.35182s +``` + + + +### Livecoding visual kernels in VSCode + +There is an example script to allow livecoding of visual metal kernels entirely within VSCode using a localhost http server to render frames. + +It also includes syntax error highlighting in the editor. + +See [livemetal.py](examples/livecode) + +## Status + +This is a preview version. + + +%package -n python3-metalcompute +Summary: A python library to run metal compute kernels on macOS +Provides: python-metalcompute +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-metalcompute +# metalcompute for Python + + + +A python library to run metal compute kernels on macOS >= 11 + +## Installations + +Install latest stable release from PyPI: + +``` +> python3 -m pip install metalcompute +``` + +Install latest unstable version from Github: + +``` +> python3 -m pip install git+https://github.com/baldand/py-metal-compute.git +``` + +Install locally from source: + +``` +> python3 -m pip install . +``` + +## Basic test + +Example execution from M1-based Mac running macOS 12: + +``` +> python3 tests/basic.py +Calculating sin of 1234567 values +Expected value: 0.9805107116699219 Received value: 0.9807852506637573 +Metal compute took: 0.0040209293365478516 s +Reference compute took: 0.1068720817565918 s +``` + +## Interface + +``` +import metalcompute as mc + +devices = mc.get_devices() +# Get list of available Metal devices + +dev = mc.Device() +# Call before use. Will open default Metal device +# or to pick a specific device: +# mc.Device(device_index) + +program = """ +#include <metal_stdlib> +using namespace metal; + +kernel void test(const device float *in [[ buffer(0) ]], + device float *out [[ buffer(1) ]], + uint id [[ thread_position_in_grid ]]) { + out[id] = sin(in[id]); +} +""" +function_name = "test" + +kernel_fn = dev.kernel(program).function(function_name) +# Will raise exception with details if metal kernel has errors + +buf_0 = array('f',[1.0,3.14159]) # Any python buffer object +buf_n = dev.buffer(out_size) +# Allocate metal buffers for input and output (must be compatible with kernel) +# Input buffers can be dev.buffer or python buffers (will be copied) +# Output buffers must be dev.buffer +# Buffer objects support python buffer protocol +# Can be modified or read using e.g. memoryview, numpy.frombuffer + +kernel_fn(kernel_call_count, buf_0, ..., buf_n) +# Run the kernel once with supplied input data, +# filling supplied output data +# Specify number of kernel calls +# Will block until data available + +handle = kernel_fn(kernel_call_count, buf_0, ..., buf_n) +# Run the kernel once, +# Specify number of kernel calls +# Supply all needed buffers +# Will return immediately, before kernel runs, +# allowing additional kernels to be queued +# Do not modify or read buffers until kernel completed! + +del handle +# Block until previously queued kernel has completed + +``` + +## Examples + +### Measure TFLOPS of GPU + +``` +> metalcompute-measure +Using device: Apple M1 (unified memory=True) +Running compute intensive Metal kernel to measure TFLOPS... +Estimated GPU TFLOPS: 2.53236 +Running compute intensive Metal kernel to measure data transfer rate... +Data transfer rate: 58.7291 GB/s +``` + +### Render a 3D image with raymarching + +``` +# Usage: metalcompute-raymarch [-width <width>] [-height <height>] [-outname <output image file: PNG, JPG>] + +> metalcompute-raymarch.py -width 1024 -height 1024 -outname raymarch.jpg +Render took 0.0119569s +``` + + + +### Mandelbrot set + +``` +# Usage: metalcompute-mandelbrot [-width <width>] [-height <height>] [-outname <output image file: PNG, JPG>] + +> metalcompute-mandelbrot +Rendering mandelbrot set using Metal compute, res:4096x4096, iters:8192 +Render took 0.401446s +Writing image to mandelbrot.png +Image encoding took 1.35182s +``` + + + +### Livecoding visual kernels in VSCode + +There is an example script to allow livecoding of visual metal kernels entirely within VSCode using a localhost http server to render frames. + +It also includes syntax error highlighting in the editor. + +See [livemetal.py](examples/livecode) + +## Status + +This is a preview version. + + +%package help +Summary: Development documents and examples for metalcompute +Provides: python3-metalcompute-doc +%description help +# metalcompute for Python + + + +A python library to run metal compute kernels on macOS >= 11 + +## Installations + +Install latest stable release from PyPI: + +``` +> python3 -m pip install metalcompute +``` + +Install latest unstable version from Github: + +``` +> python3 -m pip install git+https://github.com/baldand/py-metal-compute.git +``` + +Install locally from source: + +``` +> python3 -m pip install . +``` + +## Basic test + +Example execution from M1-based Mac running macOS 12: + +``` +> python3 tests/basic.py +Calculating sin of 1234567 values +Expected value: 0.9805107116699219 Received value: 0.9807852506637573 +Metal compute took: 0.0040209293365478516 s +Reference compute took: 0.1068720817565918 s +``` + +## Interface + +``` +import metalcompute as mc + +devices = mc.get_devices() +# Get list of available Metal devices + +dev = mc.Device() +# Call before use. Will open default Metal device +# or to pick a specific device: +# mc.Device(device_index) + +program = """ +#include <metal_stdlib> +using namespace metal; + +kernel void test(const device float *in [[ buffer(0) ]], + device float *out [[ buffer(1) ]], + uint id [[ thread_position_in_grid ]]) { + out[id] = sin(in[id]); +} +""" +function_name = "test" + +kernel_fn = dev.kernel(program).function(function_name) +# Will raise exception with details if metal kernel has errors + +buf_0 = array('f',[1.0,3.14159]) # Any python buffer object +buf_n = dev.buffer(out_size) +# Allocate metal buffers for input and output (must be compatible with kernel) +# Input buffers can be dev.buffer or python buffers (will be copied) +# Output buffers must be dev.buffer +# Buffer objects support python buffer protocol +# Can be modified or read using e.g. memoryview, numpy.frombuffer + +kernel_fn(kernel_call_count, buf_0, ..., buf_n) +# Run the kernel once with supplied input data, +# filling supplied output data +# Specify number of kernel calls +# Will block until data available + +handle = kernel_fn(kernel_call_count, buf_0, ..., buf_n) +# Run the kernel once, +# Specify number of kernel calls +# Supply all needed buffers +# Will return immediately, before kernel runs, +# allowing additional kernels to be queued +# Do not modify or read buffers until kernel completed! + +del handle +# Block until previously queued kernel has completed + +``` + +## Examples + +### Measure TFLOPS of GPU + +``` +> metalcompute-measure +Using device: Apple M1 (unified memory=True) +Running compute intensive Metal kernel to measure TFLOPS... +Estimated GPU TFLOPS: 2.53236 +Running compute intensive Metal kernel to measure data transfer rate... +Data transfer rate: 58.7291 GB/s +``` + +### Render a 3D image with raymarching + +``` +# Usage: metalcompute-raymarch [-width <width>] [-height <height>] [-outname <output image file: PNG, JPG>] + +> metalcompute-raymarch.py -width 1024 -height 1024 -outname raymarch.jpg +Render took 0.0119569s +``` + + + +### Mandelbrot set + +``` +# Usage: metalcompute-mandelbrot [-width <width>] [-height <height>] [-outname <output image file: PNG, JPG>] + +> metalcompute-mandelbrot +Rendering mandelbrot set using Metal compute, res:4096x4096, iters:8192 +Render took 0.401446s +Writing image to mandelbrot.png +Image encoding took 1.35182s +``` + + + +### Livecoding visual kernels in VSCode + +There is an example script to allow livecoding of visual metal kernels entirely within VSCode using a localhost http server to render frames. + +It also includes syntax error highlighting in the editor. + +See [livemetal.py](examples/livecode) + +## Status + +This is a preview version. + + +%prep +%autosetup -n metalcompute-0.2.4 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-metalcompute -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.4-1 +- Package Spec generated @@ -0,0 +1 @@ +b5fb717d493149a958a19691c1916990 metalcompute-0.2.4.tar.gz |