From 6edb5af6365a6491d59bc9b2de4f95d42abd4165 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Fri, 28 Oct 2011 12:05:35 -0400
Subject: [PATCH] Document pyopencl.characterize.
---
doc/source/tools.rst | 5 +++++
pyopencl/characterize.py | 9 +++++++++
2 files changed, 14 insertions(+)
diff --git a/doc/source/tools.rst b/doc/source/tools.rst
index 845d9cea..d69a3134 100644
--- a/doc/source/tools.rst
+++ b/doc/source/tools.rst
@@ -100,3 +100,8 @@ Testing
PYOPENCL_TEST_PLATFORM_BLACKLIST=nvidia,intel
PYOPENCL_TEST_DEVICE_BLACKLIST=nvidia:260,intel:i5
+
+Device Characterization
+-----------------------
+
+.. automodule:: pyopencl.characterize
diff --git a/pyopencl/characterize.py b/pyopencl/characterize.py
index 9a3d233a..d3f0344c 100644
--- a/pyopencl/characterize.py
+++ b/pyopencl/characterize.py
@@ -48,6 +48,10 @@ def reasonable_work_group_size_multiple(dev, ctx=None):
def nv_compute_capability(dev):
+ """If *dev* is an Nvidia GPU :class:`pyopencl.Device`, return a tuple
+ *(major, minor)* indicating the device's compute capability.
+ """
+
try:
return (dev.compute_capability_major_nv,
dev.compute_capability_minor_nv)
@@ -61,6 +65,7 @@ def usable_local_mem_size(dev, nargs=None):
"""Return an estimate of the usable local memory size.
:arg nargs: Number of 32-bit arguments passed.
"""
+
usable_local_mem_size = dev.local_mem_size
nv_compute_cap = nv_compute_capability(dev)
@@ -165,6 +170,10 @@ def why_not_local_access_conflict_free(dev, itemsize,
:param itemsize: size of accessed data in bytes
:param array_shape: array dimensions, fastest-moving last
(C order)
+
+ :returns: a tuple (multiplicity, explanation), where *multiplicity*
+ is the number of work items that will conflict on a bank when accessing
+ local memory. *explanation* is a string detailing the found conflict.
"""
# FIXME: Treat 64-bit access on NV CC 2.x + correctly
--
GitLab